Skip to Content
My App
Api

Contact Group

Organise contacts into groups: create groups, list them, and add or remove members — handy for targeting broadcasts and campaigns.

GET /api/v1/contact-groups — list groups with member counts

GET
/contact-groups

Authorization

http
headerAuthorizationBearer <token>

Response Body

application/json
  1. response
data*array<string>
meta*
Example Request
curl -X GET 'https://aexrux.com/api/v1/contact-groups'
Example Response200
{  "data": [    "string"  ],  "meta": {    "count": 0  }}

POST /api/v1/contact-groups — create a group

POST
/contact-groups

Authorization

http
headerAuthorizationBearer <token>

Request Body

application/json
  1. body

Create a contact group in the current workspace. Scramble reads these rules to document the request body. Mirrors ContactsController::groupStore.

name*string

Group name. Required.

Lengthlength <= 191
note?|

Optional note/description for the group.

Lengthlength <= 500
color?|

Optional UI colour (hex or token, e.g. #2563eb).

Lengthlength <= 32

Response Body

application/json
  1. response
data*array<unknown>
meta*string
Example Request
curl -X POST 'https://aexrux.com/api/v1/contact-groups' \  -H 'Content-Type: application/json' \  -d '{  "name": "string"}'
Example Response
{  "data": [    null  ],  "meta": "string"}

DELETE /api/v1/contact-groups/{id} — delete a group + detach it

DELETE
/contact-groups/{id}

Authorization

http
headerAuthorizationBearer <token>

Path Parameters

id*integer

Response Body

application/json
  1. response
data*
meta*string
Example Request
curl -X DELETE 'https://aexrux.com/api/v1/contact-groups/0'
Example Response
{  "data": {    "id": 0,    "deleted": true  },  "meta": "string"}

Contact

Full create / read / update / delete over your contacts and leads, including search by number, tags and custom attributes.

Conversation

Read your workspace inbox across EVERY channel: list chat threads (each with its `channel` and the customer id) and fetch the messages inside a thread — WhatsApp, Facebook, Instagram and Telegram alike.