Update a group

PUT /api/v1/group/{uuid}
Personal access token & O auth2

Path parameters

application/json

Body Required

  • name string Required

    Group name that must be unique.

Responses

PUT /api/v1/group/{uuid} 
curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/group/uuid' \
 --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"}'
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"
}
Response examples (200) 
{
  "name": "finance",
  "slug": "finance",
  "uuid": "9cc4b4cf-f589-4101-b408-36ce358a74fd",
  "created_at": "2025-05-14T18:27:12+01:00",
  "updated_at": "2025-05-14T18:27:12+01:00",
  "participants": {
    "name": {
      "example": "Gareth Thompson",
      "description": "Name of the account"
    },
    "role": {
      "example": "client",
      "description": "Role of the account"
    },
    "uuid": {
      "example": "76ebaf81-0835-4114-8ad6-524d7af59997",
      "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"
}