PUT
/api/v1/circles/{uuid}
curl \
--request PUT 'https://api.plannrcrm.com/api/v1/circles/6ff8f7f6-1eb3-3525-be4a-3932c805afed' \
--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 (200)
{
"name": "Jones Family",
"uuid": "20a1e3c1-ff7a-4941-a492-c0a3ada3c1be",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "eb2eebe9-260d-43d8-b78c-7bf18d5fcdc0",
"created_at": "2025-08-07T13:41:38+01:00",
"updated_at": "2025-08-07T13:41:38+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "aa6cedb9-387d-4f2c-9f27-8ebbd1877386",
"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": "624be79b-29b1-4811-abbe-9b21a20eeed5",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-08-07T13:41:38+01:00",
"first_name": "Gareth",
"updated_at": "2025-08-07T13:41:38+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-07T13:41:38+01:00",
"updated_at": "2025-08-07T13:41:38+01:00",
"joint_account_uuid": "722329b9-1fcc-4985-b3ca-6e9abc63432a",
"external_references": [
{
"uuid": "04187388-46fc-43b0-8252-bb86063d6e90",
"reference": "AB123456",
"created_at": "2025-08-07T13:41:38+01:00",
"updated_at": "2025-08-07T13:41:38+01:00",
"third_party": "nucleus"
}
]
}