Skip to main content
POST
/
groups
/
create
cURL
curl --request POST \
  --url https://api.crunchz.app/api/groups/create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Group Name",
  "participants": [
    {
      "id": "[email protected]"
    }
  ],
  "tag_ids": [
    "tag-uuid-1",
    "tag-uuid-2"
  ]
}
'
{
  "success": true,
  "message": "<string>",
  "data": {
    "id": "<string>",
    "name": "<string>",
    "restricted": true,
    "created_at": "<string>",
    "is_community": true,
    "actions": {
      "join_approval": true,
      "can_add_member": true
    },
    "participant_count": 123
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required

The Group Name

Required string length: 1 - 25
Example:

"Group Name"

​
participants
object[]
Maximum array length: 256
​
tag_ids
string[]

The Auto-Responder Tag IDs

Maximum array length: 10

The Auto-Responder Tag ID

Required string length: 1 - 50
Example:
["tag-uuid-1", "tag-uuid-2"]

Response

CreateGroupResource

​
success
boolean
required

The success status of response.

​
message
string
required

The message of response.

​
data
object
required