Credentials Transition

📘

Supported Regions and Base URLs

👍

Access and Registration

Authentication

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 the 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 questions or technical issues, please open a ticket using this form.

Path Params
string
required
Defaults to required
string
required
Defaults to required
string
required
Defaults to required
Responses

Language
Credentials
Header
Request
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json