Rename a contact group - Ocoya API Docs

Renames a group.

PATCH

https://www.app.ocoya.com/api/_public/v1/contacts/groups/{groupId}

Rename a contact group

cURL

curl --request PATCH \
  --url https://www.app.ocoya.com/api/_public/v1/contacts/groups/{groupId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>"
}
'

{
  "id": "<string>",
  "name": "<string>"
}

Authorizations

X-API-Keystringheaderrequired

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

Path Parameters

groupIdstringrequired

Group ID, from GET /contacts/groups.

Example:"cmwdke1w70043y0k4ffzsa6om"

Query Parameters

brandIdstringrequired

Ocoya brand ID. Get one from GET /brands.

Example:"cmayvq3hk00017apshay5qezu"

Body

application/json

namestringrequired

Response

200application/json

Renamed

idstring

namestring

Rename a contact group

cURL

curl --request PATCH \
  --url https://www.app.ocoya.com/api/_public/v1/contacts/groups/{groupId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>"
}
'

{
  "id": "<string>",
  "name": "<string>"
}

Was this page helpful?