post https://api.talkdeskapp.com/express/accounts//contracts/actions
Create a contract action for an express account. This operation facilitates the subscription, amendment or cancellation of an express contract.
Scope
express-accounts-contracts-actions:write
Body Response - Schema
200 OK
| Parameter | Type | Description |
|---|---|---|
| id | string | Contract action id. Required. Example: 123245132132 |
| action_type | string | The action type. Required. NEWTDE: New subscription. AMENDTDE: Amendment of the current subscription. CANCELTDE: Cancellation of the subscription. Allowed values: NEWTDE AMENDTDE CANCELTDE Example: NEWTDE |
| quantity | integer <32> | The number of licenses. Example: 10 |
| status | string | The contract action's status. Required. Allowed values: CREATED IN_PROGRESS COMPLETED FAILED Example: CREATED |
| status_message | string | The contract action's status message. Example: Contract action created successfully |
| created_at | (string) | Creation timestamp. Required. Example: 2022-03-10T16:15:50Z |
| updated_at | (string) | The update timestamp. Required. Example: 2022-03-10T16:15:50Z |
400 (bad request), 401 (unauthorized), 403 (forbidden), 404 (not found), 409 (conflict)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
API Availability
The Talkdesk Express API is in GA since the 5th of July, 2024.
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.