Create a circle

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

Headers

  • X-PLANNR-ACCOUNT-UUID string
application/json

Body Required

  • name string Required

    Circle name

  • bg_colour string

    Hex colour for avatar background

  • account_uuids array[string] Required

    Account UUIDs that are being added to the circle. Between 1 and 100 account UUIDs are required.

  • group_uuids array[string] Required

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

Responses

  • 201 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
      • 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
POST /api/v1/circles 
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/circles' \
 --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":[null,null],"group_uuids":[null,null]}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Jones Family",
  "bg_colour": "#DDDDDD",
  "account_uuids": [
    null,
    null
  ],
  "group_uuids": [
    null,
    null
  ]
}
Response examples (201) 
{
  "name": "Jones Family",
  "uuid": "0af810d4-0903-4190-a784-46264c3ace5f",
  "groups": [
    {
      "name": "finance",
      "slug": "finance",
      "uuid": "01d47a8f-1c05-4612-865f-b9d00b3b18b2",
      "created_at": "2025-09-12T09:45:50+01:00",
      "updated_at": "2025-09-12T09:45:50+01:00",
      "participants": {
        "name": {
          "example": "Gareth Thompson",
          "description": "Name of the account"
        },
        "role": {
          "example": "client",
          "description": "Role of the account"
        },
        "uuid": {
          "example": "63aa408a-8120-489e-af24-5188b04968ca",
          "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": "a20a410f-8cf2-47c9-8dbc-ae3cfd857b99",
      "email": "gareth@codepotato.co.uk",
      "last_name": "Thompson",
      "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
      "created_at": "2025-09-12T09:45:50+01:00",
      "first_name": "Gareth",
      "updated_at": "2025-09-12T09:45:50+01:00",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
    }
  ],
  "bg_colour": "#35f4e1",
  "photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
  "created_at": "2025-09-12T09:45:50+01:00",
  "updated_at": "2025-09-12T09:45:50+01:00",
  "joint_account_uuid": "6126f995-1b4c-4d5d-8bb5-cf994c511afc",
  "login_access_level": "write",
  "external_references": [
    {
      "uuid": "8eb46dc7-3d94-4eef-b38b-5531730c310b",
      "reference": "AB123456",
      "created_at": "2025-09-12T09:45:50+01:00",
      "updated_at": "2025-09-12T09:45:50+01:00",
      "third_party": "nucleus"
    }
  ]
}