v1

latestOpenAPI 3.0.22026-07-2441902.6 MB

EXPRESS API

Instantiate a Trial

Provision a new Talkdesk account

post/express/provisioning/account

Request body

account_namestring required

Account Name

admin_emailstring required

The email address of the admin for the account.

admin_namestring required

The first and last name of the admin for the account.

company_namestring required

The name of the company.

currency_iso_code'AUD' | 'BRL' | 'CAD' | 'EUR' | 'GBP' | 'SGD' | 'USD' required

The 3 chars ISO code of the currency for the account according to ISO-4217 (https://www.iso.org/iso-4217-currency-codes.html ).

edition'EXPRESS' required

The Talkdesk edition.

external_datastring

Custom data in string format to be stored along with the new account information.

{"stackTrail":"paths:/express/provisioning/account:post:requestBody:content:application/json:schema:properties:num_licenses","oasType":"schema","type":"unknown","description":"The number of TD licenses that will be available for the account.","example":10}

phone_numberstring required

The company’s phone number, starting with the country code.

website_urlstring required

The URL of the company’s website or social presence.

Example request

{
  "account_name": "josephpinetrees",
  "admin_email": "joseph@josephpinetrees.com",
  "admin_name": "John Doe",
  "authentication": {
    "identity_providers": {
      "oauth": {
        "google": {
          "enabled": true
        },
        "microsoft": {
          "enabled": true
        },
        "salesforce": {
          "enabled": true
        }
      }
    },
    "local_login_enabled": true
  },
  "company_name": "Joseph Pinetree",
  "currency_iso_code": "USD",
  "edition": "EXPRESS",
  "external_data": "salesforce_id:2142141",
  "num_licenses": 10,
  "phone_number": "+351489489948",
  "website_url": "https://www.josephpinetrees.com"
}

Response

admin_emailstring

created_atstring date-time

idstring

namestring

organization_idstring

updated_atstring date-time

Example response

{
  "admin_email": "joseph@josephpinetrees.com",
  "created_at": "2022-03-10T16:15:50Z",
  "id": "123245132132",
  "name": "josephpinetrees",
  "organization_id": "12325234324",
  "updated_at": "2022-03-10T16:15:50Z"
}