Create a group

POST /api/v1/group

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
POST /api/v1/group 
curl \
 -X POST https://api.plannrcrm.com/api/v1/group \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 -d '{"name":"Accounting","participants":["6b28ebe1-1417-4d12-b427-fd2bdb5a7524","adc8e2a3-41ae-4144-8ce7-d372c42ea35b"]}'
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": [
    "6b28ebe1-1417-4d12-b427-fd2bdb5a7524",
    "adc8e2a3-41ae-4144-8ce7-d372c42ea35b"
  ]
}
Response examples (200) 
{
  "name": "finance",
  "slug": "finance",
  "uuid": "8e417ca7-d06b-473f-b905-59f76c88196d",
  "created_at": "2024-11-20T13:24:01+00:00",
  "updated_at": "2024-11-20T13:24:01+00:00",
  "participants": {
    "name": {
      "example": "Gareth Thompson",
      "description": "Name of the account"
    },
    "role": {
      "example": "client",
      "description": "Role of the account"
    },
    "uuid": {
      "example": "7bcbedde-8a39-4afc-bb8e-7670c94a68cc",
      "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"
}