OrganizationApi
All URIs are relative to http://localhost
| Method | HTTP request | Description |
|---|---|---|
| getBranding | GET /organizations/{id}/branding | Load organization branding paramters |
| setBranding | PUT /organizations/{id}/branding | Set organization branding parameters |
getBranding#
/*** @returns OrganizationBranding**/async function getBranding(id: String)Load organization branding paramters
Example#
const yat = require('yatjs');const api = new yat.YatJs();
let id = "id_example"; // String // populate id...
try { let res = await api.organization().getBranding(id); // res is of type OrganizationBranding console.log('API called successfully. Result: ', res);} catch (error) { console.error(error);}
Parameters#
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String |
Return type#
Authorization#
No authorization required
HTTP request headers#
- Content-Type: Not defined
- Accept: /
setBranding#
/*** @returns OrganizationBranding**/async function setBranding(id: String, body: UpdateOrganizationBranding)Set organization branding parameters
Notes:#
NOTE: user should have scope OrganizationWrite
Example#
const yat = require('yatjs');const api = new yat.YatJs();
await api.login("[email protected]", "your_password");
let id = "id_example"; // String // populate id...
let body = new YatJs.UpdateOrganizationBranding(); // UpdateOrganizationBranding // populate body...
try { let res = await api.organization().setBranding(id, body); // res is of type OrganizationBranding console.log('API called successfully. Result: ', res);} catch (error) { console.error(error);}
Parameters#
| Name | Type | Description | Notes |
|---|---|---|---|
| id | String | ||
| body | UpdateOrganizationBranding | ||
Return type#
Authorization#
HTTP request headers#
- Content-Type: Not defined
- Accept: /