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

Headers

  • X-PLANNR-ACCOUNT-UUID string

Path parameters

  • uuid string Required
application/json

Body

  • name string

    Circle name

  • bg_colour string

    Hex colour for avatar background

  • account_uuids array[string(uuid)]

    Account UUIDs belonging to the circle. Between 1 and 100 account UUIDs are required.

  • accounts array[object]

    List of accounts - required without account_uuids

    Hide accounts attributes Show accounts attributes object
    • uuid string(uuid)

      uuid of account

    • login_access_level string | null

      Access level of the login

      Value Description
      read Read
      write Write

      Values are read or write.

  • group_uuids array[string(uuid)]

    Groups UUIDs the circle will belong to. Can belong to a maximum of 50 groups.

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

    • photo_url string

      URL for initial avatar image

    • bg_colour string

      Hex colour background for avatar

    • accounts array[object]

      Accounts belonging to the circle

      Hide accounts attributes Show accounts attributes object
      • uuid string
      • created_at string
      • updated_at string
      • type string
      • role string
      • first_name string
      • last_name string
      • name string
      • email string
      • photo_url string
      • firm string
      • primary_phone_number string
      • primary_email string
      • current_time_entry string
      • assigned_adviser string
      • assigned_administrator string
      • assigned_paraplanner string
      • introduced_by string
      • groups string
      • tags string
      • owners string
      • first_contact_date string
      • next_review_date string
      • previous_review_date string
      • anniversary_review_date string
      • with_login boolean
      • has_joint_account boolean
      • can_be_deleted string
      • joint_account_circle string
      • circles string
      • ownership_percentage integer
      • inactive_at string
      • last_interaction_at string
      • referral_code string
      • permissions object
        Hide permissions attributes Show permissions attributes object
        • firm:read array[string]
        • network:read array[string]
      • custom_fields string
      • external_references string
    • groups array[object]

      Groups the circle belongs to

      Hide groups attributes Show groups attributes object
      • uuid string
      • name string
      • slug string
      • participants_count string
      • participants object
        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
      • updated_at string
    • joint_account_uuid string

      uuid of joint account where circle created from joint account

    • login_access_level string

      The access level in context of an account. Note this field is only returned when using the accounts API. Available values: read and write

    • external_references array[object]

      The external references that have been added to the client.

      Hide external_references attributes Show external_references attributes object
      • uuid string
      • created_at string
      • updated_at string
      • third_party string
      • reference string
PUT /api/v1/circles/{uuid} 
curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/circles/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":"Jones Family","bg_colour":"#DDDDDD","account_uuids":["c347f381-ffaf-4bd7-99c5-74300aed9ded","8cfa57c3-dc4f-4d5c-adad-6690d5511ef2","940ecc95-fb33-44f0-a118-048491725fe2"],"accounts":[{"uuid":"f28e9e5f-4bcc-4dc2-9ed4-8aef084bb04c","login_access_level":"read"}],"group_uuids":["59e28ae4-dc13-4052-989e-bdeb2d84763d","a8b3f689-1944-4925-9e63-f4d2b2895ec0","532d72c3-15fc-4471-b3ab-63f16f736c85"]}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Jones Family",
  "bg_colour": "#DDDDDD",
  "account_uuids": [
    "c347f381-ffaf-4bd7-99c5-74300aed9ded",
    "8cfa57c3-dc4f-4d5c-adad-6690d5511ef2",
    "940ecc95-fb33-44f0-a118-048491725fe2"
  ],
  "accounts": [
    {
      "uuid": "f28e9e5f-4bcc-4dc2-9ed4-8aef084bb04c",
      "login_access_level": "read"
    }
  ],
  "group_uuids": [
    "59e28ae4-dc13-4052-989e-bdeb2d84763d",
    "a8b3f689-1944-4925-9e63-f4d2b2895ec0",
    "532d72c3-15fc-4471-b3ab-63f16f736c85"
  ]
}
Response examples (200) 
{
  "name": "Jones Family",
  "uuid": "33a8e0e5-9e91-4581-9a75-11bcf752a99d",
  "groups": [
    {
      "name": "finance",
      "slug": "finance",
      "uuid": "f3162fd7-9fab-4a7f-abd6-c99bb5f1b913",
      "created_at": "2026-04-09T17:35:05+01:00",
      "updated_at": "2026-04-09T17:35:05+01:00",
      "participants": {
        "name": {
          "example": "Gareth Thompson",
          "description": "Name of the account"
        },
        "role": {
          "example": "client",
          "description": "Role of the account"
        },
        "uuid": {
          "example": "3e310261-9e36-40af-908a-95ab9454d55e",
          "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": [
    {
      "firm": "App\\Http\\Resources\\FirmResource",
      "name": "Gareth Thompson",
      "role": "client",
      "tags": "App\\Http\\Resources\\TagResource",
      "type": "client",
      "uuid": "f4124e03-5545-42af-8a6f-3f32cb7261a9",
      "email": "gareth@codepotato.co.uk",
      "groups": "App\\Http\\Resources\\GroupResource",
      "owners": "App\\Http\\Resources\\AccountResource",
      "circles": "App\\Http\\Resources\\CircleResource",
      "last_name": "Thompson",
      "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
      "created_at": "2026-04-09T17:35:05+01:00",
      "first_name": "Gareth",
      "updated_at": "2026-04-09T17:35:05+01:00",
      "with_login": true,
      "inactive_at": "2026-04-09",
      "permissions": {
        "firm:read": [
          "firm"
        ],
        "network:read": [
          "network:uuid"
        ]
      },
      "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
      "introduced_by": "App\\Http\\Resources\\AccountResource",
      "primary_email": "App\\Http\\Resources\\ContactDetailResource",
      "referral_code": "ABC12345",
      "can_be_deleted": "false",
      "assigned_adviser": "App\\Http\\Resources\\AccountResource",
      "next_review_date": "2026-04-09T17:35:05+01:00",
      "has_joint_account": true,
      "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
      "first_contact_date": "2026-04-09T17:35:05+01:00",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
      "last_interaction_at": "2026-04-09 17:35:05",
      "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
      "joint_account_circle": "App\\Http\\Resources\\CircleResource",
      "ownership_percentage": 100,
      "previous_review_date": "2026-04-09T17:35:05+01:00",
      "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
      "assigned_administrator": "App\\Http\\Resources\\AccountResource",
      "anniversary_review_date": "2026-04-09T17:35:05+01:00"
    }
  ],
  "bg_colour": "#35f4e1",
  "photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
  "created_at": "2026-04-09T17:35:05+01:00",
  "updated_at": "2026-04-09T17:35:05+01:00",
  "joint_account_uuid": "76d941ae-8e6f-4136-91a5-c67caca4b3b4",
  "login_access_level": "write",
  "external_references": [
    {
      "uuid": "89fc5ff8-f773-4e88-bc90-14226991643c",
      "reference": "AB123456",
      "created_at": "2026-04-09T17:35:05+01:00",
      "updated_at": "2026-04-09T17:35:05+01:00",
      "third_party": "nucleus"
    }
  ]
}