Authorization: Bearer {API_TOKEN} header.
List your groups
Retrieve all contact groups on your account.Get contacts in a group
Retrieve all contacts belonging to a specific group. Replace{groupid} with the numeric ID of the group.
Create a group
Create a new contact group by providing a name, and optionally an identifier and description.Parameters
Display name for the new group.
A unique identifier for the group.
A short description of the group.
Add a single contact
Add one contact to your list. You can optionally assign them to an existing group at creation time.Parameters
Full name of the contact.
Phone number of the contact. Accepts 11-digit local format, country code without plus, or with plus.
ID of the group to assign this contact to. Omit to save the contact without a group.
Add multiple contacts
Import a batch of contacts in a single request by passing an array of contact objects.Parameters
Array of contact objects. Each object accepts the same
name, phone, and optional group_id fields as the single-contact endpoint.Update a contact
Update the details of an existing contact. Replace{contactid} with the contact’s numeric ID.
Success response
All Contacts API endpoints return the following on success:Using contacts in messages
Once you have created contacts and groups, you can reference them directly in your SMS and Truecaller send requests:
- Use the
contactparameter with a contact ID to send to a specific saved contact. - Use the
groupparameter with a group ID to send to all contacts in that group.
