Create a group

POST /api/v1/group
Personal access token & O auth2

Headers

application/json

Body Required

  • name string Required

    Group name that must be unique.

  • participants array[string]

    UUIDs of accounts to add to the group.

Responses

POST /api/v1/group 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/group' \
 --header "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 --header "Content-Type: application/json" \
 --header "Accept: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"name":"Accounting","participants":["e8530bbe-cbb5-4386-a0f0-211f4806e3e3","bdddd7a8-1757-4e51-92d9-aa28e004d4ae"]}'
Request examples 
# Headers
Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}
Content-Type: application/json
Accept: application/json
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Accounting",
  "participants": [
    "e8530bbe-cbb5-4386-a0f0-211f4806e3e3",
    "bdddd7a8-1757-4e51-92d9-aa28e004d4ae"
  ]
}
Response examples (200) 
{
  "name": "finance",
  "slug": "finance",
  "uuid": "49214202-603f-4fcb-9b80-b2569e2c90c9",
  "created_at": "2025-04-02T13:27:55+01:00",
  "updated_at": "2025-04-02T13:27:55+01:00",
  "participants": {
    "name": {
      "example": "Gareth Thompson",
      "description": "Name of the account"
    },
    "role": {
      "example": "client",
      "description": "Role of the account"
    },
    "uuid": {
      "example": "376010f7-9849-4198-8d32-8684775664e4",
      "description": "UUID of the account"
    },
    "email": {
      "example": "gareth@codepotato.co.uk",
      "description": "Email of the account"
    },
    "last_name": {
      "example": "Thompson",
      "description": "Last name of the account"
    },
    "first_name": {
      "example": "Gareth",
      "description": "First name of the account"
    }
  },
  "participants_count": "3"
}