Skip to main content
POST
Add Contacts to a List

Add Contacts to a List

Adds up to 100 existing contacts to a list. A contact already on the list stays as it is. Adding a contact starts the automations that follow this list (Automations page, trigger Added to a list) for that contact. Each contact goes through an automation once, so calling this again for the same contact starts nothing twice. This is how another system starts a Gomry flow: create or find the contact, then add it to the list the automation follows. Required scopes: lists:read and contacts:write (adding writes the contact)

Path Parameters

string
required

Body

string[]
required
Contact ids, from 1 to 100. Ids that are not contacts of your organization are returned in invalid_contact_ids and skipped.

Response

string
integer
How many of the given contacts are on the list after the call.
string[]
Ids that were skipped.

Errors

  • 400 the body is not { "contact_ids": [...] } with 1 to 100 ids
  • 404 the list is not one of your organization’s
  • 422 none of the ids are contacts of your organization