Create a circle

POST /api/v1/circles

Personal access token & O auth2

Headers

application/json

Body Required

name string Required

Circle name
account_uuids array[string] Required

Account UUIDs that are being added to the circle. Between 2 and 50 account UUIDs are required.
group_uuids array[string] Required

Groups UUIDs the circle will belong to.

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
- accounts array[object]
  
  Accounts belonging to the circle
- groups array[object]
  
  Groups the circle belongs to
- joint_account_uuid string
  
  uuid of joint account where circle created from joint account

POST /api/v1/circles

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/circles' \
 --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],"group_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
  ],
  "group_uuids": [
    null,
    null
  ]
}

Response examples (201)

{
  "name": "Jones Family",
  "uuid": "2f85d4eb-ea79-4e1b-b2f4-6aa8038ca7ac",
  "groups": [
    {
      "name": "finance",
      "slug": "finance",
      "uuid": "3be96585-d21d-4dba-9c2b-e6cbbe5a51cb",
      "created_at": "2025-04-02T13:27:54+01:00",
      "updated_at": "2025-04-02T13:27:54+01:00",
      "participants": {
        "name": {
          "example": "Gareth Thompson",
          "description": "Name of the account"
        },
        "role": {
          "example": "client",
          "description": "Role of the account"
        },
        "uuid": {
          "example": "ca41c6b0-ea7c-4708-a176-2796c48f43c1",
          "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": "0f4709d9-3fe4-4d77-90d3-42b413573644",
      "email": "gareth@codepotato.co.uk",
      "last_name": "Thompson",
      "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
      "created_at": "2025-04-02T13:27:54+01:00",
      "first_name": "Gareth",
      "updated_at": "2025-04-02T13:27:54+01:00",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
    }
  ],
  "created_at": "2025-04-02T13:27:54+01:00",
  "updated_at": "2025-04-02T13:27:54+01:00",
  "joint_account_uuid": "285f6061-39a2-40bf-b592-2eecebc6732d"
}