Installation State

📘

Supported Regions and Base URLs

Scope

apps:write

Request Body

{
  "state": "installing",
  "reason": "string"
}

Body Response - Schema

200 (state of the app successfully changed)

ParameterTypeDescription
statestringThe current state of the installation. Allowed values: "installing", "pending", "timeout", "completed", "failed", "rejected", "suspended", "revoked".
reasonstringa reason associated with the state change
updated_atstringdate of latest change to the installation
_linksobject"_links" subdivides into:

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

403 (forbidden), 404 (app or installation not found)

ParameterTypeDescription
errorstringthe error message
Language