Change many contacts - Ocoya API Docs

One action on up to 5000 contacts: add_to_groups (groups, by name), remove_from_groups (groupIds), unsubscribe or delete.

POST

https://www.app.ocoya.com/api/_public/v1/contacts/bulk

Change many contacts

cURL

curl --request POST \
  --url https://www.app.ocoya.com/api/_public/v1/contacts/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "ids": [
    "<string>"
  ],
  "action": "add_to_groups",
  "groups": [
    "<string>"
  ],
  "groupIds": [
    "<string>"
  ]
}
'

{
  "action": "<string>",
  "count": 123
}

Authorizations

X-API-Keystringheaderrequired

Your API key. Create one in Ocoya. Authorization: Bearer <key> works too.

Query Parameters

brandIdstringrequired

Ocoya brand ID. Get one from GET /brands.

Example:"cmayvq3hk00017apshay5qezu"

Body

application/json

idsstring[]required

actionenum<string>required

Available options: add_to_groups, remove_from_groups, unsubscribe, delete

groupsstring[]

groupIdsstring[]

Response

200application/json

Done

actionstring

countinteger

Change many contacts

cURL

curl --request POST \
  --url https://www.app.ocoya.com/api/_public/v1/contacts/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "ids": [
    "<string>"
  ],
  "action": "add_to_groups",
  "groups": [
    "<string>"
  ],
  "groupIds": [
    "<string>"
  ]
}
'

{
  "action": "<string>",
  "count": 123
}

Was this page helpful?