Sign in

v1

latestOpenAPI 3.0.02026-08-067074272.5 KB
Contacts

Create or update a contact with the given phone number

Creates or updates a contact (depending on whether one already exists with the given phone number).

post/dashboards/{dashboard_id}/contacts/{phone_number}

Path parameters

dashboard_idinteger required
Example:121

Id of dashboard

phone_numberstring required

Phone number

Request body

first_namestring

The contact's first name.

last_namestring

The contact's last name.

display_namestring

The contact's display name.

is_suppressedboolean

Whether the contact is suppressed.

is_archivedboolean

Whether the contact is archived.

is_blockedboolean

Whether the contact is blocked.

suppressed_reasonstring

For notekeeping, a reason why the contact was suppressed.

notestring

Any text notes for the contact.

groupsinteger[]

An array of group identifiers that reference group membership.

contact_tagsstring[]

An array of contact tag unique identifiers that reference tags that should be attached to this contact. This argument is optional and can be omitted or set to null. An empty array will remove all tags from the contact.

is_resolvedboolean

Whether or not their conversation thread is currently resolved.

Example request

{
  "first_name": "John",
  "last_name": "Smith",
  "display_name": "John Smith",
  "note": "Contact from newsletter.",
  "custom_fields": [
    {
      "id": "cc63eb7d-3575-478f-b42e-1e64e40d41c9",
      "value": "john.doe@gmail.com"
    }
  ]
}

Response

The new/updated contact.

phone_numberstring

The contact's phone number.

first_namestring

The contact's first name.

last_namestring

The contact's last name.

display_namestring

The contact's display name.

thread_idstring

The id of the thread for this contact's conversation on this dashboard. To access the thread of this contact in the webapp, go to https://app.textrequest.com/app/thread/<thread_id>

is_suppressedboolean

Whether the contact is suppressed.

is_archivedboolean

Whether the contact is archived.

is_blockedboolean

Whether the contact is blocked.

suppressed_reasonstring

For notekeeping, a reason why the contact was suppressed.

notestring

Any text notes for the contact.

groupsinteger[]

An array of group identifiers that reference group membership.

contact_tagsstring[]

An array of the contact's tags.

is_resolvedboolean

Whether or not their conversation thread is currently resolved.

first_contact_utcstring

When the contact was first messaged. All dates are UTC.

opted_out_utcstring

When the contact opted out. Null if the contact has not and can receive messages.

last_msg_sent_utcstring date-time

When the contact was last sent a message.

last_msg_received_utcstring date-time

When this dashboard last received a message from a contact.

total_msgs_sentinteger

Total messages sent to a contact.

total_msgs_receivedinteger

Total messages received from a contact.

response_countinteger

Total number of response messages from the contact.

date_created_utcstring date-time

When the contact was created.

last_contact_date_utcstring date-time

When the contact was last contacted.

last_messageobject

Last message sent to or from this contact.

Example response

{
  "phone_number": "13216547890",
  "first_name": "John",
  "last_name": "Smith",
  "display_name": "John Smith",
  "thread_id": "166382ad-72ce-466a-bc64-ce5247905e43",
  "suppressed_reason": "Contact asked not to be texted.",
  "note": "Lead from newsletter",
  "groups": [
    12,
    26
  ],
  "contact_tags": [
    "a8608167-caf8-485c-a0c5-d97fb0fc9069",
    "54b35406-189d-4e70-a170-c87e231f8ca3"
  ],
  "custom_fields": [
    {
      "id": "cc63eb7d-3575-478f-b42e-1e64e40d41c9",
      "value": "john.doe@gmail.com"
    }
  ]
}