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": "8ba72491-5ffd-4ec4-ac96-f3b0475e4c36",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "a1399a43-4c9b-4118-88d3-99db8829a4c3",
"created_at": "2025-08-01T13:01:35+01:00",
"updated_at": "2025-08-01T13:01:35+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "c2b23ff1-45de-44c8-b88c-7ed57579a085",
"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": "46146e09-6d5c-45c2-b3c7-8dffd0c1b765",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-08-01T13:01:35+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-01T13:01:35+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-01T13:01:35+01:00",
"updated_at": "2025-08-01T13:01:35+01:00",
"joint_account_uuid": "d9b45ecc-1238-4f1c-b5ba-01d0a136ea36",
"external_references": [
{
"uuid": "3f83fe8d-3c9f-45ee-b5f3-d0ae242e5721",
"reference": "AB123456",
"created_at": "2025-08-01T13:01:35+01:00",
"updated_at": "2025-08-01T13:01:35+01:00",
"third_party": "nucleus"
}
]
}