Skip to main content

Add numbers to a group

POST 
/api/v1/group/addNumbers

This endpoint lets you add contacts to your groups. Each number in numbers is added as a new contact: an existing contact with the same number is not updated or merged. Numbers that are invalid or blocked are skipped and not counted in the response. For larger sets of numbers, you can upload them in bulk using a CSV file.

Request​

Body

Contact information to add to the specified group.

    groupIdstring

    Provide the ID of the contact group that you want to add numbers to.

    numbers object[]

    Provide the contact information you want to add to the group. Each entry is added as a new contact, also when the group already has a contact with the same number.

  • Array [
    • _numberstringrequired

    The phone number of the contact, including the country code. Use the international format (e.g., +1234567890).

    Firstnamestring

    The first name of the contact.

    Lastnamestring

    The last name of the contact.

  • ]
    • csvstring

    The raw CSV data containing contact information for bulk import.

    csvFormatstring[]

    Defines the header names in your CSV file, which should correspond to the contact fields.

    clearListboolean

    Controls whether to remove existing contacts from the group before adding the new ones. Defaults to false, meaning existing contacts will be kept. It has no effect when testMode is true.

    testModeboolean

    Enables test mode for this request, as a dry run: if set to true, nothing is added to the group and clearList doesn't empty it. The numbers are still validated, and the response tells you how many would be added: N numbers would be added to group (testmode).

Responses​

The phone numbers were successfully added to the contact group.