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

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":["7164b3fa-fad3-4919-a468-f5cf4de907d6","d8c8fadc-e47f-485f-99bd-ce723d4e08f5"]}'
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": [
    "7164b3fa-fad3-4919-a468-f5cf4de907d6",
    "d8c8fadc-e47f-485f-99bd-ce723d4e08f5"
  ]
}
Response examples (200) 
{
  "name": "finance",
  "slug": "finance",
  "uuid": "d6c10e42-1b22-4902-98ef-7e1713526298",
  "created_at": "2024-10-16T11:10:14+01:00",
  "updated_at": "2024-10-16T11:10:14+01:00",
  "participants": {
    "name": {
      "example": "Gareth Thompson",
      "description": "Name of the account"
    },
    "role": {
      "example": "client",
      "description": "Role of the account"
    },
    "uuid": {
      "example": "c09dbdda-5bb6-445a-ad2c-057fead99985",
      "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"
}