Update a circle

PUT /api/v1/circles/{uuid}
Personal access token & OAuth2

Path parameters

application/json

Body

  • name string

    Circle name

  • account_uuids array[string]

    Account UUIDs belonging to the circle. Between 2 and 50 account UUIDs are required.

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • name string

      The Circle name

    • accounts array[object]

      Accounts belonging to the circle

      Additional properties are allowed.

    • groups array[object]

      Groups the circle belongs to

      Additional properties are allowed.
PUT /api/v1/circles/{uuid} 
curl \
 --request PUT https://api.plannrcrm.com/api/v1/circles/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":"Jones Family","account_uuids":[null,null]}'
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": "Jones Family",
  "account_uuids": [
    null,
    null
  ]
}
Response examples (200) 
{
  "name": "Jones Family",
  "uuid": "d67107c4-a133-48b6-9804-a4139c475ba0",
  "groups": [
    {
      "name": "finance",
      "slug": "finance",
      "uuid": "28372355-3f97-4b09-983e-efcd9ec6f4df",
      "created_at": "2025-02-20T10:13:01+00:00",
      "updated_at": "2025-02-20T10:13:01+00:00",
      "participants": {
        "name": {
          "example": "Gareth Thompson",
          "description": "Name of the account"
        },
        "role": {
          "example": "client",
          "description": "Role of the account"
        },
        "uuid": {
          "example": "beea6178-f187-48fe-8e1b-c6446a8b21e4",
          "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"
    }
  ],
  "accounts": [
    {
      "name": "Gareth Thompson",
      "role": "client",
      "type": "client",
      "uuid": "55e842cb-1612-49e9-be75-1fa3aa34b521",
      "email": "gareth@codepotato.co.uk",
      "last_name": "Thompson",
      "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
      "created_at": "2025-02-20T10:13:01+00:00",
      "first_name": "Gareth",
      "updated_at": "2025-02-20T10:13:01+00:00",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
    }
  ],
  "created_at": "2025-02-20T10:13:01+00:00",
  "updated_at": "2025-02-20T10:13:01+00:00"
}