Skip to main content
API docs by Redocly

courier API definition (1.0.0)

courier API definition

/v1/aggregation-requests

/v1/aggregation-requests/

Request Body schema: application/json
required
object
type
required
string
Value: "aggregation-requests"
required
object
required
Array of objects
Array
column
required
string <= 64 characters
individual-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/announcers

Returns announcers

Returns announcers

query Parameters
filter[name]
string <= 255 characters
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Creates a new announcer

Creates a new announcer

Request Body schema: application/json
required
object
type
required
string
Value: "announcers"
required
object
args
required
object
event
required
string
Enum: "individual-shared" "individual-unshared"
name
required
string <= 255 characters
type
required
string <= 255 characters
organization-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Deletes an announcer

Deletes an announcer

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Returns specific announcer

Returns specific announcer

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Modifies an existing announcer

Modifies an existing announcer

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "announcers"
required
object
args
object
event
string
Enum: "individual-shared" "individual-unshared"
name
string <= 255 characters
type
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/app-credentials

/v1/app-credentials/

query Parameters
filter[app-name]
string <= 64 characters
filter[type]
string
Enum: "apn" "fcm"
include[archived]
boolean
Default: false
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/app-credentials/

Request Body schema: application/json
required
object
type
required
string
Value: "app-credentials"
required
object
app-name
required
string <= 64 characters
data
required
object
type
required
string
Enum: "apn" "fcm"
display-name
string <= 255 characters
organization-id
string <uuid>
store-id
string <= 255 characters
test-mode
boolean
Default: false
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/app-credentials/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/app-credentials/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/app-credentials/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "app-credentials"
required
object
app-name
string <= 64 characters
archived
boolean
data
object
display-name
string <= 255 characters
organization-id
string <uuid>
store-id
string <= 255 characters
test-mode
boolean
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/ask-entries

/v1/ask-entries/

Request Body schema: application/json
required
object
timestamp
required
string <datetime>
type
required
string <= 255 characters
property name*
additional property
any
property name*
additional property
any

Responses

Request samples

Content type
application/json
{
  • "request": {
    }
}

Response samples

Content type
application/json
{ }

/v1/ask-reminders

/v1/ask-reminders/

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/ask-reminders/

Request Body schema: application/json
required
object
type
required
string
Value: "ask-reminders"
required
object
individual-id
required
string <uuid>
name
required
string <= 255 characters
reminder-content
required
string <= 255 characters
reminder-rrule
required
string <rrule>
reminder-time-local
required
string <datetime>
tz-info
required
string <timezone>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/ask-reminders/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/ask-reminders/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/ask-reminders/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "ask-reminders"
required
object
name
string <= 255 characters
reminder-content
string <= 255 characters
reminder-rrule
string <rrule>
reminder-time-local
string <datetime>
tz-info
string <timezone>
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/ask-subscriptions

/v1/ask-subscriptions/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[skill-id]
string <uuid>
Example: filter[skill-id]=11111111-1111-1111-1111-111111111111
filter[user-id]
string <uuid>
Example: filter[user-id]=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/ask-subscriptions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/ask-subscriptions/{id}/send/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
name
required
string <= 255 characters
payload
required
object
expire
integer
Default: 3600
localized
Array of objects

Responses

Request samples

Content type
application/json
{
  • "event": {
    },
  • "expire": 3600,
  • "localized": [
    ]
}

Response samples

Content type
application/vnd.api+json
{ }

/v1/badge-counts

/v1/badge-counts/

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/badge-counts/

Request Body schema: application/json
required
object
type
required
string
Value: "badge-counts"
required
object
count
required
integer
individual-id
required
string <uuid>
type
required
string
Enum: "appointment" "article" "survey" "todo" "todo-self"
organization-id
string <uuid>
timestamp
string <datetime>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/badge-counts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/bulk-badge-counts

/v1/bulk-badge-counts/

Request Body schema: application/json
required
object
type
required
string
Value: "bulk-badge-counts"
required
object
required
Array of objects [ 1 .. 10000 ] items
Array ([ 1 .. 10000 ] items)
count
required
integer
individual-id
required
string <uuid>
type
required
string
Enum: "appointment" "article" "survey" "todo" "todo-self"
organization-id
string <uuid>
timestamp
string <datetime>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
null

/v1/communication-messages

/v1/communication-messages/

query Parameters
filter[archived]
boolean
filter[bookmarked]
boolean

If any bookmark exists for the channel

filter[cmp-last-modified-time]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against channel last-modified-time. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.

filter[individual-group-id]
string <uuid>
Example: filter[individual-group-id]=11111111-1111-1111-1111-111111111111
filter[text]
string <= 512 characters
filter[type]
string
Enum: "direct-message" "group-message" "multicast" "none" "open" "single"
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer [ 1 .. 100 ]
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings
Items Enum: "-ack-timestamp" "-last-timestamp" "-unread-count" "ack-timestamp" "last-timestamp" "unread-count"
use-group-name
boolean
Default: true

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": {
    }
}

/v1/communication-summaries

/v1/communication-summaries/

query Parameters
include-senders
boolean
Default: false

Include a mapping of individual-id to counts

individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "summary": {
    }
}

/v1/individual-groups

/v1/individual-groups/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/individuals

/v1/individuals/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/individuals/{id}/multicast/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
template-data
required
object
template-id
required
string <= 255 characters
organization-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "organization-id": "11111111-1111-1111-1111-111111111111",
  • "template-data": { },
  • "template-id": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "message-data": { },
  • "task-id": "11111111-1111-1111-1111-111111111111"
}

/v1/individuals/{id}/recalculate-communication-summary/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-attachments

/v1/messaging-attachments/

query Parameters
message-id
required
string <uuid>
Example: message-id=11111111-1111-1111-1111-111111111111
filter[include-pending]
boolean
Default: false
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/messaging-attachments/

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-attachments"
required
object
content-type
required
string
Enum: "application/msword" "application/pdf" "application/vnd.ms-excel" "application/vnd.ms-powerpoint" "application/vnd.openxmlformats-officedocument.presentationml.presentation" "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" "application/vnd.openxmlformats-officedocument.wordprocessingml.document" "audio/mpeg" "audio/ogg" "audio/x-wav" "image/avif" "image/bmp" "image/gif" "image/heic" "image/jpeg" "image/png" "image/tiff" "image/webp" "text/csv" "video/3gpp" "video/mp4" "video/mpeg" "video/quicktime" "video/webm" "video/x-m4v" "video/x-msvideo"
message-id
required
string <uuid>
filename
string <= 255 characters
Default: ""
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Deletes a message attachment

Deletes a message attachment

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/messaging-attachments/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-attachments/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-attachments"
required
object
removed
boolean
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-attachments/{id}/get-download-url/

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "url": "string"
}

/v1/messaging-attachments/{id}/process-upload/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
individual-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "individual-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-bookmarks

/v1/messaging-bookmarks/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[channel-id]
string <uuid>
Example: filter[channel-id]=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/messaging-bookmarks/

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-bookmarks"
required
object
allow-multi-message
boolean
Default: false
channel-id
string <uuid>
message-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-bookmarks/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/messaging-bookmarks/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-bulk-attachments

/v1/messaging-bulk-attachments/

query Parameters
bulk-message-id
required
string <uuid>
Example: bulk-message-id=11111111-1111-1111-1111-111111111111
filter[include-pending]
boolean
Default: false
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/messaging-bulk-attachments/

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-bulk-attachments"
required
object
bulk-message-id
required
string <uuid>
content-type
required
string
Enum: "application/msword" "application/pdf" "application/vnd.ms-excel" "application/vnd.ms-powerpoint" "application/vnd.openxmlformats-officedocument.presentationml.presentation" "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" "application/vnd.openxmlformats-officedocument.wordprocessingml.document" "audio/mpeg" "audio/ogg" "audio/x-wav" "image/avif" "image/bmp" "image/gif" "image/heic" "image/jpeg" "image/png" "image/tiff" "image/webp" "text/csv" "video/3gpp" "video/mp4" "video/mpeg" "video/quicktime" "video/webm" "video/x-m4v" "video/x-msvideo"
filename
string <= 255 characters
Default: ""
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

/v1/messaging-bulk-attachments/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/messaging-bulk-attachments/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-bulk-attachments/{id}/get-download-url/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "url": "string"
}

/v1/messaging-bulk-attachments/{id}/process-upload/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-bulk-messages

/v1/messaging-bulk-messages/

query Parameters
filter[created-by]
string <uuid>
Example: filter[created-by]=11111111-1111-1111-1111-111111111111
include-posted
boolean
Default: false
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Posts a new message to many channels

Posts a new message to many channels

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-bulk-messages"
required
object or object
Any of
individual-ids
required
Array of strings <uuid> non-empty [ items <uuid > ]
sender-individual-group-id
required
string <uuid>
sender-individual-id
required
string <uuid>
auto-ack
string
Enum: "" "all" "participants" "providers" "sender"
auto-create-channel
boolean
Default: true
draft
boolean
Default: false
individual-group-ids
Array of strings <uuid> [ items <uuid > ]
message
string <= 99999 characters
object
en_US
required
string <= 99999 characters
es_US
required
string <= 99999 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-bulk-messages/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/messaging-bulk-messages/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-bulk-messages/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-bulk-messages"
required
object
draft
boolean
message
string <= 99999 characters
object
en_US
required
string <= 99999 characters
es_US
required
string <= 99999 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-channels

Returns channels

Returns channels

query Parameters
filter[archived]
boolean
filter[cmp-last-modified-time]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against channel last-modified-time. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.

filter[floating]
boolean
filter[individual-group-id]
string <uuid>
Example: filter[individual-group-id]=11111111-1111-1111-1111-111111111111
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer [ 1 .. 50 ]
Default: 50
page[offset]
integer (PageOffset) >= 0
Default: 0
participant-id
string <uuid>
Example: participant-id=11111111-1111-1111-1111-111111111111
use-group-name
boolean
Default: true

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Creates a new channel

Creates a new channel

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-channels"
required
object
object
enabled
boolean
floating
boolean
Default: false
individual-group-id
string <uuid>
individual-ids
Array of strings <uuid> [ items <uuid > ]
label
string <= 255 characters
name
string <= 128 characters
organization-id
string <uuid>
subscription-type
string
Default: "open"
Enum: "none" "open" "single"
text-number-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Deletes a channel

Deletes a channel

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Returns specific channel

Returns specific channel

path Parameters
id
required
string

Resource identifier

query Parameters
include-individual-group
boolean
Deprecated
Default: false
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
use-group-name
boolean
Default: true

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Modifies an existing channel

Modifies an existing channel

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-channels"
required
Array of objects or objects
Array
Any of
op
required
string
Value: "replace"
path
required
string <= 255 characters
value
required
any
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Archive a channel

Archive a channel

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-channels/{id}/get-profile/

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

users operational individual-id

profile-individual-id
required
string <uuid>
Example: profile-individual-id=11111111-1111-1111-1111-111111111111

individual-id for requested profile

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    }
}

Modify channel preferences

Modify channel preferences

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
Array of objects
Array
name
required
string
Value: "notify"
value
string <= 255 characters
individual-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "individual-id": "11111111-1111-1111-1111-111111111111",
  • "values": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Enable/disable SMS path for this messaging channel

Enable/disable SMS path for this messaging channel

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
active
required
boolean
initial-message
string <= 1024 characters
object
en_US
required
string <= 1024 characters
es_US
required
string <= 1024 characters

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "initial-message": "string",
  • "initial-message-js": {
    }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Add subscriber to the channel

Add subscriber to the channel

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
individual-ids
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "individual-ids": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Unarchive a channel

Unarchive a channel

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Remove subscriber from the channel

Remove subscriber from the channel

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
individual-ids
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
application/json
{
  • "individual-ids": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-messages

Returns messages in specified group, posted by spe

Returns messages in specified group, posted by specified user, and belonging to specified subscription.

query Parameters
channel-id
required
string <uuid>
Example: channel-id=11111111-1111-1111-1111-111111111111
acknowledged
boolean
filter[cmp-last-modified-time]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against message last-modified-time. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.

filter[cmp-posted-time]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against message posted-time. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.

filter[text]
string <= 255 characters
include-phrases
boolean
Default: false
include-read-receipts
boolean
Default: false
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
thumbnail
boolean
Default: false
user-id
string <uuid>
Example: user-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Posts a new message

Posts a new message

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-messages"
required
object
channel-id
required
string <uuid>
message
required
string <= 99999 characters
auto-ack
string
Enum: "" "all" "participants" "providers" "sender"
draft
boolean
Default: false
include-destinations
Array of strings[ items <= 16 characters ]
individual-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Deletes a message

Deletes a message

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Returns a single message from the given id

Returns a single message from the given id

path Parameters
id
required
string

Resource identifier

query Parameters
include-phrases
boolean
Default: false
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
thumbnail
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Modifies an existing message

Modifies an existing message

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-messages"
required
object
draft
boolean
individual-id
string <uuid>
Deprecated
message
string <= 99999 characters
removed
boolean
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Acknowledge a message, and all messages before thi

Acknowledge a message, and all messages before this

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
allow-past
boolean
Default: false
individual-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "allow-past": false,
  • "individual-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

add a user-reaction to a message

add a user-reaction to a message

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
reaction-type
required
string
Enum: "dislike" "like" "lol" "love" "sad" "wow"
individual-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "individual-id": "11111111-1111-1111-1111-111111111111",
  • "reaction-type": "dislike"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

delete a user-reaction from a message

delete a user-reaction from a message

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
reaction-type
required
string
Enum: "dislike" "like" "lol" "love" "sad" "wow"
individual-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "individual-id": "11111111-1111-1111-1111-111111111111",
  • "reaction-type": "dislike"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

get receipts of this message

get receipts of this message

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "read": [
    ],
  • "unread": [
    ]
}

/v1/messaging-operations

/v1/messaging-operations/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[type]
string
Value: "move-group"
include-args
boolean
Default: false
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/messaging-operations/

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-operations"
required
object
args
required
object
organization-id
required
string <uuid>
type
required
string
Value: "move-group"
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-operations/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
include-args
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-plugins

/v1/messaging-plugins/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[name]
string [ 4 .. 15 ] characters ^[a-z0-9]+$
filter[type]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/messaging-plugins/

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-plugins"
required
object
args
required
object
name
required
string [ 4 .. 15 ] characters ^[a-z0-9]+$
organization-id
required
string <uuid>
type
required
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-plugins/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/messaging-plugins/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-plugins/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-plugins"
required
object
args
object
name
string [ 4 .. 15 ] characters ^[a-z0-9]+$
type
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-plugins/{id}/disable/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-plugins/{id}/enable/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-plugins/{id}/expand/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
channel-id
required
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "channel-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "message": "string"
}

/v1/messaging-responders

/v1/messaging-responders/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[cmp-end-at]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against end-at. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame. Append ,null to include null values.

filter[cmp-start-at]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against start-at. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame. Append ,null to include null values.

filter[enabled]
boolean
filter[individual-group-id]
string <uuid>
Example: filter[individual-group-id]=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
sort
Array of strings non-empty
Default: "created-at"
Items Enum: "-created-at" "-end-at" "-start-at" "created-at" "end-at" "start-at"

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/messaging-responders/

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-responders"
required
object
args
required
object
required
object
required
Array of objects
timezone
required
string <timezone>
name
required
string <= 255 characters
organization-id
required
string <uuid>
type
required
string <= 255 characters
end-at
string <datetime>
individual-group-id
string <uuid>
start-at
string <datetime>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-responders/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/messaging-responders/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-responders/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "messaging-responders"
required
object
args
object
object
required
Array of objects
timezone
required
string <timezone>
null or string
One of
null
individual-group-id
string <uuid>
name
string <= 255 characters
null or string
One of
null
type
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-responders/{id}/disable/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/messaging-responders/{id}/enable/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/multicasts

/v1/multicasts/

query Parameters
filter[cmp-created-at]
Array of strings <= 2 items [ items <= 40 characters ]

Compare timestamp against multicast created-at. Specify [comparator][datetime]. Comparators supported >, <, <=, >=. Use multiple to build a bounded time frame.

include-individual-group
boolean
Default: false
include-individual-ids
boolean
Default: false
individual-group-id
string <uuid>
Example: individual-group-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
template-id
string <= 255 characters

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/multicasts/

Request Body schema: application/json
required
object
type
required
string
Value: "multicasts"
required
object or object or object
Any of
filter-type
required
string
Enum: "all-participants" "all-users"
data
object
filter-value
object
organization-id
string <uuid>
template-id
string
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/multicasts/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
include-individual-group
boolean
Default: false
include-individual-ids
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/org-preferences

/v1/org-preferences/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[name]
string
Enum: "default-channel-title" "group-provider-ack" "initial-sms-message"

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/org-preferences/

Request Body schema: application/json
required
object
type
required
string
Value: "org-preferences"
required
object
name
required
string
Enum: "default-channel-title" "group-provider-ack" "initial-sms-message"
organization-id
required
string <uuid>
type
string
Default: "string"
Enum: "json" "string"
value
string <= 255 characters
value-js
object
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/org-preferences/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/organizations

/v1/organizations/

query Parameters
filter[name]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/organizations/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/purge-data

/v1/purge-data/

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/purge-data/

Request Body schema: application/json
required
object
type
required
string
Value: "system-purges"
required
object
entity-id
required
string <= 255 characters
entity-type
required
string
Enum: "individual" "organization" "user"
reference-id
required
string <= 255 characters
request-id
required
string <= 255 characters
archive
boolean
Default: false
property name*
additional property
any
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
null

/v1/replicators

/v1/replicators/

query Parameters
filter[classpath]
string <= 255 characters

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/replicators/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/sniffers

/v1/sniffers/

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/sniffers/

Request Body schema: application/json
required
object
type
required
string
Value: "sniffers"
required
object
user-id
required
string <uuid>
valid-until
required
string <datetime>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/sniffers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/sniffers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/sniffers/{id}/get-logs/

path Parameters
id
required
string

Resource identifier

query Parameters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/tasks

/v1/tasks/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-account-numbers

/v1/text-account-numbers/

query Parameters
account-id
string <uuid>
Example: account-id=11111111-1111-1111-1111-111111111111
filter[phone-number]
string <phonenumberE164>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
phone-number
string <phonenumberE164>

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/text-account-numbers/

Request Body schema: application/json
required
object
type
required
string
Value: "text-account-numbers"
required
object
account-id
required
string <uuid>
alert
boolean
Default: true
area-code
string <= 3 characters ^\d\d\d$
forward-to
string <phonenumberE164_us>
logging
boolean
Default: false
notes
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-account-numbers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/text-account-numbers/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-account-numbers/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "text-account-numbers"
required
object
alert
boolean
object
unknown-number
object
forward-to
string <= 16 characters
logging
boolean
notes
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-account-numbers/{id}/reset-logs/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-accounts

/v1/text-accounts/

query Parameters
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/text-accounts/

Request Body schema: application/json
required
object
type
required
string
Value: "text-accounts"
required
object
organization-id
required
string <uuid>
allow-custom-number
boolean
Default: false
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-accounts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/text-accounts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-accounts/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "text-accounts"
required
object
allow-custom-number
boolean
phone-number
string <phonenumberE164_us>
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-accounts/{id}/claim-number/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
notes
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "notes": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-number-info

/v1/text-number-info/

query Parameters
number
required
string <phonenumberE164_us>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/text-number-info/

Request Body schema: application/json
required
object
type
required
string
Value: "text-number-info"
required
object
number
required
string <phonenumberE164_us>
reresolve
boolean
Default: false
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-number-info/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/text-number-info/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-number-logs

/v1/text-number-logs/

query Parameters
number-id
required
string <uuid>
Example: number-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/text-number-logs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-receive-logs

/v1/text-receive-logs/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-receivers

/v1/text-receivers/

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

/v1/text-user-number-maps

/v1/text-user-number-maps/

query Parameters
filter[number-id]
string <uuid>
Example: filter[number-id]=11111111-1111-1111-1111-111111111111
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
filter[user-id]
string <uuid>
Example: filter[user-id]=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/text-user-number-maps/

Request Body schema: application/json
required
object
type
required
string
Value: "text-user-number-maps"
required
object
number-id
required
string <uuid>
organization-id
required
string <uuid>
user-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/text-user-number-maps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/text-user-number-maps/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/texts

/v1/texts/

query Parameters
account-id
required
string <uuid>
Example: account-id=11111111-1111-1111-1111-111111111111
filter[number-id]
string <uuid>
Example: filter[number-id]=11111111-1111-1111-1111-111111111111
filter[target]
string <phonenumberE164>
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/texts/

Request Body schema: application/json
required
object
type
required
string
Value: "texts"
required
object
message
required
string <= 1600 characters
target
required
string <phonenumberE164>
account-id
string <uuid>
callback-json
object
callback-one-off
boolean
Default: true
callback-status-url
string <url>
callback-url
string <url>
expected-responses
Array of strings[ items <= 64 characters ]
number-id
string <uuid>
organization-id
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/texts/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/texts/{id}/callback/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

/v1/tts-synthesizers

/v1/tts-synthesizers/

Request Body schema: application/json
required
object
type
required
string
Value: "tts-synthesizers"
required
object
locale
required
string
Enum: "en-US" "es-US"
text
required
string [ 1 .. 2500 ] characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-consents

/v1/user-consents/

query Parameters
filter[organization-id]
string <uuid>
Example: filter[organization-id]=11111111-1111-1111-1111-111111111111
filter[user-id]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/user-consents/

Request Body schema: application/json
required
object
type
required
string
Value: "user-consents"
required
object
organization-id
required
string <uuid>
user-id
required
string <uuid>
object
Any of
required
object
accept
required
string
initial
required
string
invalid-response
required
string
type
string
Default: "sms"
Value: "sms"
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-consents/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/user-consents/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-devices

/v1/user-devices/

query Parameters
all-users
boolean
Default: false
filter[app-name]
string <= 64 characters
filter[app-version]
string <= 20 characters
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[model]
string <= 64 characters
filter[type]
string
Enum: "apn" "fcm" "web"
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0
token
string <= 255 characters

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/user-devices/

Request Body schema: application/json
required
object
type
required
string
Value: "user-devices"
required
object
token
required
string <= 255 characters
type
required
string
Enum: "apn" "fcm" "web"
allow-notification
boolean
app-name
string <= 64 characters
app-version
string <= 20 characters
individual-id
string <uuid>
model
string <= 64 characters
os-version
string <= 20 characters
sandbox
boolean
Default: false
topic
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-devices/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/user-devices/{id}/get-logs/

path Parameters
id
required
string

Resource identifier

query Parameters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/user-email-attachments

/v1/user-email-attachments/

query Parameters
email-id
required
string <uuid>
Example: email-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/user-email-attachments/

Request Body schema: application/json
required
object
type
required
string
Value: "user-email-attachments"
required
object
content-type
required
string <= 255 characters
email-id
required
string <uuid>
filename
required
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "expiration-time": 0,
  • "id": "11111111-1111-1111-1111-111111111111",
  • "upload-data": { },
  • "upload-url": "string"
}

/v1/user-email-attachments/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/user-email-attachments/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
with-link
boolean
Default: false

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-email-attachments/{id}/process-upload/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-emails

/v1/user-emails/

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/user-emails/

Request Body schema: application/json
required
object
type
required
string
Value: "user-emails"
required
object
message
required
string <= 99999 characters
subject
required
string <= 255 characters
auto-send
boolean
Default: true
individual-id
string <uuid>
message-html
string <= 99999 characters
sender-organization-id
string <uuid>
string or Array of strings
Any of
string <email>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-emails/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-emails/{id}/send/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-multicasts

/v1/user-multicasts/

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/user-multicasts/

Request Body schema: application/json
template-data
required
object
template-id
required
string <= 255 characters
individual-group-ids
Array of strings <uuid> non-empty [ items <uuid > ]
individual-ids
Array of strings <uuid> non-empty [ items <uuid > ]
organization-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "individual-group-ids": [
    ],
  • "individual-ids": [
    ],
  • "organization-id": "11111111-1111-1111-1111-111111111111",
  • "template-data": { },
  • "template-id": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "message-data": { },
  • "task-id": "11111111-1111-1111-1111-111111111111"
}

/v1/user-notification-counts

/v1/user-notification-counts/

query Parameters
filter[cmp-created-at]
Array of strings <= 2 items [ items <= 40 characters ]

compare timestamp against notification created_at time. specify [comparator][datetime]. comparators supported <=, >=use multiple to build a bounded time frame.

page[limit]
integer [ 0 .. 1000 ]
Default: 500
page[offset]
integer >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/user-notifications

/v1/user-notifications/

query Parameters
acknowledged
boolean
filter[category]
string <= 32 characters
include[inactive]
boolean
Default: false
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/user-notifications/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/user-notifications/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/user-notifications/{id}/ack/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
ack-previous
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "ack-previous": false
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/users

/v1/users/

query Parameters
filter[email]
string <email>
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[username]
string <= 255 characters
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/users/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/users/{id}/ Deprecated

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "users"
required
object
notifications
Array of strings
Items Enum: "email" "mobile" "sms" "web"
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/users/{id}/multicast/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
template-id
required
string <= 255 characters
data
object
individual-id
string <uuid>
organization-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "data": { },
  • "individual-id": "11111111-1111-1111-1111-111111111111",
  • "organization-id": "11111111-1111-1111-1111-111111111111",
  • "template-id": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "message-data": { },
  • "task-id": "11111111-1111-1111-1111-111111111111"
}

/v1/users/{id}/validate-multicast-params/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
data
required
object
individual-id
required
string <uuid>
organization-id
required
string <uuid>
template-id
required
string <= 255 characters

Responses

Request samples

Content type
application/json
{
  • "data": { },
  • "individual-id": "11111111-1111-1111-1111-111111111111",
  • "organization-id": "11111111-1111-1111-1111-111111111111",
  • "template-id": "string"
}

Response samples

Content type
application/vnd.api+json
{
  • "info": "string",
  • "success": true
}

/v1/video-channels

Returns channels

Returns channels

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
filter[states]
Array of strings
Items Enum: "open" "scheduled" "terminated"
organization-id
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Creates a new channel

Creates a new channel

Request Body schema: application/json
required
object
type
required
string
Value: "video-channels"
required
object
organization-id
required
string <uuid>
participants
required
Array of strings <uuid> [ items <uuid > ]
appless
boolean
Default: false
object
duration
required
integer

minutes

id
required
string <uuid>
start
required
string <datetime>
messaging-channel-id
string <uuid>
recorded
boolean
Default: false
subject-id
string <uuid>
type
string
Default: "direct"
Value: "direct"
with-email
boolean
Default: false
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Deletes a channel

Deletes a channel

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

Returns specific channel

Returns specific channel

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Modifies an existing video-channel

Modifies an existing video-channel

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "video-channels"
required
object
appointment-duration
integer

minutes

appointment-start
string <datetime>
note
string <= 99999 characters
recorded
boolean
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/video-channels/{id}/event/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{ }

/v1/video-channels/{id}/finalize-encounter/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
service-type-id
string <uuid>
use-note-from-author-participant
boolean
Default: false

Responses

Request samples

Content type
application/json
{
  • "service-type-id": "11111111-1111-1111-1111-111111111111",
  • "use-note-from-author-participant": false
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/video-channels/{id}/get-credentials/

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "access-token": "string",
  • "name": "string"
}

/v1/video-channels/{id}/participant-audio-states/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
Array of objects
Array
audio-state
required
string
Enum: "muted" "unmuted"
id
required
string <uuid>
individual-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "individual-id": "11111111-1111-1111-1111-111111111111",
  • "participants": [
    ]
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/video-channels/{id}/reminder-timer/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/video-channels/{id}/terminate/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/video-compositions

/v1/video-compositions/

query Parameters
video-channel-id
required
string <uuid>
Example: video-channel-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/video-compositions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/video-compositions/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/video-compositions/{id}/get-download-url/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "url": "string"
}

/v1/video-participants

Returns participants

Returns participants

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111
page[limit]
required
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
required
integer (PageOffset) >= 0
Default: 0
video-channel-id
required
string <uuid>
Example: video-channel-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Returns specific participant

Returns specific participant

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Modify participant

Modify participant

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "video-participants"
required
object
audio-state
string
Enum: "muted" "unmuted"
disconnected
boolean

To track user's intended state

note
string <= 99999 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-conferences

/v1/voice-conferences/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[states]
Array of strings
Items Enum: "completed" "created" "failed" "running"
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-conferences/

Request Body schema: application/json
required
object
type
required
string
Value: "voice-conferences"
required
object
individual-id
required
string <uuid>
organization-id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-conferences/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-conferences/{id}/get-credentials/

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
required
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "access-token": "string"
}

/v1/voice-dial-logs

/v1/voice-dial-logs/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[conference-id]
string <uuid>
Example: filter[conference-id]=11111111-1111-1111-1111-111111111111
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-dial-logs/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-ivrs

/v1/voice-ivrs/{id}/twiml/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{
  • "errors": [
    ]
}

/v1/voice-queue-agents

/v1/voice-queue-agents/

query Parameters
setting-id
required
string <uuid>
Example: setting-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-queue-agents/

Request Body schema: application/json
required
object
type
required
string
Value: "voice-queue-agents"
required
object
individual-id
required
string <uuid>
setting-id
required
string <uuid>
phone-number
string <phonenumberE164_us>
use-pstn
boolean
Default: false
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-queue-agents/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/voice-queue-agents/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-queue-entries

/v1/voice-queue-entries/

query Parameters
setting-id
required
string <uuid>
Example: setting-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-queue-entries/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-recordings

/v1/voice-recordings/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[setting-id]
string <uuid>
Example: filter[setting-id]=11111111-1111-1111-1111-111111111111
filter[states]
Array of strings
Items Enum: "completed" "inprogress"
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-recordings/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/voice-recordings/{id}/

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-recordings/{id}/event/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

/v1/voice-recordings/{id}/get-download-url/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "url": "string"
}

/v1/voice-settings

/v1/voice-settings/

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

/v1/voice-settings/

Request Body schema: application/json
required
object
type
required
string
Value: "voice-settings"
required
object
account-id
required
string <uuid>
phone-number
required
string <phonenumberE164>
forward-number
string <phonenumberE164>
recording-enabled
boolean
Default: false
recording-message
string <= 1000 characters
wait-message
string <= 255 characters
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-settings/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
null

/v1/voice-settings/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-settings/{id}/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
required
object
type
required
string
Value: "voice-settings"
required
object
null or string
One of
null
phone-number
string <phonenumberE164>
recording-enabled
boolean
Default: false
recording-message
string <= 1000 characters
wait-message
string <= 255 characters
id
required
string <uuid>
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-settings/{id}/run-task/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
method
required
string
Value: "refresh_queue_entries"
kwargs
object

Responses

Request samples

Content type
application/json
{
  • "kwargs": { },
  • "method": "refresh_queue_entries"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-surveys

Returns surveys

Returns surveys

query Parameters
organization-id
required
string <uuid>
Example: organization-id=11111111-1111-1111-1111-111111111111
filter[individual-id]
string <uuid>
Example: filter[individual-id]=11111111-1111-1111-1111-111111111111
filter[states]
Array of strings
Items Enum: "completed" "created" "failed" "running"
page[limit]
integer (PageLimit) [ 1 .. 1000 ]
Default: 100
page[offset]
integer (PageOffset) >= 0
Default: 0

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": [
    ],
  • "meta": { }
}

Creates a new survey

Creates a new survey

Request Body schema: application/json
required
object
type
required
string
Value: "voice-surveys"
required
object
individual-id
required
string <uuid>
organization-id
required
string <uuid>
spec
required
object
meta
object

Responses

Request samples

Content type
application/json
{
  • "data": {
    },
  • "meta": { }
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

Returns specific survey

Returns specific survey

path Parameters
id
required
string

Resource identifier

query Parameters
individual-id
string <uuid>
Example: individual-id=11111111-1111-1111-1111-111111111111

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-surveys/{id}/event/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/vnd.api+json
{ }

/v1/voice-surveys/{id}/twiml/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

/v1/voice-tasks

/v1/voice-tasks/{id}/

path Parameters
id
required
string

Resource identifier

Responses

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}

/v1/voice-twiml

/v1/voice-twiml/

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

/v1/voice-twiml/{id}/update-queue/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

/v1/voice-twimlapp

/v1/voice-twimlapp/

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

/v1/voice-twimlapp/{id}/update/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
property name*
additional property
any

Responses

Request samples

Content type
application/json
{ }

/v2/video-channels

/v2/video-channels/{id}/finalize-encounter/

path Parameters
id
required
string

Resource identifier

Request Body schema: application/json
service-type-id
string <uuid>

Responses

Request samples

Content type
application/json
{
  • "service-type-id": "11111111-1111-1111-1111-111111111111"
}

Response samples

Content type
application/vnd.api+json
{
  • "data": {
    },
  • "meta": { }
}