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": "a412d497-04c7-47f8-957e-96af3dfe5220",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "0509a6f8-1245-4237-9b2a-eb9614f84500",
"created_at": "2025-10-23T11:47:55+01:00",
"updated_at": "2025-10-23T11:47:55+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "008501c6-1497-4e4c-a3cb-9477a71b4cd8",
"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": "e6e6fa43-3c2e-444d-9418-4d465f13c5f7",
"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": "2025-10-23T11:47:55+01:00",
"first_name": "Gareth",
"updated_at": "2025-10-23T11:47:55+01:00",
"with_login": true,
"inactive_at": "2025-10-23",
"custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
"introduced_by": "App\\Http\\Resources\\AccountResource",
"primary_email": "App\\Http\\Resources\\ContactDetailResource",
"can_be_deleted": "false",
"assigned_adviser": "App\\Http\\Resources\\AccountResource",
"next_review_date": "2025-10-23T11:47:55+01:00",
"has_joint_account": true,
"current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
"first_contact_date": "2025-10-23T11:47:55+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource",
"assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
"joint_account_circle": "App\\Http\\Resources\\CircleResource",
"ownership_percentage": 100,
"previous_review_date": "2025-10-23T11:47:55+01:00",
"primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
"assigned_administrator": "App\\Http\\Resources\\AccountResource",
"anniversary_review_date": "2025-10-23T11:47:55+01:00"
}
],
"bg_colour": "#35f4e1",
"photo_url": "https://eu.ui-avatars.com/api/?name=jones+family",
"created_at": "2025-10-23T11:47:55+01:00",
"updated_at": "2025-10-23T11:47:55+01:00",
"joint_account_uuid": "9da29741-4730-4c85-a431-a5fa0d9b202b",
"login_access_level": "write",
"external_references": [
{
"uuid": "d1a97d42-573b-4bfa-bab9-4691242af4ff",
"reference": "AB123456",
"created_at": "2025-10-23T11:47:55+01:00",
"updated_at": "2025-10-23T11:47:55+01:00",
"third_party": "nucleus"
}
]
}