Create a group

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

Headers

  • X-PLANNR-ACCOUNT-UUID string
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

      Hide participants attributes Show participants attributes object
      • uuid object
        Hide uuid attributes Show uuid attributes object
        • example string
        • description string
      • role object
        Hide role attributes Show role attributes object
        • example string
        • description string
      • first_name object
        Hide first_name attributes Show first_name attributes object
        • example string
        • description string
      • last_name object
        Hide last_name attributes Show last_name attributes object
        • example string
        • description string
      • name object
        Hide name attributes Show name attributes object
        • example string
        • description string
      • email object
        Hide email attributes Show email attributes object
        • example string
        • description string
    • 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 $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"name":"Accounting","participants":["c2d7d420-c033-4ade-806d-c7dff7198675","cee3ad4e-21a1-404d-8961-60ca01eaa9a5"]}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Accounting",
  "participants": [
    "c2d7d420-c033-4ade-806d-c7dff7198675",
    "cee3ad4e-21a1-404d-8961-60ca01eaa9a5"
  ]
}
Response examples (200) 
{
  "name": "finance",
  "slug": "finance",
  "uuid": "4a9c806f-68c2-457e-9d76-7c7d01be3522",
  "created_at": "2025-06-26T11:37:05+01:00",
  "updated_at": "2025-06-26T11:37:05+01:00",
  "participants": {
    "name": {
      "example": "Gareth Thompson",
      "description": "Name of the account"
    },
    "role": {
      "example": "client",
      "description": "Role of the account"
    },
    "uuid": {
      "example": "432cf64b-915f-4686-a25b-5adbea01be5d",
      "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"
}