Update Account

Updates an account's information.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
idstringRequiredformat: "id"
The ID of account to update.
artifactsobjectOptional
custom_fieldsobjectOptional

Application-defined custom fields.

custom_schema_specobjectOptional

Custom schemas described using identifiers. Each custom field in the request must have the corresponding schema specified; omission results in a Bad Request error. If a custom schema is not included in the specifier, it remains unchanged. For surfaces with human interactors, it is recommended to provide tenant_fragment: true and validate_required_fields: true.

descriptionstringOptionalformat: "text"
Updated description of the account.
display_namestringOptionalformat: "text"
Updated display name for the account.
domainslist of stringsOptional

Updated list of company’s domain names. Example - [‘devrev.ai’].

external_refslist of stringsOptional
Updated External Refs of account.
owned_bylist of stringsOptional
Updated list of the users owning this account.
tagslist of objectsOptional
Updated tags list associated with the account.
tierstringOptionalformat: "text"
Updated tier of the account.
websitesobjectOptional
schema_fragment_idslist of stringsOptionalDeprecated
Schema fragment IDs associated with this account SOR.

Response

Updated account object.
accountobject

Errors