Contact

Import contacts

Creates and/or updates up to 200 contacts in a single API call. When creating or updating a large number of contacts, this method is significantly faster than sending a separate API request for each contact.

By default, if the phone number for any contact matches an existing contact, the existing contact will be updated with any information provided. This behavior can be modified by setting the lookup_key parameter to look up contacts by another field, including a custom variable.

If any contact was not found matching the provided lookup_key, a new contact will be created.

post/v1/projects/{project_id}/import_contacts

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/import_contacts
  • 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

Request body

lookup_key'phone_number' | 'id' | 'vars.variable_name' | 'none'

The field used to search for a matching contact, or 'none' to always create a new contact. To search by a custom variable, precede the variable name with 'vars.'.

add_group_idsstring

ID of one or more groups to add these contacts as members (max 5)

remove_group_idsstring

ID of one or more groups to remove these contacts as members (max 5)

default_route_idstring

ID of the route to use by default to send messages to these contacts

Response

Successful response

Changes

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