Skip to navigation

Update assistant account

View as Markdown

Changes the fields you send and returns the full updated document.

Send only the fields you want to change, plus version with the num from your last read and a change_description. This is a JSON merge-patch: a field you leave out keeps its stored value, and every list or map you send replaces the stored one whole.

Authentication

AuthorizationBearer

JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.

Request

This endpoint expects an object.
versionobjectRequired
Document version. On update, send back the num from your last read.
email_addrstringOptional
Email address of the bot service account in your primary identity system.
record_idstringOptional>=1 character
Value that identifies the bot account across your systems, typically its email address. Must match your organization's joining key.
full_namestringOptional
Full name of the bot service account.
itsm_id_infolist of objectsOptional

Identities of the bot account in each connected ITSM system. Each entry enables built-in ticketing for that system.

Response

The updated assistant account, at its new version
email_addrstringOptional
Email address of the bot service account in your primary identity system.
record_idstringOptional>=1 character
Value that identifies the bot account across your systems, typically its email address. Must match your organization's joining key.
full_namestringOptional
Full name of the bot service account.
itsm_id_infolist of objectsOptional

Identities of the bot account in each connected ITSM system. Each entry enables built-in ticketing for that system.

updated_timedatetimeOptionalRead-only
When the configuration was last updated.
updated_bystringOptionalRead-only
Who last updated the configuration.
versionobjectOptional
Document version. On update, send back the num from your last read.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error