Create a group

POST /api/v1/group

Personal access token & OAuth2

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

200 application/json
Hide response attributes Show response attributes object
- uuid string
  
  UUID of the group
- name string
  
  Name of the group
- slug string
  
  Slug of the group
- participants_count string
  
  Number of participants in the group
- participants object
  
  Participants in this group
  
  Additional properties are allowed.
- created_at string
  
  Timestamp of when the group was created
- updated_at string
  
  Timestamp of when the group was updated

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":["cc366794-36b8-4279-9a16-c4f419daf01c","50597f17-1aef-48ce-8f40-ef114f58492a"]}'

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": [
    "cc366794-36b8-4279-9a16-c4f419daf01c",
    "50597f17-1aef-48ce-8f40-ef114f58492a"
  ]
}

Response examples (200)

{
  "name": "finance",
  "slug": "finance",
  "uuid": "902f609c-8b06-470b-ad63-ced3d445344d",
  "created_at": "2025-02-20T10:13:02+00:00",
  "updated_at": "2025-02-20T10:13:02+00:00",
  "participants": {
    "name": {
      "example": "Gareth Thompson",
      "description": "Name of the account"
    },
    "role": {
      "example": "client",
      "description": "Role of the account"
    },
    "uuid": {
      "example": "7091895f-43e1-480a-897a-cfe5f38c11c4",
      "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"
}