Tenant Configurations

TenantPreferenceRead

post

This API is used to get data that is saved as tenant preference for an organisation

  • The endpoint for Update Consent is /org/v2/preferences/read
  • The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
tsstringOptional

Timestamp at which given API request is sent.

X-msgidstringOptional

This ID uniquely identifies a request if the same API is executed multiple times.

AuthorizationstringRequired

To make use of this API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.

x-authenticated-user-tokenstringRequired

It is a unique token/key to authenticate the user each time an API is called. For corresponding sessions this token is used, not your actual username/password

x-authenticated-forstringOptional

Managed User token of registered MUA user performing given API request.

Body
Responses
200Success
application/json
post
/org/v2/preferences/read

TenantPreferenceCreate

post

This API is used to save data as per the tenant preference for an organisation

  • The endpoint for Update Consent is /org/v2/preferences/create
  • The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
tsstringOptional

Timestamp at which given API request is sent.

X-msgidstringOptional

This ID uniquely identifies a request if the same API is executed multiple times.

AuthorizationstringRequired

To make use of this API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.

x-authenticated-user-tokenstringRequired

It is a unique token/key to authenticate the user each time an API is called. For corresponding sessions this token is used, not your actual username/password

x-authenticated-forstringOptional

Managed User token of registered MUA user performing given API request.

Body
Responses
200Success
application/json
post
/org/v2/preferences/create

TenantPreferenceUpdate

patch

This API is used to update data as per the tenant preference for an organisation

  • The endpoint for Update Consent is /org/v2/preferences/update
  • The fields marked with an asterisk (*) are mandatory. They cannot be null or empty.
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
tsstringOptional

Timestamp at which given API request is sent.

X-msgidstringOptional

This ID uniquely identifies a request if the same API is executed multiple times.

AuthorizationstringRequired

To make use of this API, you require authorization. Raise a request to the administrator for the use of the API. You will receive the authorization key. Specify the key received, here.

x-authenticated-user-tokenstringRequired

It is a unique token/key to authenticate the user each time an API is called. For corresponding sessions this token is used, not your actual username/password

x-authenticated-forstringOptional

Managed User token of registered MUA user performing given API request.

Body
Responses
200Success
application/json
patch
/org/v2/preferences/update

Last updated

Was this helpful?