Update a group

PUT /api/v1/group/{uuid}

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

uuid string Required

application/json

Body Required

name string Required

Group name that must be unique.

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

PUT /api/v1/group/{uuid}

curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/group/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"name":"Accounting"}'

Request examples

# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Accounting"
}

Response examples (200)

{
  "name": "finance",
  "slug": "finance",
  "uuid": "a7dea831-fb87-4eb2-862d-18caf739248d",
  "created_at": "2025-08-27T17:31:26+01:00",
  "updated_at": "2025-08-27T17:31:26+01:00",
  "participants": {
    "name": {
      "example": "Gareth Thompson",
      "description": "Name of the account"
    },
    "role": {
      "example": "client",
      "description": "Role of the account"
    },
    "uuid": {
      "example": "5c8cbdf8-b241-4a80-876e-cbb1165bd006",
      "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"
}