Update the organization
Change the organization's name, default language, time zone or settings. Settings merge: an omitted setting stays and null returns it to its default; notifications.recipients is replaced as a whole. Fails with TIME_ZONE_UNKNOWN when the time zone is not a valid IANA zone (for example America/Bogota).
- Scope:
raiz:organization:write - Credentials: an API key, a client-credentials token or a person's access token
- Effect: writes; idempotent, safe to retry
- Limits: request body up to 32 KB, response up to 1 MB
- CLI:
arbol raiz organization update· MCP tool:raiz_organization_update
https://api.getarbol.com/v1/raiz/organizationAuthorization
- Authorizationstringrequired
Bearer <token>, where the token is an API key, a client-credentials token or a person's access token with the scoperaiz:organization:write. Get an API key.
Request body JSON required
- settingsoptionalobject
Settings to change. An omitted setting stays as it is;
nullreturns it to its default.- notificationsoptionalobject
- frequencyoptionalimmediateorhourlyorevery3Hoursorevery6Hoursorevery12Hoursornull
How often the notices reach the team (default
immediate).immediatesends each notice as it happens, one email per conversation; a failure that repeats is notified once when its cause first appears, and the conversations the same cause touches in the next hour go out together an hour later, one follow-up an hour while it lasts.hourly,every3Hours,every6Hoursandevery12Hourssend one digest at the end of each window of that length, counted from local midnight in the organization's time zone (every six hours: 00:00, 06:00, 12:00 and 18:00), listing the conversations that still need the team; the escalation's WhatsApp message follows the same schedule. A window without notices sends nothing. - phonesoptionalarray | null
Who also receives the escalation notice by WhatsApp, at most 10 numbers in E.164 (default none). The message names the Agent, the organization and why the conversation was handed over, with a link to it; never the contact, the summary or the transcript. The other notices go by email only.
- recipientsoptionalarray | null
Additional recipients for team notices alongside eligible workspace owners, at most 10 addresses (default none). An email carries the conversation's link, channel, times, Agent and state, its title and summary and the analysis' evaluations; never the transcript or the captured data. A summary may name the person: choose recipients who may read the organization's conversations.
Returns
200
Successful operation.
- dataobjectrequired
- settingsobjectrequired
- dailyReportobjectrequired
- recipientsarray ofstringrequired
Additional recipients for the daily report alongside eligible workspace owners, at most 10 addresses (default none). It lists the contacts of calls and conversations by name and number: choose recipients who may read the organization's conversations.
format: email · maxLength: 254
- notificationsobjectrequired
- frequencyimmediateorhourlyorevery3Hoursorevery6Hoursorevery12Hoursrequired
How often the notices reach the team (default
immediate).immediatesends each notice as it happens, one email per conversation; a failure that repeats is notified once when its cause first appears, and the conversations the same cause touches in the next hour go out together an hour later, one follow-up an hour while it lasts.hourly,every3Hours,every6Hoursandevery12Hourssend one digest at the end of each window of that length, counted from local midnight in the organization's time zone (every six hours: 00:00, 06:00, 12:00 and 18:00), listing the conversations that still need the team; the escalation's WhatsApp message follows the same schedule. A window without notices sends nothing. - phonesarray ofstringrequired
Who also receives the escalation notice by WhatsApp, at most 10 numbers in E.164 (default none). The message names the Agent, the organization and why the conversation was handed over, with a link to it; never the contact, the summary or the transcript. The other notices go by email only.
pattern: ^\+[1-9][0-9]{7,14}$ - recipientsarray ofstringrequired
Additional recipients for team notices alongside eligible workspace owners, at most 10 addresses (default none). An email carries the conversation's link, channel, times, Agent and state, its title and summary and the analysis' evaluations; never the transcript or the captured data. A summary may name the person: choose recipients who may read the organization's conversations.
format: email · maxLength: 254
400
INVALID_INPUT: The request does not match the published schema.
- errorrequired}
One of the following:
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
401
UNAUTHORIZED: A valid access token is required.
- errorrequired}
One of the following:
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
403
FORBIDDEN: The token does not authorize this operation.
- errorrequired}
One of the following:
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
404
NOT_FOUND: The requested operation does not exist.RESOURCE_NOT_FOUND: The requested resource does not exist in this organization.
- errorrequired}
One of the following:
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
405
HTTP_METHOD_NOT_ALLOWED: The HTTP method is not supported for this resource.
- errorrequired}
One of the following:
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
413
REQUEST_TOO_LARGE: The request exceeds the allowed size.
- errorrequired}
One of the following:
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
415
UNSUPPORTED_MEDIA_TYPE: The request content type is not supported.
- errorrequired}
One of the following:
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
422
TIME_ZONE_UNKNOWN: The time zone is not in the IANA time zone database.
- errorrequired}
One of the following:
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
429
RATE_LIMITED: The request rate limit was exceeded. Try again later.
- errorrequired}
One of the following:
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
500
INTERNAL_ERROR: The service could not complete the operation.
- errorrequired}
One of the following:
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
502
OUTCOME_UNKNOWN: The operation may have been applied; check its result before repeating it.
- errorrequired}
One of the following:
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
503
UPSTREAM_UNAVAILABLE: The upstream service could not complete the request.INTEGRATIONS_UNAVAILABLE: The organization's integrations cannot be read right now. Try again shortly.
- errorrequired}
One of the following:
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
504
UPSTREAM_TIMEOUT: The upstream service did not respond before its deadline.
- errorrequired}
One of the following:
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object
- object