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": "c3b5aa81-7bea-4760-a951-5a2708b14ff0",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "824a1b86-14e8-41ea-8af7-ec401c080a66",
"created_at": "2025-08-22T17:15:40+01:00",
"updated_at": "2025-08-22T17:15:40+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "37b2162d-322e-4692-b5bb-9af9e8383c66",
"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": "3b4b8ff6-2ab1-46a4-901a-efece8256721",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-08-22T17:15:40+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-22T17:15:40+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-08-22T17:15:40+01:00",
"updated_at": "2025-08-22T17:15:40+01:00",
"joint_account_uuid": "30c82283-bb83-4876-b79a-3b5e83c5a2db",
"login_access_level": "write",
"external_references": [
{
"uuid": "3d9cc8d8-a475-468d-872b-375cd6ba61c0",
"reference": "AB123456",
"created_at": "2025-08-22T17:15:40+01:00",
"updated_at": "2025-08-22T17:15:40+01:00",
"third_party": "nucleus"
}
]
}