Show/hide List Operations Expand Operations

Chats

/api/v2/chats

GET /api/v2/chats

Get all user chats.

Documentation
Sandbox

Documentation

Get all user chats.

Filters

Name

Information

status

Requirement	(a\|c\|d)
Description	Fetch only (a)ctive, (c)losed or (d)eleted chats
Default	a

page

Requirement	\d+
Description	Fetch specified results page
Default	1

limit

Requirement	\d+
Description	How many results to return
Default	10

orderBy

Requirement	(id\|unread\|messageTime)
Description	Order results by some field. Default is id
Default	id

voice

Requirement	\d+
Description	Fetch results with voice calls
Default	0

flat

Requirement	\d
Description	Should additional contact info include
Default	0

unread

Requirement	\d
Description	Unread chats only
Default	0

Return

Parameter	Type	Versions	Description
id	integer	*
originalId	integer	*
phone	string	*
contact	object (Contact)	*
contact[favorited]	boolean	*
contact[id]	integer	*
contact[firstName]	string	*
contact[lastName]	string	*
contact[companyName]	string	*
contact[phone]	string	*
contact[email]	string	*
contact[country]	object (Country)	*
contact[country][id]	string	*
contact[country][name]	string	*
contact[customFields][]	array of objects (ContactCustomField)	*
contact[customFields][][id]	integer	*
contact[customFields][][name]	string	*
contact[customFields][][createdAt]	DateTime	*
contact[user]	object (User)	*
contact[user][id]	integer	*
contact[user][username]	string	*
contact[user][firstName]	string	*
contact[user][lastName]	string	*
contact[user][email]	string	*
contact[user][status]	string	*
contact[user][balance]	double	*
contact[user][phone]	string	*
contact[user][company]	string	*
contact[user][currency]	object (Currency)	*
contact[user][currency][unicodeSymbol]	string	*	Get currency symbol
contact[user][currency][id]	string	*
contact[user][currency][htmlSymbol]	string	*
contact[user][country]	object (Country)	*
contact[user][timezone]	object (Timezone)	*
contact[user][timezone][id]	integer	*
contact[user][timezone][area]	string	*
contact[user][timezone][dst]	integer	*
contact[user][timezone][offset]	integer	*
contact[user][timezone][timezone]	string	*
contact[user][subaccountType]	string	*
contact[user][emailAccepted]	boolean	*
contact[user][phoneAccepted]	boolean	*
contact[user][avatar]	object (UserImage)	*
contact[user][avatar][href]	string	*
contact[lists][]	array of objects (Group)	*
contact[lists][][favorited]	boolean	*
contact[lists][][id]	integer	*
contact[lists][][name]	string	*
contact[lists][][description]	string	*
contact[lists][][membersCount]	integer	*
contact[lists][][user]	object (User)	*
contact[lists][][service]	boolean	*
contact[lists][][shared]	boolean	*
contact[lists][][avatar]	object (GroupImage)	*
contact[lists][][avatar][href]	string	*
contact[lists][][isDefault]	boolean	*
contact[phoneType]	string	*
contact[avatar]	object (ContactImage)	*
contact[avatar][href]	string	*
contact[notes][]	array of objects (ContactNote)	*
contact[notes][][id]	integer	*
contact[notes][][createdAt]	DateTime	*
contact[notes][][note]	string	*
contact[notes][][user]	object (User)	*
unsubscribedContactId	integer	*
unread	integer	*
updatedAt	DateTime	*
status	string	*
mute	integer	*
lastMessage	string	*
direction	string	*
from	string	*
mutedUntil	DateTime	*
timeLeftMute	integer	*
country	object (Country)	*
country[id]	string	*
country[name]	string	*

Status Codes

Status Code	Description
200	Returned when successful

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v2/chats/close/bulk

Close chats by chat ids or close all chats

POST /api/v2/chats/close/read
- Close all chats that have no unread messages.
- Documentation
- Sandbox
Documentation

Close all chats that have no unread messages.

Status Codes
Status Code Description

204

Returned when successfull

400

Returned when the form has errors
Input

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Parameter	Type	Required?	Format	Description
ids	string	true		Entity ID(s), separated by comma
all	choice	true	[0,1]	Optional. Default is 0 (false). If set to 1 all the entities will be removed.

Status Code	Description
204	Returned when successfull
400	Returned when the form has errors

Status Code	Description
204	Returned when successfull
400	Returned when the form has errors

POST /api/v2/chats/delete

Delete chats by given ID(s) or delete all chats.

POST /api/v2/chats/mute
- Set mute mode.
- Documentation
- Sandbox
Documentation

Set mute mode.

Parameters

Parameter Type Required? Format Description

id string true Chat ID

mute choice true [0,1] Mute value

for string true Mute for N hours

Status Codes
Status Code Description

201

Returned when successful

400

Returned when the form has errors
Input
Parameters

= -

= -

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Parameter	Type	Required?	Format	Description
ids	string	true		Entity ID(s), separated by comma
all	choice	true	[0,1]	Optional. Default is 0 (false). If set to 1 all the entities will be removed.
status	string	true		Optional. Default is empty string (false). If set then all entities with specified status will be affected.

Status Code	Description
204	Returned when successful
400	Returned when the form has errors

Parameter	Type	Required?	Format	Description
id	string	true		Chat ID
mute	choice	true	[0,1]	Mute value
for	string	true		Mute for N hours

POST /api/v2/chats/mute/bulk

Mute several chats by chat ids or mute all chats

Parameter	Type	Required?	Format	Description
ids	string	true		Entity ID(s), separated by comma
all	choice	true	[0,1]	Optional. Default is 0 (false). If set to 1 all the entities will be removed.
for	string	true		Mute for N hours

Status Code	Description
204	Returned when successfull
400	Returned when the form has errors

POST /api/v2/chats/read/bulk

Mark several chats as read by chat ids or mark all chats as read

Parameter	Type	Required?	Format	Description
ids	string	true		Entity ID(s), separated by comma
all	choice	true	[0,1]	Optional. Default is 0 (false). If set to 1 all the entities will be removed.

Status Code	Description
204	Returned when successfull
400	Returned when the form has errors

POST /api/v2/chats/reopen/bulk

Reopen chats by chat ids or reopen all chats

Parameter	Type	Required?	Format	Description
ids	string	true		Entity ID(s), separated by comma
all	choice	true	[0,1]	Optional. Default is 0 (false). If set to 1 all the entities will be removed.

Status Code	Description
204	Returned when successful
400	Returned when the form has errors

GET /api/v2/chats/search

Find chats by inbound or outbound messages text.

Documentation
Sandbox

Documentation

Find chats by inbound or outbound messages text.

Filters

Name

Information

page

Requirement	\d+
Description	Fetch specified results page
Default	1

limit

Requirement	\d+
Description	How many results to return
Default	10

query

Description

Find messages by specified search query

Return

Parameter	Type	Versions	Description
id	integer	*
originalId	integer	*
phone	string	*
contact	object (Contact)	*
contact[favorited]	boolean	*
contact[id]	integer	*
contact[firstName]	string	*
contact[lastName]	string	*
contact[companyName]	string	*
contact[phone]	string	*
contact[email]	string	*
contact[country]	object (Country)	*
contact[country][id]	string	*
contact[country][name]	string	*
contact[customFields][]	array of objects (ContactCustomField)	*
contact[customFields][][id]	integer	*
contact[customFields][][name]	string	*
contact[customFields][][createdAt]	DateTime	*
contact[user]	object (User)	*
contact[user][id]	integer	*
contact[user][username]	string	*
contact[user][firstName]	string	*
contact[user][lastName]	string	*
contact[user][email]	string	*
contact[user][status]	string	*
contact[user][balance]	double	*
contact[user][phone]	string	*
contact[user][company]	string	*
contact[user][currency]	object (Currency)	*
contact[user][currency][unicodeSymbol]	string	*	Get currency symbol
contact[user][currency][id]	string	*
contact[user][currency][htmlSymbol]	string	*
contact[user][country]	object (Country)	*
contact[user][timezone]	object (Timezone)	*
contact[user][timezone][id]	integer	*
contact[user][timezone][area]	string	*
contact[user][timezone][dst]	integer	*
contact[user][timezone][offset]	integer	*
contact[user][timezone][timezone]	string	*
contact[user][subaccountType]	string	*
contact[user][emailAccepted]	boolean	*
contact[user][phoneAccepted]	boolean	*
contact[user][avatar]	object (UserImage)	*
contact[user][avatar][href]	string	*
contact[lists][]	array of objects (Group)	*
contact[lists][][favorited]	boolean	*
contact[lists][][id]	integer	*
contact[lists][][name]	string	*
contact[lists][][description]	string	*
contact[lists][][membersCount]	integer	*
contact[lists][][user]	object (User)	*
contact[lists][][service]	boolean	*
contact[lists][][shared]	boolean	*
contact[lists][][avatar]	object (GroupImage)	*
contact[lists][][avatar][href]	string	*
contact[lists][][isDefault]	boolean	*
contact[phoneType]	string	*
contact[avatar]	object (ContactImage)	*
contact[avatar][href]	string	*
contact[notes][]	array of objects (ContactNote)	*
contact[notes][][id]	integer	*
contact[notes][][createdAt]	DateTime	*
contact[notes][][note]	string	*
contact[notes][][user]	object (User)	*
unsubscribedContactId	integer	*
unread	integer	*
updatedAt	DateTime	*
status	string	*
mute	integer	*
lastMessage	string	*
direction	string	*
from	string	*
mutedUntil	DateTime	*
timeLeftMute	integer	*
country	object (Country)	*
country[id]	string	*
country[name]	string	*

Status Codes

Status Code	Description
200	Returned when successful

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/chats/search/ids

Find chats by IDs.

Documentation
Sandbox

Documentation

Find chats by IDs.

Filters

Name

Information

page

Requirement	\d+
Description	Fetch specified results page
Default	1

limit

Requirement	\d+
Description	How many results to return
Default	10

ids

Requirement	[,\d]+
Description	Find chats by ID(s)

Return

Parameter	Type	Versions	Description
id	integer	*
originalId	integer	*
phone	string	*
contact	object (Contact)	*
contact[favorited]	boolean	*
contact[id]	integer	*
contact[firstName]	string	*
contact[lastName]	string	*
contact[companyName]	string	*
contact[phone]	string	*
contact[email]	string	*
contact[country]	object (Country)	*
contact[country][id]	string	*
contact[country][name]	string	*
contact[customFields][]	array of objects (ContactCustomField)	*
contact[customFields][][id]	integer	*
contact[customFields][][name]	string	*
contact[customFields][][createdAt]	DateTime	*
contact[user]	object (User)	*
contact[user][id]	integer	*
contact[user][username]	string	*
contact[user][firstName]	string	*
contact[user][lastName]	string	*
contact[user][email]	string	*
contact[user][status]	string	*
contact[user][balance]	double	*
contact[user][phone]	string	*
contact[user][company]	string	*
contact[user][currency]	object (Currency)	*
contact[user][currency][unicodeSymbol]	string	*	Get currency symbol
contact[user][currency][id]	string	*
contact[user][currency][htmlSymbol]	string	*
contact[user][country]	object (Country)	*
contact[user][timezone]	object (Timezone)	*
contact[user][timezone][id]	integer	*
contact[user][timezone][area]	string	*
contact[user][timezone][dst]	integer	*
contact[user][timezone][offset]	integer	*
contact[user][timezone][timezone]	string	*
contact[user][subaccountType]	string	*
contact[user][emailAccepted]	boolean	*
contact[user][phoneAccepted]	boolean	*
contact[user][avatar]	object (UserImage)	*
contact[user][avatar][href]	string	*
contact[lists][]	array of objects (Group)	*
contact[lists][][favorited]	boolean	*
contact[lists][][id]	integer	*
contact[lists][][name]	string	*
contact[lists][][description]	string	*
contact[lists][][membersCount]	integer	*
contact[lists][][user]	object (User)	*
contact[lists][][service]	boolean	*
contact[lists][][shared]	boolean	*
contact[lists][][avatar]	object (GroupImage)	*
contact[lists][][avatar][href]	string	*
contact[lists][][isDefault]	boolean	*
contact[phoneType]	string	*
contact[avatar]	object (ContactImage)	*
contact[avatar][href]	string	*
contact[notes][]	array of objects (ContactNote)	*
contact[notes][][id]	integer	*
contact[notes][][createdAt]	DateTime	*
contact[notes][][note]	string	*
contact[notes][][user]	object (User)	*
unsubscribedContactId	integer	*
unread	integer	*
updatedAt	DateTime	*
status	string	*
mute	integer	*
lastMessage	string	*
direction	string	*
from	string	*
mutedUntil	DateTime	*
timeLeftMute	integer	*
country	object (Country)	*
country[id]	string	*
country[name]	string	*

Status Codes

Status Code	Description
200	Returned when successful

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/chats/search/recipients

Find chats by recipient (contact, list name or phone number).

Documentation
Sandbox

Documentation

Find chats by recipient (contact, list name or phone number).

Filters

Name

Information

page

Requirement	\d+
Description	Fetch specified results page
Default	1

limit

Requirement	\d+
Description	How many results to return
Default	10

query

Description

Find chats by specified recipient

orderBy

Requirement	(id\|unread\|messageTime)
Description	Order results by some field. Default is id
Default	id

Return

Parameter	Type	Versions	Description
id	integer	*
originalId	integer	*
phone	string	*
contact	object (Contact)	*
contact[favorited]	boolean	*
contact[id]	integer	*
contact[firstName]	string	*
contact[lastName]	string	*
contact[companyName]	string	*
contact[phone]	string	*
contact[email]	string	*
contact[country]	object (Country)	*
contact[country][id]	string	*
contact[country][name]	string	*
contact[customFields][]	array of objects (ContactCustomField)	*
contact[customFields][][id]	integer	*
contact[customFields][][name]	string	*
contact[customFields][][createdAt]	DateTime	*
contact[user]	object (User)	*
contact[user][id]	integer	*
contact[user][username]	string	*
contact[user][firstName]	string	*
contact[user][lastName]	string	*
contact[user][email]	string	*
contact[user][status]	string	*
contact[user][balance]	double	*
contact[user][phone]	string	*
contact[user][company]	string	*
contact[user][currency]	object (Currency)	*
contact[user][currency][unicodeSymbol]	string	*	Get currency symbol
contact[user][currency][id]	string	*
contact[user][currency][htmlSymbol]	string	*
contact[user][country]	object (Country)	*
contact[user][timezone]	object (Timezone)	*
contact[user][timezone][id]	integer	*
contact[user][timezone][area]	string	*
contact[user][timezone][dst]	integer	*
contact[user][timezone][offset]	integer	*
contact[user][timezone][timezone]	string	*
contact[user][subaccountType]	string	*
contact[user][emailAccepted]	boolean	*
contact[user][phoneAccepted]	boolean	*
contact[user][avatar]	object (UserImage)	*
contact[user][avatar][href]	string	*
contact[lists][]	array of objects (Group)	*
contact[lists][][favorited]	boolean	*
contact[lists][][id]	integer	*
contact[lists][][name]	string	*
contact[lists][][description]	string	*
contact[lists][][membersCount]	integer	*
contact[lists][][user]	object (User)	*
contact[lists][][service]	boolean	*
contact[lists][][shared]	boolean	*
contact[lists][][avatar]	object (GroupImage)	*
contact[lists][][avatar][href]	string	*
contact[lists][][isDefault]	boolean	*
contact[phoneType]	string	*
contact[avatar]	object (ContactImage)	*
contact[avatar][href]	string	*
contact[notes][]	array of objects (ContactNote)	*
contact[notes][][id]	integer	*
contact[notes][][createdAt]	DateTime	*
contact[notes][][note]	string	*
contact[notes][][user]	object (User)	*
unsubscribedContactId	integer	*
unread	integer	*
updatedAt	DateTime	*
status	string	*
mute	integer	*
lastMessage	string	*
direction	string	*
from	string	*
mutedUntil	DateTime	*
timeLeftMute	integer	*
country	object (Country)	*
country[id]	string	*
country[name]	string	*

Status Codes

Status Code	Description
200	Returned when successful

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v2/chats/status
- Set status of the chat given by ID.
- Documentation
- Sandbox
Documentation

Set status of the chat given by ID.

Parameters

Parameter Type Required? Format Description

id string true Chat ID

status choice true {"Closed":"c","Active":"a"} Status

Status Codes
Status Code Description

201

Returned when successful

400

Returned when the form has errors
Input
Parameters

= -

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Parameter	Type	Required?	Format	Description
id	string	true		Chat ID
status	choice	true	{"Closed":"c","Active":"a"}	Status

POST /api/v2/chats/unmute/bulk

Unmute several chats by chat ids or unmute all chats

Parameter	Type	Required?	Format	Description
ids	string	true		Entity ID(s), separated by comma
all	choice	true	[0,1]	Optional. Default is 0 (false). If set to 1 all the entities will be removed.

Status Code	Description
204	Returned when successfull
400	Returned when the form has errors

POST /api/v2/chats/unread/bulk

Mark several chats as UNread by chat ids or mark all chats as UNread

/api/v2/chats/unread/count
- - GET /api/v2/chats/unread/count
    - Get total amount of unread messages in the current user chats.
    - Documentation
    - Sandbox
    Documentation
    
    Get total amount of unread messages in the current user chats.
    
    Status Codes
    
    Status Code Description
    
    200
    
    Returned when successful
    
    Input
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]

Parameter	Type	Required?	Format	Description
ids	string	true		Entity ID(s), separated by comma
all	choice	true	[0,1]	Optional. Default is 0 (false). If set to 1 all the entities will be removed.

Status Code	Description
204	Returned when successfull
400	Returned when the form has errors

/api/v2/chats/{id}

GET /api/v2/chats/{id}

Get a single chat.

Documentation
Sandbox

Documentation

Get a single chat.

Requirements

Name	Requirement	Type	Description
id		integer	Chat ID.

Filters

Name

Information

page

Requirement	\d+
Description	Fetch specified results page
Default	1

limit

Requirement	\d+
Description	How many results to return
Default	10

Return

Parameter	Type	Versions	Description
id	integer	*
originalId	integer	*
phone	string	*
contact	object (Contact)	*
contact[favorited]	boolean	*
contact[id]	integer	*
contact[firstName]	string	*
contact[lastName]	string	*
contact[companyName]	string	*
contact[phone]	string	*
contact[email]	string	*
contact[country]	object (Country)	*
contact[country][id]	string	*
contact[country][name]	string	*
contact[customFields][]	array of objects (ContactCustomField)	*
contact[customFields][][id]	integer	*
contact[customFields][][name]	string	*
contact[customFields][][createdAt]	DateTime	*
contact[user]	object (User)	*
contact[user][id]	integer	*
contact[user][username]	string	*
contact[user][firstName]	string	*
contact[user][lastName]	string	*
contact[user][email]	string	*
contact[user][status]	string	*
contact[user][balance]	double	*
contact[user][phone]	string	*
contact[user][company]	string	*
contact[user][currency]	object (Currency)	*
contact[user][currency][unicodeSymbol]	string	*	Get currency symbol
contact[user][currency][id]	string	*
contact[user][currency][htmlSymbol]	string	*
contact[user][country]	object (Country)	*
contact[user][timezone]	object (Timezone)	*
contact[user][timezone][id]	integer	*
contact[user][timezone][area]	string	*
contact[user][timezone][dst]	integer	*
contact[user][timezone][offset]	integer	*
contact[user][timezone][timezone]	string	*
contact[user][subaccountType]	string	*
contact[user][emailAccepted]	boolean	*
contact[user][phoneAccepted]	boolean	*
contact[user][avatar]	object (UserImage)	*
contact[user][avatar][href]	string	*
contact[lists][]	array of objects (Group)	*
contact[lists][][favorited]	boolean	*
contact[lists][][id]	integer	*
contact[lists][][name]	string	*
contact[lists][][description]	string	*
contact[lists][][membersCount]	integer	*
contact[lists][][user]	object (User)	*
contact[lists][][service]	boolean	*
contact[lists][][shared]	boolean	*
contact[lists][][avatar]	object (GroupImage)	*
contact[lists][][avatar][href]	string	*
contact[lists][][isDefault]	boolean	*
contact[phoneType]	string	*
contact[avatar]	object (ContactImage)	*
contact[avatar][href]	string	*
contact[notes][]	array of objects (ContactNote)	*
contact[notes][][id]	integer	*
contact[notes][][createdAt]	DateTime	*
contact[notes][][note]	string	*
contact[notes][][user]	object (User)	*
unsubscribedContactId	integer	*
unread	integer	*
updatedAt	DateTime	*
status	string	*
mute	integer	*
lastMessage	string	*
direction	string	*
from	string	*
mutedUntil	DateTime	*
timeLeftMute	integer	*
country	object (Country)	*
country[id]	string	*
country[name]	string	*

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when no contact found

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/chats/{id}/message

Fetch messages from chat with specified chat id.

POST /api/v2/chats/{id}/messages/delete

Delete messages from chat by given messages ID(s).

/api/v2/chats/{phone}/by/phone

GET /api/v2/chats/{phone}/by/phone

Find chats by phone.

Documentation
Sandbox

Documentation

Find chats by phone.

Requirements

Name	Requirement	Type	Description
phone		string	Phone.

Filters

Name

Information

upsert

Requirement	(1\|0)
Description	Create a new chat if not found
Default	0

reopen

Requirement	(1\|0)
Description	Reopen chat if found or do not change status
Default	1

Return

Parameter	Type	Versions	Description
id	integer	*
originalId	integer	*
phone	string	*
contact	object (Contact)	*
contact[favorited]	boolean	*
contact[id]	integer	*
contact[firstName]	string	*
contact[lastName]	string	*
contact[companyName]	string	*
contact[phone]	string	*
contact[email]	string	*
contact[country]	object (Country)	*
contact[country][id]	string	*
contact[country][name]	string	*
contact[customFields][]	array of objects (ContactCustomField)	*
contact[customFields][][id]	integer	*
contact[customFields][][name]	string	*
contact[customFields][][createdAt]	DateTime	*
contact[user]	object (User)	*
contact[user][id]	integer	*
contact[user][username]	string	*
contact[user][firstName]	string	*
contact[user][lastName]	string	*
contact[user][email]	string	*
contact[user][status]	string	*
contact[user][balance]	double	*
contact[user][phone]	string	*
contact[user][company]	string	*
contact[user][currency]	object (Currency)	*
contact[user][currency][unicodeSymbol]	string	*	Get currency symbol
contact[user][currency][id]	string	*
contact[user][currency][htmlSymbol]	string	*
contact[user][country]	object (Country)	*
contact[user][timezone]	object (Timezone)	*
contact[user][timezone][id]	integer	*
contact[user][timezone][area]	string	*
contact[user][timezone][dst]	integer	*
contact[user][timezone][offset]	integer	*
contact[user][timezone][timezone]	string	*
contact[user][subaccountType]	string	*
contact[user][emailAccepted]	boolean	*
contact[user][phoneAccepted]	boolean	*
contact[user][avatar]	object (UserImage)	*
contact[user][avatar][href]	string	*
contact[lists][]	array of objects (Group)	*
contact[lists][][favorited]	boolean	*
contact[lists][][id]	integer	*
contact[lists][][name]	string	*
contact[lists][][description]	string	*
contact[lists][][membersCount]	integer	*
contact[lists][][user]	object (User)	*
contact[lists][][service]	boolean	*
contact[lists][][shared]	boolean	*
contact[lists][][avatar]	object (GroupImage)	*
contact[lists][][avatar][href]	string	*
contact[lists][][isDefault]	boolean	*
contact[phoneType]	string	*
contact[avatar]	object (ContactImage)	*
contact[avatar][href]	string	*
contact[notes][]	array of objects (ContactNote)	*
contact[notes][][id]	integer	*
contact[notes][][createdAt]	DateTime	*
contact[notes][][note]	string	*
contact[notes][][user]	object (User)	*
unsubscribedContactId	integer	*
unread	integer	*
updatedAt	DateTime	*
status	string	*
mute	integer	*
lastMessage	string	*
direction	string	*
from	string	*
mutedUntil	DateTime	*
timeLeftMute	integer	*
country	object (Country)	*
country[id]	string	*
country[name]	string	*

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when no contact found

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Show/hide List Operations Expand Operations

Contacts

/api/v2/contacts

GET /api/v2/contacts

Get all user contacts.

Documentation
Sandbox

Documentation

Get all user contacts.

Filters

Name

Information

page

Requirement	\d+
Description	Fetch specified results page
Default	1

limit

Requirement	\d+
Description	How many results to return
Default	10

shared

Requirement	\d
Description	Should shared contacts to be included
Default	0

orderBy

Requirement	(id\|firstName\|lastName)
Description	Order results by some field. Default is id
Default	id

direction

Requirement	(asc\|desc)
Description	Order direction. Default is desc
Default	desc

Return

Parameter	Type	Versions	Description
firstName	string	*
lastName	string	*
email	string	*
phone	string	*
companyName	string	*
favorited	boolean	*
id	integer	*
country	object (Country)	*
country[id]	string	*
country[name]	string	*
customFields[]	array of objects (ContactCustomField)	*
customFields[][id]	integer	*
customFields[][name]	string	*
customFields[][createdAt]	DateTime	*
user	object (User)	*
user[id]	integer	*
user[username]	string	*
user[firstName]	string	*
user[lastName]	string	*
user[email]	string	*
user[status]	string	*
user[balance]	double	*
user[phone]	string	*
user[company]	string	*
user[currency]	object (Currency)	*
user[currency][unicodeSymbol]	string	*	Get currency symbol
user[currency][id]	string	*
user[currency][htmlSymbol]	string	*
user[country]	object (Country)	*
user[timezone]	object (Timezone)	*
user[timezone][id]	integer	*
user[timezone][area]	string	*
user[timezone][dst]	integer	*
user[timezone][offset]	integer	*
user[timezone][timezone]	string	*
user[subaccountType]	string	*
user[emailAccepted]	boolean	*
user[phoneAccepted]	boolean	*
user[avatar]	object (UserImage)	*
user[avatar][href]	string	*
lists[]	array of objects (Group)	*
lists[][favorited]	boolean	*
lists[][id]	integer	*
lists[][name]	string	*
lists[][description]	string	*
lists[][membersCount]	integer	*
lists[][user]	object (User)	*
lists[][service]	boolean	*
lists[][shared]	boolean	*
lists[][avatar]	object (GroupImage)	*
lists[][avatar][href]	string	*
lists[][isDefault]	boolean	*
phoneType	string	*
avatar	object (ContactImage)	*
avatar[href]	string	*
notes[]	array of objects (ContactNote)	*
notes[][id]	integer	*
notes[][createdAt]	DateTime	*
notes[][note]	string	*
notes[][user]	object (User)	*

Status Codes

Status Code	Description
200	Returned when successful

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v2/contacts

Create a new contact from the submitted data.

Documentation
Sandbox

Documentation

Create a new contact from the submitted data.

Parameters

Parameter	Type	Required?	Format	Description
firstName	string	false		Contact first name
lastName	string	false		Contact last name
phone	string	true		Contact phone number in E.164 (international) format without leading + or zeroes
email	string	false		Contact email
companyName	string	false		Contact company name
lists	string	true		Array of list resources id contact will be assigned to
favorited	choice	false	[false,true]	Optional. Is contact favorited. Default is false
blocked	choice	false	[false,true]	Optional. Is contact blocked for outgoing and incoming messaging. Default is false
type	string	false		Optional. Force type of phone. Possible values: 0 - landline, 1 - mobile. Default is -1 (auto detection)
customFieldValues[]	array of strings	false
local	choice	false	[false,true]	Optional. Treat phone number passed in 'phone' field as local. Default is false
country	choice	false		Optional. 2-letter ISO country code for local phone numbers, used when 'local' is set to true. Default is account country

Return

Parameter	Type	Versions	Description
id	integer	*	Resource id
href	string	*	Resource endpoint

Status Codes

Status Code	Description
201	Returned when successful
400	Returned when the form has errors

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v2/contacts/delete

Delete contact by given ID(s) or delete all contacts.

GET /api/v2/contacts/search

Find user contacts by given parameters.

Documentation
Sandbox

Documentation

Find user contacts by given parameters.

Filters

Name

Information

page

Requirement	\d+
Description	Fetch specified results page
Default	1

limit

Requirement	\d+
Description	How many results to return
Default	10

shared

Requirement	\d
Description	Should shared contacts to be included
Default	0

ids

Requirement	[,\d]+
Description	Find contact by ID(s)

listId

Requirement	\d+
Description	Find contact by List ID

includeBlocked

Requirement	(0\|1)
Description	Should blocked contacts to be included
Default	0

query

Description

Find contact by specified search query

local

Requirement	(0\|1)
Description	Treat phone number passed in 'query' field as local. Default is false
Default	0

country

Description

2-letter ISO country code for local phone numbers, used when 'local' is set to true. Default is account country

orderBy

Requirement	(id\|firstName\|lastName)
Description	Order results by some field. Default is id
Default	id

direction

Requirement	(asc\|desc)
Description	Order direction. Default is desc
Default	desc

Return

Parameter	Type	Versions	Description
firstName	string	*
lastName	string	*
email	string	*
phone	string	*
companyName	string	*
favorited	boolean	*
id	integer	*
country	object (Country)	*
country[id]	string	*
country[name]	string	*
customFields[]	array of objects (ContactCustomField)	*
customFields[][id]	integer	*
customFields[][name]	string	*
customFields[][createdAt]	DateTime	*
user	object (User)	*
user[id]	integer	*
user[username]	string	*
user[firstName]	string	*
user[lastName]	string	*
user[email]	string	*
user[status]	string	*
user[balance]	double	*
user[phone]	string	*
user[company]	string	*
user[currency]	object (Currency)	*
user[currency][unicodeSymbol]	string	*	Get currency symbol
user[currency][id]	string	*
user[currency][htmlSymbol]	string	*
user[country]	object (Country)	*
user[timezone]	object (Timezone)	*
user[timezone][id]	integer	*
user[timezone][area]	string	*
user[timezone][dst]	integer	*
user[timezone][offset]	integer	*
user[timezone][timezone]	string	*
user[subaccountType]	string	*
user[emailAccepted]	boolean	*
user[phoneAccepted]	boolean	*
user[avatar]	object (UserImage)	*
user[avatar][href]	string	*
lists[]	array of objects (Group)	*
lists[][favorited]	boolean	*
lists[][id]	integer	*
lists[][name]	string	*
lists[][description]	string	*
lists[][membersCount]	integer	*
lists[][user]	object (User)	*
lists[][service]	boolean	*
lists[][shared]	boolean	*
lists[][avatar]	object (GroupImage)	*
lists[][avatar][href]	string	*
lists[][isDefault]	boolean	*
phoneType	string	*
avatar	object (ContactImage)	*
avatar[href]	string	*
notes[]	array of objects (ContactNote)	*
notes[][id]	integer	*
notes[][createdAt]	DateTime	*
notes[][note]	string	*
notes[][user]	object (User)	*

Status Codes

Status Code	Description
200	Returned when successful

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/api/v2/contacts/autocomplete

GET /api/v2/contacts/autocomplete

Get contacts autocomplete suggestions by given search term.

Documentation
Sandbox

Documentation

Get contacts autocomplete suggestions by given search term.

Filters

Name

Information

limit

Requirement	\d+
Description	How many results to return
Default	10

query

Description

Find recipients by specified search query

lists

Requirement	(1\|0)
Description	Should return also lists for autocomplete or not
Default	1

Return

Parameter	Type	Versions	Description
firstName	string	*
lastName	string	*
email	string	*
phone	string	*
companyName	string	*
favorited	boolean	*
id	integer	*
country	object (Country)	*
country[id]	string	*
country[name]	string	*
customFields[]	array of objects (ContactCustomField)	*
customFields[][id]	integer	*
customFields[][name]	string	*
customFields[][createdAt]	DateTime	*
user	object (User)	*
user[id]	integer	*
user[username]	string	*
user[firstName]	string	*
user[lastName]	string	*
user[email]	string	*
user[status]	string	*
user[balance]	double	*
user[phone]	string	*
user[company]	string	*
user[currency]	object (Currency)	*
user[currency][unicodeSymbol]	string	*	Get currency symbol
user[currency][id]	string	*
user[currency][htmlSymbol]	string	*
user[country]	object (Country)	*
user[timezone]	object (Timezone)	*
user[timezone][id]	integer	*
user[timezone][area]	string	*
user[timezone][dst]	integer	*
user[timezone][offset]	integer	*
user[timezone][timezone]	string	*
user[subaccountType]	string	*
user[emailAccepted]	boolean	*
user[phoneAccepted]	boolean	*
user[avatar]	object (UserImage)	*
user[avatar][href]	string	*
lists[]	array of objects (Group)	*
lists[][favorited]	boolean	*
lists[][id]	integer	*
lists[][name]	string	*
lists[][description]	string	*
lists[][membersCount]	integer	*
lists[][user]	object (User)	*
lists[][service]	boolean	*
lists[][shared]	boolean	*
lists[][avatar]	object (GroupImage)	*
lists[][avatar][href]	string	*
lists[][isDefault]	boolean	*
phoneType	string	*
avatar	object (ContactImage)	*
avatar[href]	string	*
notes[]	array of objects (ContactNote)	*
notes[][id]	integer	*
notes[][createdAt]	DateTime	*
notes[][note]	string	*
notes[][user]	object (User)	*

Status Codes

Status Code	Description
200	Returned when successful

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/api/v2/contacts/block
- - POST /api/v2/contacts/block
    - Block contact from inbound and outbound communication by phone number.
    - Documentation
    - Sandbox
    Documentation
    
    Block contact from inbound and outbound communication by phone number.
    
    Parameters
    
    Parameter Type Required? Format Description
    
    phone string true Contact phone number
    
    Return
    
    Parameter Type Versions Description
    
    id integer * Resource id
    
    href string * Resource endpoint
    
    Status Codes
    
    Status Code Description
    
    201
    
    Returned when successful
    
    400
    
    Returned when the form has errors
    
    Input
    Parameters
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]

/api/v2/contacts/block/list

GET /api/v2/contacts/block/list

Get blocked contacts.

Documentation
Sandbox

Documentation

Get blocked contacts.

Filters

Name

Information

page

Requirement	\d+
Description	Fetch specified results page
Default	1

limit

Requirement	\d+
Description	How many results to return
Default	10

query

Description

Find blocked contacts by specified search query

orderBy

Requirement	(id\|firstName\|lastName)
Description	Order results by some field. Default is id
Default	id

direction

Requirement	(asc\|desc)
Description	Order direction. Default is desc
Default	desc

Return

Parameter	Type	Versions	Description
firstName	string	*
lastName	string	*
email	string	*
phone	string	*
companyName	string	*
favorited	boolean	*
id	integer	*
country	object (Country)	*
country[id]	string	*
country[name]	string	*
customFields[]	array of objects (ContactCustomField)	*
customFields[][id]	integer	*
customFields[][name]	string	*
customFields[][createdAt]	DateTime	*
user	object (User)	*
user[id]	integer	*
user[username]	string	*
user[firstName]	string	*
user[lastName]	string	*
user[email]	string	*
user[status]	string	*
user[balance]	double	*
user[phone]	string	*
user[company]	string	*
user[currency]	object (Currency)	*
user[currency][unicodeSymbol]	string	*	Get currency symbol
user[currency][id]	string	*
user[currency][htmlSymbol]	string	*
user[country]	object (Country)	*
user[timezone]	object (Timezone)	*
user[timezone][id]	integer	*
user[timezone][area]	string	*
user[timezone][dst]	integer	*
user[timezone][offset]	integer	*
user[timezone][timezone]	string	*
user[subaccountType]	string	*
user[emailAccepted]	boolean	*
user[phoneAccepted]	boolean	*
user[avatar]	object (UserImage)	*
user[avatar][href]	string	*
lists[]	array of objects (Group)	*
lists[][favorited]	boolean	*
lists[][id]	integer	*
lists[][name]	string	*
lists[][description]	string	*
lists[][membersCount]	integer	*
lists[][user]	object (User)	*
lists[][service]	boolean	*
lists[][shared]	boolean	*
lists[][avatar]	object (GroupImage)	*
lists[][avatar][href]	string	*
lists[][isDefault]	boolean	*
phoneType	string	*
avatar	object (ContactImage)	*
avatar[href]	string	*
notes[]	array of objects (ContactNote)	*
notes[][id]	integer	*
notes[][createdAt]	DateTime	*
notes[][note]	string	*
notes[][user]	object (User)	*

Status Codes

Status Code	Description
200	Returned when successful

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/api/v2/contacts/block/phone
- - GET /api/v2/contacts/block/phone
    - Check is that phone number blocked
    - Documentation
    - Sandbox
    Documentation
    
    Check is that phone number blocked
    
    Requirements
    
    Name Requirement Type Description
    
    phone \d+ Phone number to check
    
    Status Codes
    
    Status Code Description
    
    200
    
    Returned when successful
    
    404
    
    When contact is not blocked
    
    Input
    Requirements
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]

/api/v2/contacts/favorite

GET /api/v2/contacts/favorite

Get favorite contacts and lists.

/api/v2/contacts/import

POST /api/v2/contacts/import

Import contacts from the CSV, XLS or XLSX file.

/api/v2/contacts/import/progress/{id}
- - GET /api/v2/contacts/import/progress/{id}
    - Get contact import session progress.
    - Documentation
    - Sandbox
    Documentation
    
    Get contact import session progress.
    
    Requirements
    
    Name Requirement Type Description
    
    id int Import session id
    
    Status Codes
    
    Status Code Description
    
    200
    
    Returned when successful
    
    404
    
    Returned when no contact found
    
    Input
    Requirements
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]

/api/v2/contacts/phone/{phone}

GET /api/v2/contacts/phone/{phone}

Get a single contact by phone number.

Documentation
Sandbox

Documentation

Get a single contact by phone number.

Requirements

Name	Requirement	Type	Description
phone		int	Phone number in internation E.164 format without plus sign

Return

Parameter	Type	Versions	Description
firstName	string	*
lastName	string	*
email	string	*
phone	string	*
companyName	string	*
favorited	boolean	*
id	integer	*
country	object (Country)	*
country[id]	string	*
country[name]	string	*
customFields[]	array of objects (ContactCustomField)	*
customFields[][id]	integer	*
customFields[][name]	string	*
customFields[][createdAt]	DateTime	*
user	object (User)	*
user[id]	integer	*
user[username]	string	*
user[firstName]	string	*
user[lastName]	string	*
user[email]	string	*
user[status]	string	*
user[balance]	double	*
user[phone]	string	*
user[company]	string	*
user[currency]	object (Currency)	*
user[currency][unicodeSymbol]	string	*	Get currency symbol
user[currency][id]	string	*
user[currency][htmlSymbol]	string	*
user[country]	object (Country)	*
user[timezone]	object (Timezone)	*
user[timezone][id]	integer	*
user[timezone][area]	string	*
user[timezone][dst]	integer	*
user[timezone][offset]	integer	*
user[timezone][timezone]	string	*
user[subaccountType]	string	*
user[emailAccepted]	boolean	*
user[phoneAccepted]	boolean	*
user[avatar]	object (UserImage)	*
user[avatar][href]	string	*
lists[]	array of objects (Group)	*
lists[][favorited]	boolean	*
lists[][id]	integer	*
lists[][name]	string	*
lists[][description]	string	*
lists[][membersCount]	integer	*
lists[][user]	object (User)	*
lists[][service]	boolean	*
lists[][shared]	boolean	*
lists[][avatar]	object (GroupImage)	*
lists[][avatar][href]	string	*
lists[][isDefault]	boolean	*
phoneType	string	*
avatar	object (ContactImage)	*
avatar[href]	string	*
notes[]	array of objects (ContactNote)	*
notes[][id]	integer	*
notes[][createdAt]	DateTime	*
notes[][note]	string	*
notes[][user]	object (User)	*

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when no contact found

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/api/v2/contacts/unblock

POST /api/v2/contacts/unblock
- Unblock contact by phone number.
- Documentation
- Sandbox
Documentation

Unblock contact by phone number.

Parameters

Parameter Type Required? Format Description

phone string true Contact phone number

Status Codes
Status Code Description

201

Returned when successful

400

Returned when the form has errors
Input
Parameters

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v2/contacts/unblock/bulk

Unblock several contacts by blocked contact ids or unblock all contacts

/api/v2/contacts/{id}

DELETE /api/v2/contacts/{id}
- Delete a single contact.
- Documentation
- Sandbox
Documentation

Delete a single contact.

Requirements

Name Requirement Type Description

id int Contact id

Status Codes
Status Code Description

204

Returned when successful

403

Returned when trying to delete contact shared to you

404

Returned when no contact found
Input
Requirements

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/contacts/{id}

Get a single contact.

Documentation
Sandbox

Documentation

Get a single contact.

Requirements

Name	Requirement	Type	Description
id		int	Contact id

Return

Parameter	Type	Versions	Description
firstName	string	*
lastName	string	*
email	string	*
phone	string	*
companyName	string	*
favorited	boolean	*
id	integer	*
country	object (Country)	*
country[id]	string	*
country[name]	string	*
customFields[]	array of objects (ContactCustomField)	*
customFields[][id]	integer	*
customFields[][name]	string	*
customFields[][createdAt]	DateTime	*
user	object (User)	*
user[id]	integer	*
user[username]	string	*
user[firstName]	string	*
user[lastName]	string	*
user[email]	string	*
user[status]	string	*
user[balance]	double	*
user[phone]	string	*
user[company]	string	*
user[currency]	object (Currency)	*
user[currency][unicodeSymbol]	string	*	Get currency symbol
user[currency][id]	string	*
user[currency][htmlSymbol]	string	*
user[country]	object (Country)	*
user[timezone]	object (Timezone)	*
user[timezone][id]	integer	*
user[timezone][area]	string	*
user[timezone][dst]	integer	*
user[timezone][offset]	integer	*
user[timezone][timezone]	string	*
user[subaccountType]	string	*
user[emailAccepted]	boolean	*
user[phoneAccepted]	boolean	*
user[avatar]	object (UserImage)	*
user[avatar][href]	string	*
lists[]	array of objects (Group)	*
lists[][favorited]	boolean	*
lists[][id]	integer	*
lists[][name]	string	*
lists[][description]	string	*
lists[][membersCount]	integer	*
lists[][user]	object (User)	*
lists[][service]	boolean	*
lists[][shared]	boolean	*
lists[][avatar]	object (GroupImage)	*
lists[][avatar][href]	string	*
lists[][isDefault]	boolean	*
phoneType	string	*
avatar	object (ContactImage)	*
avatar[href]	string	*
notes[]	array of objects (ContactNote)	*
notes[][id]	integer	*
notes[][createdAt]	DateTime	*
notes[][note]	string	*
notes[][user]	object (User)	*

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when no contact found

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /api/v2/contacts/{id}

Update existing contact.

Documentation
Sandbox

Documentation

Update existing contact.

Requirements

Name	Requirement	Type	Description
id		int	Contact id

Parameters

Parameter	Type	Required?	Format	Description
firstName	string	false		Contact first name
lastName	string	false		Contact last name
phone	string	true		Contact phone number in E.164 (international) format without leading + or zeroes
email	string	false		Contact email
companyName	string	false		Contact company name
lists	string	true		Array of list resources id contact will be assigned to
favorited	choice	false	[false,true]	Optional. Is contact favorited. Default is false
blocked	choice	false	[false,true]	Optional. Is contact blocked for outgoing and incoming messaging. Default is false
type	string	false		Optional. Force type of phone. Possible values: 0 - landline, 1 - mobile. Default is -1 (auto detection)
customFieldValues[]	array of strings	false
local	choice	false	[false,true]	Optional. Treat phone number passed in 'phone' field as local. Default is false
country	choice	false		Optional. 2-letter ISO country code for local phone numbers, used when 'local' is set to true. Default is account country

Return

Parameter	Type	Versions	Description
id	integer	*	Resource id
href	string	*	Resource endpoint

Status Codes

Status Code	Description
201	Returned when successful
400	Returned when the form has errors
403	Returned when trying to edit contact shared to current user
404	Returned when no contact found

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/contacts/{id}/lists

Return lists which contact belongs to.

/api/v2/contacts/{id}/avatar

DELETE /api/v2/contacts/{id}/avatar
- Delete an avatar for the contact.
- Documentation
- Sandbox
Documentation

Delete an avatar for the contact.

Requirements

Name Requirement Type Description

id int Contact id

Status Codes
Status Code Description

204

Returned when successful

403

Returned when trying to edit contact shared to current user

404

Returned when no contact found
Input
Requirements

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v2/contacts/{id}/avatar

Add an avatar for the contact.

/api/v2/contacts/{id}/notes

GET /api/v2/contacts/{id}/notes

Fetch notes assigned to the given contact.

POST /api/v2/contacts/{id}/notes
- Create a new contact note.
- Documentation
- Sandbox
Documentation

Create a new contact note.

Requirements

Name Requirement Type Description

id int Contact id

Parameters

Parameter Type Required? Format Description

note string true

Return

Parameter Type Versions Description

id integer * Resource id

href string * Resource endpoint

Status Codes
Status Code Description

201

Returned when successful

400

Returned when the form has errors

404

Returned when no contact found
Input
Requirements

= -

Parameters

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v2/contacts/{id}/notes/delete

Delete contact note by given ID(s) or delete all contact notes.

/api/v2/customfields
- - GET /api/v2/customfields
    - Get all contact custom fields.
    - Documentation
    - Sandbox
    Documentation
    
    Get all contact custom fields.
    
    Filters
    
    Name Information
    
    page
    
    Requirement \d+
    
    Description Fetch specified results page
    
    Default 1
    
    limit
    
    Requirement \d+
    
    Description How many results to return
    
    Default 10
    
    Return
    
    Parameter Type Versions Description
    
    id integer *
    
    name string *
    
    createdAt DateTime *
    
    Status Codes
    
    Status Code Description
    
    200
    
    Returned when successful
    
    Input
    Filters
    
    = -
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]
  - POST /api/v2/customfields
    - Create a new custom field from the submitted data.
    - Documentation
    - Sandbox
    Documentation
    
    Create a new custom field from the submitted data.
    
    Parameters
    
    Parameter Type Required? Format Description
    
    name string true Custom field name
    
    Status Codes
    
    Status Code Description
    
    201
    
    Returned when successful
    
    400
    
    Returned when the form has errors
    
    Input
    Parameters
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]

/api/v2/customfields/{id}
- - DELETE /api/v2/customfields/{id}
    - Delete a single custom field.
    - Documentation
    - Sandbox
    Documentation
    
    Delete a single custom field.
    
    Requirements
    
    Name Requirement Type Description
    
    id int Custom field id
    
    Status Codes
    
    Status Code Description
    
    204
    
    Returned when successful
    
    404
    
    Returned when no custom field found
    
    Input
    Requirements
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]
  - GET /api/v2/customfields/{id}
    - Get a single custom field.
    - Documentation
    - Sandbox
    Documentation
    
    Get a single custom field.
    
    Requirements
    
    Name Requirement Type Description
    
    id int Custom field id
    
    Return
    
    Parameter Type Versions Description
    
    id integer *
    
    name string *
    
    createdAt DateTime *
    
    Status Codes
    
    Status Code Description
    
    200
    
    Returned when successful
    
    404
    
    Returned when no custom field found
    
    Input
    Requirements
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]
  - PUT /api/v2/customfields/{id}
    - Update existing custom field.
    - Documentation
    - Sandbox
    Documentation
    
    Update existing custom field.
    
    Requirements
    
    Name Requirement Type Description
    
    id int Custom field id
    
    Parameters
    
    Parameter Type Required? Format Description
    
    name string true Custom field name
    
    Return
    
    Parameter Type Versions Description
    
    id integer * Resource id
    
    href string * Resource endpoint
    
    Status Codes
    
    Status Code Description
    
    201
    
    Returned when successful
    
    400
    
    Returned when the form has errors
    
    404
    
    Returned when no custom field found
    
    Input
    Requirements
    
    = -
    
    Parameters
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]
  - PUT /api/v2/customfields/{id}/update
    - Update contact's custom field value.
    - Documentation
    - Sandbox
    Documentation
    
    Update contact's custom field value.
    
    Requirements
    
    Name Requirement Type Description
    
    id int Custom field id
    
    Parameters
    
    Parameter Type Required? Format Description
    
    contactId string true
    
    value string true
    
    Return
    
    Parameter Type Versions Description
    
    id integer * Resource id
    
    href string * Resource endpoint
    
    Status Codes
    
    Status Code Description
    
    201
    
    Returned when successful
    
    400
    
    Returned when the form has errors
    
    404
    
    Returned when no custom field found
    
    Input
    Requirements
    
    = -
    
    Parameters
    
    = -
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]

/api/v2/email-lookups/{email}

GET /api/v2/email-lookups/{email}

Email Lookup

/api/v2/lookups/{phone}
- - GET /api/v2/lookups/{phone}
    - Carrier Lookup
    - Documentation
    - Sandbox
    Documentation
    
    Carrier Lookup
    
    Requirements
    
    Name Requirement Type Description
    
    phone string Phone number
    
    Filters
    
    Name Information
    
    country
    
    Description Country code for local formatted numbers
    
    Return
    
    Parameter Type Versions Description
    
    cost double *
    
    local string *
    
    type string *
    
    carrier string *
    
    number164 string *
    
    valid boolean *
    
    Status Codes
    
    Status Code Description
    
    200
    
    Returned when successful
    
    429
    
    Returned when number of queries per second too much
    
    Input
    Requirements
    
    = -
    
    Filters
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]

/api/v2/notes/{id}

DELETE /api/v2/notes/{id}
- Delete a single contact note.
- Documentation
- Sandbox
Documentation

Delete a single contact note.

Requirements

Name Requirement Type Description

id int Contact note id

Status Codes
Status Code Description

204

Returned when successful

404

Returned when no contact found
Input
Requirements

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]
GET /api/v2/notes/{id}
- Get a single contact note.
- Documentation
- Sandbox
Documentation

Get a single contact note.

Requirements

Name Requirement Type Description

id int Contact id

Status Codes
Status Code Description

200

Returned when successful

404

Returned when no contact note found
Input
Requirements

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /api/v2/notes/{id}

Update existing contact note.

/api/v2/unsubscribers

GET /api/v2/unsubscribers
- Get all contact have unsubscribed from your communication.
- Documentation
- Sandbox
Documentation

Get all contact have unsubscribed from your communication.

Filters

Name Information

page

Requirement \d+

Description Fetch specified results page

Default 1

limit

Requirement \d+

Description How many results to return

Default 10

Return

Parameter Type Versions Description

id integer *

phone string *

unsubscribeTime DateTime *

firstName string *

lastName string *

Status Codes
Status Code Description

200

Returned when successful
Input
Filters

= -

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v2/unsubscribers

Unsubscribe contact from your communication by phone number.

/api/v2/unsubscribers/{id}
- - GET /api/v2/unsubscribers/{id}
    - Get a single unsubscribed contact.
    - Documentation
    - Sandbox
    Documentation
    
    Get a single unsubscribed contact.
    
    Requirements
    
    Name Requirement Type Description
    
    id int Custom field id
    
    Return
    
    Parameter Type Versions Description
    
    id integer *
    
    phone string *
    
    unsubscribeTime DateTime *
    
    firstName string *
    
    lastName string *
    
    Status Codes
    
    Status Code Description
    
    200
    
    Returned when successful
    
    404
    
    Returned when no unsubscribed contact found
    
    Input
    Requirements
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]

- - DELETE /api/v2/contact/all
    - Delete all contacts.
    - Documentation
    - Sandbox
    Documentation
    
    Delete all contacts.
    
    Status Codes
    
    Status Code Description
    
    204
    
    Returned when successful
    
    Input
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]

Show/hide List Operations Expand Operations

Lists

/api/v2/lists

GET /api/v2/lists

Get all user lists.

Documentation
Sandbox

Documentation

Get all user lists.

Filters

Name

Information

page

Requirement	\d+
Description	Fetch specified results page
Default	1

limit

Requirement	\d+
Description	How many results to return
Default	10

orderBy

Requirement	(id\|name\|membersCount)
Description	Order results by some field. Default is id
Default	id

direction

Requirement	(asc\|desc)
Description	Order direction. Default is desc
Default	desc

favoriteOnly

Requirement	\d
Description	Return only favorite lists
Default	0

onlyMine

Requirement	\d
Description	Return only current user lists
Default	0

Return

Parameter	Type	Versions	Description
name	string	*
description	string	*
favorited	boolean	*
id	integer	*
membersCount	integer	*
user	object (User)	*
user[id]	integer	*
user[username]	string	*
user[firstName]	string	*
user[lastName]	string	*
user[email]	string	*
user[status]	string	*
user[balance]	double	*
user[phone]	string	*
user[company]	string	*
user[currency]	object (Currency)	*
user[currency][unicodeSymbol]	string	*	Get currency symbol
user[currency][id]	string	*
user[currency][htmlSymbol]	string	*
user[country]	object (Country)	*
user[country][id]	string	*
user[country][name]	string	*
user[timezone]	object (Timezone)	*
user[timezone][id]	integer	*
user[timezone][area]	string	*
user[timezone][dst]	integer	*
user[timezone][offset]	integer	*
user[timezone][timezone]	string	*
user[subaccountType]	string	*
user[emailAccepted]	boolean	*
user[phoneAccepted]	boolean	*
user[avatar]	object (UserImage)	*
user[avatar][href]	string	*
service	boolean	*
shared	boolean	*
avatar	object (GroupImage)	*
avatar[href]	string	*
isDefault	boolean	*

Status Codes

Status Code	Description
200	Returned when successful

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v2/lists

Create a new list from the submitted data.

POST /api/v2/lists/delete

Delete list by given ID(s) or delete all lists.

GET /api/v2/lists/search

Find contact lists by given parameters.

Documentation
Sandbox

Documentation

Find contact lists by given parameters.

Filters

Name

Information

page

Requirement	\d+
Description	Fetch specified results page
Default	1

limit

Requirement	\d+
Description	How many results to return
Default	10

ids

Requirement	[,\d]+
Description	Find lists by ID(s)

query

Description

Find contact by specified search query

onlyMine

Requirement	\d
Description	Return only current user lists
Default	0

onlyDefault

Requirement	\d
Description	Return only default lists
Default	0

orderBy

Requirement	(id\|name\|membersCount)
Description	Order results by some field. Default is id
Default	id

direction

Requirement	(asc\|desc)
Description	Order direction. Default is desc
Default	desc

Return

Parameter	Type	Versions	Description
name	string	*
description	string	*
favorited	boolean	*
id	integer	*
membersCount	integer	*
user	object (User)	*
user[id]	integer	*
user[username]	string	*
user[firstName]	string	*
user[lastName]	string	*
user[email]	string	*
user[status]	string	*
user[balance]	double	*
user[phone]	string	*
user[company]	string	*
user[currency]	object (Currency)	*
user[currency][unicodeSymbol]	string	*	Get currency symbol
user[currency][id]	string	*
user[currency][htmlSymbol]	string	*
user[country]	object (Country)	*
user[country][id]	string	*
user[country][name]	string	*
user[timezone]	object (Timezone)	*
user[timezone][id]	integer	*
user[timezone][area]	string	*
user[timezone][dst]	integer	*
user[timezone][offset]	integer	*
user[timezone][timezone]	string	*
user[subaccountType]	string	*
user[emailAccepted]	boolean	*
user[phoneAccepted]	boolean	*
user[avatar]	object (UserImage)	*
user[avatar][href]	string	*
service	boolean	*
shared	boolean	*
avatar	object (GroupImage)	*
avatar[href]	string	*
isDefault	boolean	*

Status Codes

Status Code	Description
200	Returned when successful

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/api/v2/lists/{id}

DELETE /api/v2/lists/{id}

Delete a single list.

GET /api/v2/lists/{id}

Get a single list.

PUT /api/v2/lists/{id}

Update existing list.

Documentation
Sandbox

Documentation

Update existing list.

Requirements

Name	Requirement	Type	Description
id		int	List id

Parameters

Parameter	Type	Required?	Format	Description
name	string	true		List name
shared	choice	false	[false,true]	Should this list be shared with sub-accounts
favorited	choice	false	[false,true]	Optional. Is list favorited. Default is false
isDefault	choice	false	[false,true]	Optional. Is list default for new contacts (web only). Default is false

Return

Parameter	Type	Versions	Description
name	string	*
description	string	*
favorited	boolean	*
id	integer	*
membersCount	integer	*
user	object (User)	*
user[id]	integer	*
user[username]	string	*
user[firstName]	string	*
user[lastName]	string	*
user[email]	string	*
user[status]	string	*
user[balance]	double	*
user[phone]	string	*
user[company]	string	*
user[currency]	object (Currency)	*
user[currency][unicodeSymbol]	string	*	Get currency symbol
user[currency][id]	string	*
user[currency][htmlSymbol]	string	*
user[country]	object (Country)	*
user[country][id]	string	*
user[country][name]	string	*
user[timezone]	object (Timezone)	*
user[timezone][id]	integer	*
user[timezone][area]	string	*
user[timezone][dst]	integer	*
user[timezone][offset]	integer	*
user[timezone][timezone]	string	*
user[subaccountType]	string	*
user[emailAccepted]	boolean	*
user[phoneAccepted]	boolean	*
user[avatar]	object (UserImage)	*
user[avatar][href]	string	*
service	boolean	*
shared	boolean	*
avatar	object (GroupImage)	*
avatar[href]	string	*
isDefault	boolean	*

Status Codes

Status Code	Description
201	Returned when successful
400	Returned when the form has errors
403	Returned when trying to edit list shared to you
404	Returned when no list found

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

/api/v2/lists/{id}/avatar

DELETE /api/v2/lists/{id}/avatar
- Delete an avatar for the list.
- Documentation
- Sandbox
Documentation

Delete an avatar for the list.

Requirements

Name Requirement Type Description

id int Contact id

Status Codes
Status Code Description

204

Returned when successful

403

Returned when trying to edit list shared to current user

404

Returned when no list found
Input
Requirements

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v2/lists/{id}/avatar

Add an avatar for the list.

/api/v2/lists/{id}/contacts

DELETE /api/v2/lists/{id}/contacts
- Unassign contacts from the specified list.
- Documentation
- Sandbox
Documentation

Unassign contacts from the specified list.

Requirements

Name Requirement Type Description

id int List id

Parameters

Parameter Type Required? Format Description

contacts integer true Contact ID(s), separated by comma

Status Codes
Status Code Description

201

Returned when successful

404

Returned when no list found

Returned when no specified contacts assigned to this list
Input
Requirements

= -

Parameters

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/lists/{id}/contacts

Fetch user contacts by given group id.

Documentation
Sandbox

Documentation

Fetch user contacts by given group id. A useful synonym for "contacts/search" command with provided "listId" parameter.

Requirements

Name	Requirement	Type	Description
id		int	List id

Filters

Name

Information

page

Requirement	\d+
Description	Fetch specified results page
Default	1

limit

Requirement	\d+
Description	How many results to return
Default	10

orderBy

Requirement	(id\|firstName\|lastName)
Description	Order results by some field. Default is id
Default	id

direction

Requirement	(asc\|desc)
Description	Order direction. Default is desc
Default	desc

Return

Parameter	Type	Versions	Description
firstName	string	*
lastName	string	*
email	string	*
phone	string	*
companyName	string	*
favorited	boolean	*
id	integer	*
country	object (Country)	*
country[id]	string	*
country[name]	string	*
customFields[]	array of objects (ContactCustomField)	*
customFields[][id]	integer	*
customFields[][name]	string	*
customFields[][createdAt]	DateTime	*
user	object (User)	*
user[id]	integer	*
user[username]	string	*
user[firstName]	string	*
user[lastName]	string	*
user[email]	string	*
user[status]	string	*
user[balance]	double	*
user[phone]	string	*
user[company]	string	*
user[currency]	object (Currency)	*
user[currency][unicodeSymbol]	string	*	Get currency symbol
user[currency][id]	string	*
user[currency][htmlSymbol]	string	*
user[country]	object (Country)	*
user[timezone]	object (Timezone)	*
user[timezone][id]	integer	*
user[timezone][area]	string	*
user[timezone][dst]	integer	*
user[timezone][offset]	integer	*
user[timezone][timezone]	string	*
user[subaccountType]	string	*
user[emailAccepted]	boolean	*
user[phoneAccepted]	boolean	*
user[avatar]	object (UserImage)	*
user[avatar][href]	string	*
lists[]	array of objects (Group)	*
lists[][favorited]	boolean	*
lists[][id]	integer	*
lists[][name]	string	*
lists[][description]	string	*
lists[][membersCount]	integer	*
lists[][user]	object (User)	*
lists[][service]	boolean	*
lists[][shared]	boolean	*
lists[][avatar]	object (GroupImage)	*
lists[][avatar][href]	string	*
lists[][isDefault]	boolean	*
phoneType	string	*
avatar	object (ContactImage)	*
avatar[href]	string	*
notes[]	array of objects (ContactNote)	*
notes[][id]	integer	*
notes[][createdAt]	DateTime	*
notes[][note]	string	*
notes[][user]	object (User)	*

Status Codes

Status Code	Description
200	Returned when successful

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v2/lists/{id}/contacts
- Reset list members to the specified contacts.
- Documentation
- Sandbox
Documentation

Reset list members to the specified contacts.

Requirements

Name Requirement Type Description

id int List id

Parameters

Parameter Type Required? Format Description

contacts integer true Contact ID(s), separated by comma or 'all' to add all contacts belonging to the current user

Status Codes
Status Code Description

201

Returned when successful

400

Returned when no contacts specified

404

Returned when no list found
Input
Requirements

= -

Parameters

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /api/v2/lists/{id}/contacts

Assign contacts to the specified list.

POST /api/v2/lists/{id}/contacts/delete

Delete contact from list by given ID(s) or all contacts from list.

/api/v2/lists/{id}/contacts/ids
- - GET /api/v2/lists/{id}/contacts/ids
    - Fetch all contacts IDs belonging to the list with ID.
    - Documentation
    - Sandbox
    Documentation
    
    Fetch all contacts IDs belonging to the list with ID.
    
    Requirements
    
    Name Requirement Type Description
    
    id int List id
    
    Status Codes
    
    Status Code Description
    
    200
    
    Returned when successful
    
    Input
    Requirements
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]

Show/hide List Operations Expand Operations

Messages

/api/v2/bulks

GET /api/v2/bulks

Get all bulk sending sessions.

/api/v2/bulks/{id}

GET /api/v2/bulks/{id}

Get bulk message session status.

/api/v2/messages

GET /api/v2/messages

Get all user oubound messages.

POST /api/v2/messages

Send a new outbound message.

Documentation
Sandbox

Documentation

Send a new outbound message.

Parameters

Parameter	Type	Required?	Format	Description
text	string	true		Message text. Required if template_id is not set
templateId	string	true		Template used instead of message text. Required if text is not set
sendingTime	string	false		DEPRECATED, consider using sendingDateTime and sendingTimezone parameters instead: Optional (required with rrule set). Message sending time in unix timestamp format. Default is now
sendingDateTime	string	false		Optional. Sending time in Y-m-d H:i:s format (e.g. 2016-05-27 13:02:33). This time is relative to sendingTimezone
sendingTimezone	string	false		Optional. ID or ISO-name of timezone used for sending when sendingDateTime parameter is set. E.g. if you specify sendingTimezone = "2016-05-27 13:02:33" and sendingTimezone = "America/Buenos_Aires", your message will be sent at May 27, 2016 13:02:33 Buenos Aires time, or 16:02:33 UTC. Default is account timezone
contacts	string	true		Array of contact resources id message will be sent to
lists	string	true		Array of list resources id message will be sent to
phones	string	true		Array of E.164 phone numbers message will be sent to
cutExtra	choice	false	[false,true]	Optional. Should sending method cut extra characters which not fit supplied partsCount or return 400 Bad request response instead. Default is false
partsCount	string	false		Optional. Maximum message parts count (TextMagic allows sending 1 to 6 message parts). Default is 6
referenceId	string	false		Optional. Custom message reference id which can be used in your application infrastructure
from	string	false		Optional. One of allowed Sender ID (phone number or alphanumeric sender ID). If specified Sender ID is not allowed for some destinations, a fallback default Sender ID will be used to ensure delivery
rrule	string	false		Optional. iCal RRULE parameter to create recurrent scheduled messages. When used, sendingTime is mandatory as start point of sending
tts	choice	false	[false,true]	Optional. Send Text to Speech message. Default is false
local	choice	false	[false,true]	Optional. Treat phone numbers passed in 'phones' field as local. Default is false
localCountry	string	false		Optional. 2-letter ISO country code for local phone numbers, used when 'local' is set to true. Default is account country

Status Codes

Status Code	Description
201	Returned when successful
202	Returned when bulk session has been created
400	Returned when the form has errors

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v2/messages/delete

Delete outbound messages by given ID(s) or delete all outbound messages.

GET /api/v2/messages/preview

Get messages preview (with tags merged) up to 100 messages per session.

Documentation
Sandbox

Documentation

Get messages preview (with tags merged) up to 100 messages per session.

Parameters

Parameter	Type	Required?	Format	Description
text	string	true		Message text. Required if template_id is not set
templateId	string	true		Template used instead of message text. Required if text is not set
sendingTime	string	false		DEPRECATED, consider using sendingDateTime and sendingTimezone parameters instead: Optional (required with rrule set). Message sending time in unix timestamp format. Default is now
sendingDateTime	string	false		Optional. Sending time in Y-m-d H:i:s format (e.g. 2016-05-27 13:02:33). This time is relative to sendingTimezone
sendingTimezone	string	false		Optional. ID or ISO-name of timezone used for sending when sendingDateTime parameter is set. E.g. if you specify sendingTimezone = "2016-05-27 13:02:33" and sendingTimezone = "America/Buenos_Aires", your message will be sent at May 27, 2016 13:02:33 Buenos Aires time, or 16:02:33 UTC. Default is account timezone
contacts	string	true		Array of contact resources id message will be sent to
lists	string	true		Array of list resources id message will be sent to
phones	string	true		Array of E.164 phone numbers message will be sent to
cutExtra	choice	false	[false,true]	Optional. Should sending method cut extra characters which not fit supplied partsCount or return 400 Bad request response instead. Default is false
partsCount	string	false		Optional. Maximum message parts count (TextMagic allows sending 1 to 6 message parts). Default is 6
referenceId	string	false		Optional. Custom message reference id which can be used in your application infrastructure
from	string	false		Optional. One of allowed Sender ID (phone number or alphanumeric sender ID). If specified Sender ID is not allowed for some destinations, a fallback default Sender ID will be used to ensure delivery
rrule	string	false		Optional. iCal RRULE parameter to create recurrent scheduled messages. When used, sendingTime is mandatory as start point of sending
tts	choice	false	[false,true]	Optional. Send Text to Speech message. Default is false
local	choice	false	[false,true]	Optional. Treat phone numbers passed in 'phones' field as local. Default is false
localCountry	string	false		Optional. 2-letter ISO country code for local phone numbers, used when 'local' is set to true. Default is account country

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when the form has errors

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/messages/price

Check pricing for a new outbound message.

Documentation
Sandbox

Documentation

Check pricing for a new outbound message.

Filters

Name

Information

includeBlocked

Requirement	(0\|1)
Description	Should we show pricing for the blocked contacts. Default is false
Default	0

Parameters

Parameter	Type	Required?	Format	Description
text	string	true		Message text. Required if template_id is not set
templateId	string	true		Template used instead of message text. Required if text is not set
sendingTime	string	false		DEPRECATED, consider using sendingDateTime and sendingTimezone parameters instead: Optional (required with rrule set). Message sending time in unix timestamp format. Default is now
sendingDateTime	string	false		Optional. Sending time in Y-m-d H:i:s format (e.g. 2016-05-27 13:02:33). This time is relative to sendingTimezone
sendingTimezone	string	false		Optional. ID or ISO-name of timezone used for sending when sendingDateTime parameter is set. E.g. if you specify sendingTimezone = "2016-05-27 13:02:33" and sendingTimezone = "America/Buenos_Aires", your message will be sent at May 27, 2016 13:02:33 Buenos Aires time, or 16:02:33 UTC. Default is account timezone
contacts	string	true		Array of contact resources id message will be sent to
lists	string	true		Array of list resources id message will be sent to
phones	string	true		Array of E.164 phone numbers message will be sent to
cutExtra	choice	false	[false,true]	Optional. Should sending method cut extra characters which not fit supplied partsCount or return 400 Bad request response instead. Default is false
partsCount	string	false		Optional. Maximum message parts count (TextMagic allows sending 1 to 6 message parts). Default is 6
referenceId	string	false		Optional. Custom message reference id which can be used in your application infrastructure
from	string	false		Optional. One of allowed Sender ID (phone number or alphanumeric sender ID). If specified Sender ID is not allowed for some destinations, a fallback default Sender ID will be used to ensure delivery
rrule	string	false		Optional. iCal RRULE parameter to create recurrent scheduled messages. When used, sendingTime is mandatory as start point of sending
tts	choice	false	[false,true]	Optional. Send Text to Speech message. Default is false
local	choice	false	[false,true]	Optional. Treat phone numbers passed in 'phones' field as local. Default is false
localCountry	string	false		Optional. 2-letter ISO country code for local phone numbers, used when 'local' is set to true. Default is account country

Status Codes

Status Code	Description
200	Returned when successful
400	Returned when the form has errors

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/messages/prices
- Get message prices for all countries.
- Documentation
- Sandbox
Documentation

Get message prices for all countries.

Status Codes
Status Code Description

200

Returned when successful
Input

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/messages/search

Find outbound messages by given parameters.

/api/v2/messages/attachment
- - POST /api/v2/messages/attachment
    - Upload a new file to insert it as a link.
    - Documentation
    - Sandbox
    Documentation
    
    Upload a new file to insert it as a link.
    
    Parameters
    
    Parameter Type Required? Format Description
    
    file file true Attachment. Supports .jpg, .gif, .png, .pdf, .txt, .csv, .doc, .docx, .xls, .xlsx, .ppt, .pptx & .vcf file formats
    
    Status Codes
    
    Status Code Description
    
    201
    
    Returned when successful
    
    400
    
    Returned when the form has errors
    
    Input
    Parameters
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]

/api/v2/messages/{id}

DELETE /api/v2/messages/{id}
- Delete a single message.
- Documentation
- Sandbox
Documentation

Delete a single message.

Requirements

Name Requirement Type Description

id int Message id

Status Codes
Status Code Description

204

Returned when successful

404

Returned when no message found
Input
Requirements

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/messages/{id}

Get a single outgoing message.

/api/v2/replies

GET /api/v2/replies

Get all inbox messages.

POST /api/v2/replies/delete

Delete inbound messages by given ID(s) or delete all inbound messages.

GET /api/v2/replies/search

Find inbound messages by given parameters.

/api/v2/replies/{id}
- - DELETE /api/v2/replies/{id}
    - Delete the incoming message.
    - Documentation
    - Sandbox
    Documentation
    
    Delete the incoming message.
    
    Requirements
    
    Name Requirement Type Description
    
    id int Incoming message id
    
    Status Codes
    
    Status Code Description
    
    204
    
    Returned when successful
    
    404
    
    Returned when no message found
    
    Input
    Requirements
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]
  - GET /api/v2/replies/{id}
    - Get a single inbox message.
    - Documentation
    - Sandbox
    Documentation
    
    Get a single inbox message.
    
    Requirements
    
    Name Requirement Type Description
    
    id int Incoming message id
    
    Return
    
    Parameter Type Versions Description
    
    id integer *
    
    sender string *
    
    messageTime DateTime *
    
    text string *
    
    receiver string *
    
    Status Codes
    
    Status Code Description
    
    200
    
    Returned when successful
    
    404
    
    Returned when no message found
    
    Input
    Requirements
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]

/api/v2/schedules

GET /api/v2/schedules

Get all scheduled messages.

POST /api/v2/schedules/delete

Delete scheduled messages by given ID(s) or delete all scheduled messages.

GET /api/v2/schedules/search

Find scheduled messages by given parameters.

/api/v2/schedules/{id}

DELETE /api/v2/schedules/{id}
- Delete a message session, together with all nested messages.
- Documentation
- Sandbox
Documentation

Delete a message session, together with all nested messages.

Requirements

Name Requirement Type Description

id int Session id

Status Codes
Status Code Description

204

Returned when successful

404

Returned when no session found
Input
Requirements

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/schedules/{id}

Get message schedule.

/api/v2/sessions

GET /api/v2/sessions

Get all message sending sessions.

POST /api/v2/sessions/delete

Delete messages sessions, together with all nested messages, by given ID(s) or delete all messages sessions.

/api/v2/sessions/{id}

DELETE /api/v2/sessions/{id}
- Delete a message session, together with all nested messages.
- Documentation
- Sandbox
Documentation

Delete a message session, together with all nested messages.

Requirements

Name Requirement Type Description

id int Session id

Status Codes
Status Code Description

204

Returned when successful

404

Returned when no session found
Input
Requirements

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/sessions/{id}

Get a message session.

GET /api/v2/sessions/{id}/messages

Fetch messages by given session id.

GET /api/v2/sessions/{id}/stat
- Get sending session statistics.
- Documentation
- Sandbox
Documentation

Get sending session statistics.

Requirements

Name Requirement Type Description

id int Session id

Filters

Name Information

includeDeleted

Requirement (0|1)

Description Include also deleted messages

Default 0

Status Codes
Status Code Description

200

Returned when successful
Input
Requirements

= -

Filters

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/history

Get outbound messages history.

DELETE /api/v2/message/all
- Delete all messages.
- Documentation
- Sandbox
Documentation

Delete all messages.

Status Codes
Status Code Description

204

Returned when successful
Input

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

Show/hide List Operations Expand Operations

Surveys

/api/v2/surveys
- - GET /api/v2/surveys
    - Get all user surveys.
    - Documentation
    - Sandbox
    Documentation
    
    Get all user surveys.
    
    Filters
    
    Name Information
    
    page
    
    Requirement \d+
    
    Description Fetch specified results page
    
    Default 1
    
    limit
    
    Requirement \d+
    
    Description How many results to return
    
    Default 10
    
    Return
    
    Parameter Type Versions Description
    
    Status Codes
    
    Status Code Description
    
    200
    
    Returned when successful
    
    Input
    Filters
    
    = -
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]
  - POST /api/v2/surveys
    - Create a new survey from the submitted data.
    - Documentation
    - Sandbox
    Documentation
    
    Create a new survey from the submitted data.
    
    Parameters
    
    Parameter Type Required? Format Description
    
    name string true Survey name
    
    Status Codes
    
    Status Code Description
    
    201
    
    Returned when successful
    
    400
    
    Returned when the form has errors
    
    Input
    Parameters
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]

/api/v2/surveys/nodes/merge
- - POST /api/v2/surveys/nodes/merge
    - Merge two question nodes.
    - Documentation
    - Sandbox
    Documentation
    
    Merge two question nodes.
    
    Parameters
    
    Parameter Type Required? Format Description
    
    firstNode string true First node id
    
    secondNode string true Second node id
    
    Status Codes
    
    Status Code Description
    
    204
    
    Returned when successful
    
    400
    
    Returned when the form has errors
    
    Input
    Parameters
    
    = -
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]

/api/v2/surveys/nodes/{id}

DELETE /api/v2/surveys/nodes/{id}
- Delete a node.
- Documentation
- Sandbox
Documentation

Delete a node.

Requirements

Name Requirement Type Description

id int Node id

Status Codes
Status Code Description

204

Returned when successful

404

Returned when no survey found
Input
Requirements

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]
GET /api/v2/surveys/nodes/{id}
- Get a node by id.
- Documentation
- Sandbox
Documentation

Get a node by id.

Requirements

Name Requirement Type Description

id int Node id

Status Codes
Status Code Description

200

Returned when successful

404

Returned when no message found
Input
Requirements

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /api/v2/surveys/nodes/{id}

Update existing node.

/api/v2/surveys/{id}

DELETE /api/v2/surveys/{id}
- Delete a survey.
- Documentation
- Sandbox
Documentation

Delete a survey.

Requirements

Name Requirement Type Description

id int Survey id

Status Codes
Status Code Description

204

Returned when successful

404

Returned when no survey found
Input
Requirements

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]
GET /api/v2/surveys/{id}
- Get a survey by id.
- Documentation
- Sandbox
Documentation

Get a survey by id.

Requirements

Name Requirement Type Description

id int Survey id

Return

Parameter Type Versions Description

Status Codes
Status Code Description

200

Returned when successful

404

Returned when no message found
Input
Requirements

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /api/v2/surveys/{id}

Update existing survey.

/api/v2/surveys/{id}/cancel
- - PUT /api/v2/surveys/{id}/cancel
    - Cancel a survey.
    - Documentation
    - Sandbox
    Documentation
    
    Cancel a survey.
    
    Requirements
    
    Name Requirement Type Description
    
    id int Node id
    
    Return
    
    Parameter Type Versions Description
    
    Status Codes
    
    Status Code Description
    
    201
    
    Returned when successful
    
    422
    
    Returned when survey is in unprocessable status (only ACTIVE surveys are accepted)
    
    404
    
    Returned when no survey found
    
    Input
    Requirements
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]

/api/v2/surveys/{id}/duplicate
- - PUT /api/v2/surveys/{id}/duplicate
    - Duplicate a survey.
    - Documentation
    - Sandbox
    Documentation
    
    Duplicate a survey.
    
    Requirements
    
    Name Requirement Type Description
    
    id int Node id
    
    Return
    
    Parameter Type Versions Description
    
    Status Codes
    
    Status Code Description
    
    201
    
    Returned when successful
    
    422
    
    Returned when survey is in unprocessable status
    
    404
    
    Returned when no survey found
    
    Input
    Requirements
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]

/api/v2/surveys/{id}/nodes

GET /api/v2/surveys/{id}/nodes
- Fetch nodes by given survey id.
- Documentation
- Sandbox
Documentation

Fetch nodes by given survey id.

Requirements

Name Requirement Type Description

id int Survey id

Status Codes
Status Code Description

200

Returned when successful
Input
Requirements

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v2/surveys/{id}/nodes

Create a new node from the submitted data.

/api/v2/surveys/{id}/preview

PUT /api/v2/surveys/{id}/preview

Preview a survey.

/api/v2/surveys/{id}/reset
- - PUT /api/v2/surveys/{id}/reset
    - Reset a survey flow.
    - Documentation
    - Sandbox
    Documentation
    
    Reset a survey flow.
    
    Requirements
    
    Name Requirement Type Description
    
    id int Node id
    
    Return
    
    Parameter Type Versions Description
    
    Status Codes
    
    Status Code Description
    
    201
    
    Returned when successful
    
    422
    
    Returned when survey is in unprocessable status
    
    404
    
    Returned when no survey found
    
    Input
    Requirements
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]

/api/v2/surveys/{id}/start

PUT /api/v2/surveys/{id}/start

Start a survey.

Show/hide List Operations Expand Operations

Templates

/api/v2/templates

GET /api/v2/templates
- Get all user templates.
- Documentation
- Sandbox
Documentation

Get all user templates.

Filters

Name Information

page

Requirement \d+

Description Fetch specified results page

Default 1

limit

Requirement \d+

Description How many results to return

Default 10

Return

Parameter Type Versions Description

name string *

id integer *

content string *

lastModified DateTime *

Status Codes
Status Code Description

200

Returned when successful
Input
Filters

= -

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]
POST /api/v2/templates
- Create a new template from the submitted data.
- Documentation
- Sandbox
Documentation

Create a new template from the submitted data.

Parameters

Parameter Type Required? Format Description

name string true Template name

content string true Template text. May contain tags inside braces

Status Codes
Status Code Description

201

Returned when successful

400

Returned when the form has errors
Input
Parameters

= -

= -

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v2/templates/delete

Delete template by given ID(s) or delete all templates.

GET /api/v2/templates/search

Find user templates by given parameters.

/api/v2/templates/{id}
- - DELETE /api/v2/templates/{id}
    - Delete a single template.
    - Documentation
    - Sandbox
    Documentation
    
    Delete a single template.
    
    Requirements
    
    Name Requirement Type Description
    
    id int Template id
    
    Return
    
    Parameter Type Versions Description
    
    name string *
    
    id integer *
    
    content string *
    
    lastModified DateTime *
    
    Status Codes
    
    Status Code Description
    
    204
    
    Returned when successful
    
    404
    
    Returned when no template found
    
    Input
    Requirements
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]
  - GET /api/v2/templates/{id}
    - Get a single template.
    - Documentation
    - Sandbox
    Documentation
    
    Get a single template.
    
    Requirements
    
    Name Requirement Type Description
    
    id int Template id
    
    Return
    
    Parameter Type Versions Description
    
    name string *
    
    id integer *
    
    content string *
    
    lastModified DateTime *
    
    Status Codes
    
    Status Code Description
    
    200
    
    Returned when successful
    
    404
    
    Returned when no template found
    
    Input
    Requirements
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]
  - PUT /api/v2/templates/{id}
    - Update existing template.
    - Documentation
    - Sandbox
    Documentation
    
    Update existing template.
    
    Requirements
    
    Name Requirement Type Description
    
    id int Template id
    
    Parameters
    
    Parameter Type Required? Format Description
    
    name string true Template name
    
    content string true Template text. May contain tags inside braces
    
    Return
    
    Parameter Type Versions Description
    
    name string *
    
    id integer *
    
    content string *
    
    lastModified DateTime *
    
    Status Codes
    
    Status Code Description
    
    201
    
    Returned when successful
    
    400
    
    Returned when the form has errors
    
    404
    
    Returned when no template found
    
    Input
    Requirements
    
    = -
    
    Parameters
    
    = -
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]

Show/hide List Operations Expand Operations

User

/api/v2/auth

POST /api/v2/auth

Authenticate user by given username and password.

/api/v2/callback/settings

GET /api/v2/callback/settings
- Fetch callback URL settings
- Documentation
- Sandbox
Documentation

Fetch callback URL settings

Status Codes
Status Code Description

200

Returned when successful
Input

Headers
= -

Content
= Replaces header if set
Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

PUT /api/v2/callback/settings

Update callback URL settings

/api/v2/countries
- - GET /api/v2/countries
    - Return list of countries.
    - Documentation
    - Sandbox
    Documentation
    
    Return list of countries.
    
    Status Codes
    
    Status Code Description
    
    200
    
    Returned when successful
    
    Input
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]

/api/v2/invoices
- - GET /api/v2/invoices
    - Return account invoices.
    - Documentation
    - Sandbox
    Documentation
    
    Return account invoices.
    
    Filters
    
    Name Information
    
    page
    
    Requirement \d+
    
    Description Fetch specified results page
    
    Default 1
    
    limit
    
    Requirement \d+
    
    Description How many results to return
    
    Default 10
    
    Return
    
    Parameter Type Versions Description
    
    id integer *
    
    bundle integer *
    
    currency string *
    
    vat float *
    
    paymentMethod string *
    
    Status Codes
    
    Status Code Description
    
    200
    
    Returned when successful
    
    403
    
    Returned when current user is not allowed to manage invoices
    
    Input
    Filters
    
    = -
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set
    
    Request URL
    
    Response Headers [Expand] [Profiler]
    
    Response Body [Raw]

/api/v2/numbers

GET /api/v2/numbers

Get all dedicated numbers.

POST /api/v2/numbers

Buy a dedicated number and assign it to the specified account.

GET /api/v2/numbers/available

Find available dedicated numbers to buy.

/api/v2/numbers/{id}
- - DELETE /api/v2/numbers/{id}
    - Cancel dedicated number subscription.
    - Documentation
    - Sandbox
    Documentation
    
    Cancel dedicated number subscription.
    
    Requirements
    
    Name Requirement Type Description
    
    id int Dedicated number id
    
    Status Codes
    
    Status Code Description
    
    204
    
    Returned when successful
    
    404
    
    Returned when no number found
    
    Input
    Requirements
    
    = -
    
    Headers
    = -
    
    Content
    = Replaces header if set

Status Code	Description
400	Returned when invalid phone number specified
200	Returned when successful

Parameter	Type	Required?	Format	Description
inbound_ids	string	true		Inbound messages ID(s) to delete. Require when "all" equal to 0 (false).
sent_ids	string	true		Sent messages ID(s) to delete. Require when "all" equal to 0 (false).
calls_ids	string	true		Calls ID(s) to delete. Require when "all" equal to 0 (false).
all	choice	true	[0,1]	Optional. Default is 0 (false). If set to 1 all the entities will be removed.

Parameter	Type	Required?	Description
file	file	true	File containing contacts
column[]	array of strings	true	Column values mapping (number column => field), e.g. column[0] = "phone", column[1] = "firstName"
listName	string	true	List name. This list will be created during import. If such name is already taken, an ordinal (1, 2, ...) will be added to the end
listId	string	true	List ID contacts will be imported to

Status Code	Description
204	Returned when successful
403	Returned when trying to delete contact shared to you
404	Returned when no contact found

Parameter	Type	Versions	Description
note	string	*
id	integer	*
createdAt	DateTime	*
user	object (User)	*
user[id]	integer	*
user[username]	string	*
user[firstName]	string	*
user[lastName]	string	*
user[email]	string	*
user[status]	string	*
user[balance]	double	*
user[phone]	string	*
user[company]	string	*
user[currency]	object (Currency)	*
user[currency][unicodeSymbol]	string	*	Get currency symbol
user[currency][id]	string	*
user[currency][htmlSymbol]	string	*
user[country]	object (Country)	*
user[country][id]	string	*
user[country][name]	string	*
user[timezone]	object (Timezone)	*
user[timezone][id]	integer	*
user[timezone][area]	string	*
user[timezone][dst]	integer	*
user[timezone][offset]	integer	*
user[timezone][timezone]	string	*
user[subaccountType]	string	*
user[emailAccepted]	boolean	*
user[phoneAccepted]	boolean	*
user[avatar]	object (UserImage)	*
user[avatar][href]	string	*

Status Code	Description
204	Returned when successful
404	Returned when no custom field found

Parameter	Type	Versions
address	string	*
suggestion	string	*
preference	integer	*
risk	string	*
emailRole	string	*
reason	string	*
status	string	*
deliverability	string	*
isDisposableAddress	boolean	*
addressType	string	*
localPart	string	*
domainPart	string	*
exchange	string	*
isInWhiteList	boolean	*
isInBlackList	boolean	*
hasMx	boolean	*
hasAa	boolean	*
hasAaaa	boolean	*

Parameter	Type	Versions
cost	double	*
local	string	*
type	string	*
carrier	string	*
number164	string	*
valid	boolean	*

Status Code	Description
200	Returned when successful
429	Returned when number of queries per second too much

Status Code	Description
200	Returned when successful
404	Returned when no contact note found

Status Code	Description
201	Returned when successful
400	Returned when the form has errors
403	Returned when trying to edit contact note shared to current user
404	Returned when no contact found

Status Code	Description
200	Returned when successful
404	Returned when no unsubscribed contact found

Status Code	Description
204	Returned when successful
400	Returned when trying to remove list associated with signup form
403	Returned when trying to remove list shared to you
404	Returned when no contact found

Status Code	Description
201	Returned when successful
404	Returned when no list found Returned when no specified contacts assigned to this list

Status Code	Description
201	Returned when successful
400	Returned when no contacts specified
404	Returned when no list found

Status Code	Description
200	Returned when successful
404	Returned when no bulk session found

Parameter	Type	Versions
id	integer	*
receiver	string	*
messageTime	DateTime	*
status	string	*
text	string	*
deleted	string	*
charset	string	*
firstName	string	*
lastName	string	*
country	string	*
sender	string	*
price	float	*
partsCount	integer	*

Status Code	Description
204	Returned when successful
404	Returned when no message found

Parameter	Type	Versions
id	integer	*
nextSend	DateTime	*
rrule	string	*
session	object (MessageSession)	*
session[id]	integer	*
session[startTime]	DateTime	*
session[text]	string	*
session[source]	string	*
session[referenceId]	string	*
session[price]	float	*
session[numbersCount]	integer	*
session[destination]	string	*
lastSent	DateTime	*
createdAt	DateTime	*

Status Code	Description
204	Returned when successful
404	Returned when no session found

API documentation

Chats

/api/v2/chats

GET /api/v2/chats

Documentation

Filters

Return

Status Codes

Filters

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v2/chats/close/bulk

Documentation

Parameters

Status Codes

Parameters

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v2/chats/close/read

Documentation

Status Codes

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v2/chats/delete

Documentation

Parameters

Status Codes

Parameters

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v2/chats/mute

Documentation

Parameters

Status Codes

Parameters

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v2/chats/mute/bulk

Documentation

Parameters

Status Codes

Parameters

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v2/chats/read/bulk

Documentation

Parameters

Status Codes

Parameters

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

POST /api/v2/chats/reopen/bulk

Documentation

Parameters

Status Codes

Parameters

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/chats/search

Documentation

Filters

Return

Status Codes

Filters

Request URL

Response Headers [Expand] [Profiler]

Response Body [Raw]

GET /api/v2/chats/search/ids

Documentation

Filters

Return

Status Codes

Status Code	Description
200	Returned when successful
404	Returned when no schedule found

Parameter	Type	Versions
id	integer	*
startTime	DateTime	*
text	string	*
source	string	*
referenceId	string	*
price	float	*
numbersCount	integer	*
destination	string	*

Parameter	Type	Required?	Format	Description
firstNode	string	true		First node id
secondNode	string	true		Second node id

Parameter	Type	Required?	Format	Description
label	string	true		Node label
body	string	true		Node body
isEndNode	choice	false	[false,true]	Optional. Define node is ending for survey. Default is false
sendDelay	string	true		Optional. Define delay for sending question to recipients after previous answer. Default is 0

Status Code	Description
201	Returned when successful
400	Returned when the form has errors
404	Returned when no template found

Status Code	Description
201	Returned when successful
422	Returned when survey is in unprocessable status (only ACTIVE surveys are accepted)
404	Returned when no survey found

Parameter	Type	Required?	Format	Description
nodeType	choice	true	{"Question":"q","Answer":"a"}	Node type
label	string	true		Node label
body	string	true		Node body
startNode	string	true		Start node id
sendDelay	string	true		Optional. Define delay for sending question to recipients after previous answer. Default is 0

Parameter	Type	Required?	Description
username	string	true	Account username or email
password	string	true	Account password
appName	string	true	Optional. Application name
appVersion	string	true	Optional. Application version
deviceId	string	true	Optional. Device ID for push notification service
pushServiceType	string	true	Optional, required when deviceId provided. Push notification service type: a for Apple Push Notifications, g for Google Cloud Messaging
tfaCode	string	true	Optional, required when 2FA enabled on account. 2FA challenge response (SMS code or security question answer)
tfaId	string	true	Optional, required when 2FA enabled on account and security question answer is provided

Parameter	Type	Required?	Description
outUrl	string	true	Callback URL for delivery notifications
inUrl	string	true	Callback URL for incoming messages
format	choice	true	Callback data format: m for multipart/form-data, u for application/x-www-form-urlencoded, j for JSON

Parameter	Type	Versions
id	integer	*
bundle	integer	*
currency	string	*
vat	float	*
paymentMethod	string	*