v1

latestOpenAPI 3.0.02026-08-067074272.5 KB
Dashboard

Create a new dashboard with the given name and phone number

Creates a new dashboard in the account. Once the dashboard is created, admins will be emailed about the changed, and can begin assigning users. This endpoint can make a dashboard for any provisioned numbers. You can search for provisioned numbers in a specific area code using GET /dashboards/provisioning. If the phone number is already in use, a Bad Request exception will be thrown.

post/dashboards

Request body

namestring

Name of the dashboard.

phonestring

Texting number associated with this dashboard.

timeZoneIdstring

The Time Zone of this dashboard. Used in Autoresponders and handling scheduling around time changes

Example request

{
  "name": "John Doe's Line",
  "phone": "+1(555)-123-4567",
  "timeZoneId": "Eastern Standard Time"
}

Response

The new dashboard.

idinteger

The dashboard identifier. This will be used with all API calls at dashboard level.

namestring

Name of the dashboard.

phonestring

Texting number associated with this dashboard.

timeZoneIdstring

The Time Zone of this dashboard. Used in Autoresponders and handling scheduling around time changes

Example response

{
  "id": 121,
  "name": "Marketing",
  "phone": "15551234567",
  "timeZoneId": "Eastern Standard Time"
}