post https://api.talkdeskapp.com/express/provisioning/account
Provision a new Talkdesk account.
When calling this endpoint, please ensure that you require users to accept the Talkdesk Services Trial Agreement.
Scope
express-provisioning:write
Body Request - Example
{
"account_name": "JosephPinetrees",
"admin_email": "[email protected]",
"admin_name": "John Doe",
"company_name": "Joseph Pinetree",
"currency_iso_code": "USD",
"num_licenses": 10,
"phone_number": "+351489489948",
"website_url": "https://www.josephpinetrees.com",
"edition": "EXPRESS",
"external_data": "Salesforce_id:2142141"
}
Body Response - Schema
200 OK
Account created
| Parameter | Type | Description | Required |
|---|---|---|---|
| admin_email | string | Example: [email protected] | no |
| created_at | string | Example: 2022-03-10T16:15:50Z | no |
| id | string | Example: 123245132132 | no |
| name | string | Example: JosephPinetrees | no |
| organization_id | string | Example: 12325234324 | no |
| updated_at | string | Example: 2022-03-10T16:15:50Z | no |
400 (bad request), 401 (unauthorized), 403 (forbidden)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array:parame | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
Rate Limit
2 requests per second
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.
API Availability
The Talkdesk Express API is in GA since the 5th of July, 2024.