Agendize Organization API

Organization settings API Reference

Resource representation

{ "name": {string}, "emailAddress": {string}, "colors": { "header": {string}, "menu": {string} }, "logo": { "url": {string}, "mimeType": {string}, "data": {string} }, "favicon": { "url": {string}, "mimeType": {string}, "data": {string} }, "canChangeLogo": {boolean}, "canChangeFavicon": {boolean} }

Parameter name	Value	Description
`name`	String	Name of the organization.	writable
`emailAddress`	string	Email address of the organization. Used as sender email.	writable
`colors`	object	Dashboard color scheme.
`colors.header`	string	Background header color.	writable.
`colors.menu`	string	Background menu color.	writable.
`logo`	`object`	Organization logo url and mime type.
`logo.url`	`string`	Url of the organization logo.
`logo.mimeType`	`string`	Mime type of the organization logo file.
`logo.data`	`string`	URI encoding image data.	write-only.
`favicon`	`object`	Organization favicon url and mime type.
`favicon.url`	`string`	Url of the organization favicon.
`favicon.mimeType`	`string`	Mime type of the organization favicon file.
`favicon.data`	`string`	URI encoding image data.	write-only.
`canChangeLogo`	`boolean`	If the user can change the organization logo.	read-only.
`canChangeFavicon`	`boolean`	If the user can change the organization favicon.	read-only.

Get

Return organization settings

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.3/organization/settings

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a Settings resource in the response body.

Update

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

PUT https://api.agendize.com/api/2.3/organization/settings

Request body

In the request body, supply a Settings resource with the following properties:

Parameter name	Value	Description
Optional Properties
`name`	String	Name of the organization.	writable
`emailAddress`	string	Email address of the organization. Used as sender email.	writable
`colors`	object	Dashboard color scheme.
`colors.header`	string	Background header color.	writable.
`colors.menu`	string	Background menu color.	writable.
`logo`	`object`	Organization logo url and mime type.
`logo.data`	`string`	URI encoding image data.	write-only.
`favicon`	`object`	Organization favicon url and mime type.
`favicon.data`	`string`	URI encoding image data.	write-only.

Response

If successful, this method returns a Settings resource in the response body.

Agendize Developers API

Organization settings API Reference

Resource representation

Get

Request

HTTP Request

Request body

Response

Update

Request

HTTP Request

Request body

Response