Text Messages

The Text Messages API provides a read-only access to text messages.

Properties

Attribute Description
associated_deal_ids array readonly

An array of ids of deals associated to the text message.

content string readonly

Content of the text message.

created_at string readonly

Date and time of creation in UTC (ISO8601 format).

id number readonly

Unique identifier of the text message.

incoming boolean readonly

Indicator of whether the text message was incoming or not.

resource_id number readonly

Unique identifier of the resource the text message is attached to.

resource_type string readonly

Name of the resource type the text message is attached to.

Possible values:

  • lead
  • contact
  • none
resource_phone_number string readonly

Phone number of a resource the text message was sent to/received by.

sent_at string readonly

Date and time of the message send time in UTC (ISO8601 format).

user_id number readonly

Phone number of a user who sent/received a text message.

user_phone_number string readonly

Phone number of a user who sent/received a text message.

updated_at string readonly

Date and time of the last update in UTC (ISO8601 format).


Endpoints


Retrieve all text messages

Returns Text Messages, according to the parameters provided.

Parameters

Attribute Description
page number optional

Page number to start from. Page numbering starts at 1 and omitting the page parameter will return the first page. Maximum page that can be returned is 1000.

e.g. ?page=2
per_page number optional

Number of records to return per page. The default limit is 25 and the maximum number that can be returned is 100.

e.g. ?per_page=20
ids string optional

Comma-separated list of text message IDs to be returned in request.

e.g. ?ids=1,2,3
resource_type string optional

Name of the type of a resource text messages are attached to. Requires also resource_id to be specified

Possible values:

  • lead
  • contact
e.g. ?resource_type=lead
resource_id number optional

Unique identifier of a resource text messages are attached to. Requires also resource_type to be specified

e.g. ?resource_id=7
sort_by string optional

A field to sort by. Default ordering is descending. If you want to change the sort ordering to ascending, append :asc to the field e.g. sort_by=id:desc

Possible values:

  • id
e.g. ?sort_by=id:asc

Retrieve a single text message

Returns a single text message available to the user, according to the unique text message ID provided. If the specified text message does not exist, this query returns an error.

Parameters

Attribute Description
id number required

Unique identifier of the text message.