API reference · Contacts

Create a group

Create a group, then add people with POST /v1/contacts/groups/{id}/members.

POST/v1/contacts/groups

Bearer API key
Rate limit 120 / min
Returns 201 Created
Needs the Contacts permission · free

POST /v1/contacts/groups

curl https://api.talks.africa/v1/contacts/groups \
  -H "Authorization: Bearer $TALKS_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Loyal customers",
    "description": "Bought 3+ times"
  }'

{
  "id": "grp_loyal",
  "name": "Loyal customers",
  "contact_count": 0
}

Use a tk_test_ key while you build. Nothing is sent and no credits are used.

Body parameters

namestringrequired
Group name.
descriptionstringoptional
What it is for.

Response fieldsResponse

id
Group ID
contact_count
Members

Errors

Tap one to see its response above.

All errors use the standard error object. Select one to see its response.

Was this page helpful?