Credentials Transition

Create a transition to 'acknowledged' of the installation's credentials resource

📘

Supported Regions and Base URLs

Scope

apps:write

Request Body

{
  "state": "acknowledged"
}

Body Response - Schema

202 (requested state accepted)

ParameterTypeDescription
stateobjectthe current state of the installation credentials
_linksobject"_links" subdivides into:

1 - "self" (object), which subdivides into:
1.1 - "href" (string) - default: http://api-docs.talkdesk.org/apps/{app_id}/installations/{id}/credentials/{client_id}/state

401 (unauthorized), 403 (forbidden), 404 (app/installation not found), 409 (requested state conflicts with current state of the target resource)

ParameterTypeDescriptionRequired
codestringn/ayes
messagestringn/ayes
descriptionstringn/ano
fieldsarray[object]"fields" subdivides into:

"name" (string)

"description" (string)
yes (name and description)

🚧

Troubleshooting

If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.

Language