Update handoff
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.
version
Document version. On update, send back the num from your last read.
category_settings
Handoff categories. Handoff items are grouped into categories by display key.
item_settings
Handoff items: the individual handoff options shown to users.
Response
The updated handoff, at its new version
category_settings
Handoff categories. Handoff items are grouped into categories by display key.
item_settings
Handoff items: the individual handoff options shown to users.
updated_time
When the configuration was last updated.
updated_by
Who last updated the configuration.
version
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