Contact

Update contact details

Updates writable fields on the given contact

post/v1/projects/{project_id}/contacts/{id}

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/contacts/{id}
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://telerivet.com/oauth/authorize, token URL https://api.telerivet.com/oauth/token)

Path parameters

project_idstring required

ID of the Project

idstring required

ID of the Contact

Request body

namestring

Name of the contact

phone_numberstring

Phone number of the contact

send_blockedboolean

True if Telerivet is blocked from sending messages to this contact

conversation_status'closed' | 'active' | 'handled'

Current status of the conversation with this contact

default_route_idstring

ID of the basic route (phone) or custom route that Telerivet will use by default to send messages to this contact (null if using project default route)

varsobject

Custom variables stored for this contact. Variable names may be up to 32 characters in length and can contain the characters a-z, A-Z, 0-9, and _. Values may be strings, numbers, or boolean (true/false). String values may be up to 4096 bytes in length when encoded as UTF-8. Up to 100 variables are supported per object. Setting a variable to null will delete the variable.

Example request

{
  "name": "John Smith",
  "phone_number": "+16505550123",
  "conversation_status": "active"
}

Response

Successful response

idstring

ID of the contact

namestring

Name of the contact

phone_numberstring

Phone number of the contact

time_createdinteger

Time the contact was added in Telerivet

time_updatedinteger

Time the contact was last updated in Telerivet

send_blockedboolean

True if Telerivet is blocked from sending messages to this contact

conversation_status'closed' | 'active' | 'handled'

Current status of the conversation with this contact

last_message_timeinteger nullable

Last time the contact sent or received a message (null if no messages have been sent or received)

last_incoming_message_timeinteger nullable

Last time a message was received from this contact

last_outgoing_message_timeinteger nullable

Last time a message was sent to this contact

message_countinteger

Total number of non-deleted messages sent to or received from this contact

incoming_message_countinteger

Number of messages received from this contact

outgoing_message_countinteger

Number of messages sent to this contact

last_message_idstring

ID of the last message sent to or received from this contact (null if no messages have been sent or received)

default_route_idstring

ID of the basic route (phone) or custom route that Telerivet will use by default to send messages to this contact (null if using project default route)

group_idsstring[]

List of IDs of groups that this contact belongs to

varsobject

Custom variables stored for this contact. Variable names may be up to 32 characters in length and can contain the characters a-z, A-Z, 0-9, and _. Values may be strings, numbers, or boolean (true/false). String values may be up to 4096 bytes in length when encoded as UTF-8. Up to 100 variables are supported per object. Setting a variable to null will delete the variable.

project_idstring

ID of the project this contact belongs to

urlstring

URL to this contact in the Telerivet web app

Example response

{
  "id": "CTa1299c3d0e371023",
  "name": "John Smith",
  "phone_number": "+16505550123",
  "time_created": 1390348075,
  "time_updated": 1390348099,
  "conversation_status": "active",
  "last_message_time": 1395881121,
  "last_incoming_message_time": 1395881121,
  "last_outgoing_message_time": 1395881032,
  "message_count": 13,
  "incoming_message_count": 2,
  "outgoing_message_count": 11,
  "last_message_id": "SM97f47ac232df154d",
  "project_id": "PJ2ad0100821a98bea",
  "url": "https://telerivet.com/p/asdf/contact/CTa1299c3d0e371023"
}

Changes

No recorded changes to this operation across all 1 revision of this API.