Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
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.
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": "d82d8c71-ea4b-4b2d-b4e7-c992a22b8dc6",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "b702c200-9a25-4821-a394-c2a293c7174d",
"created_at": "2025-04-22T13:44:16+01:00",
"updated_at": "2025-04-22T13:44:16+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "c669e93d-c81c-4c89-b284-cb47b9cfcc27",
"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": "92435fa8-559c-4836-a04b-e9135b01820a",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-04-22T13:44:16+01:00",
"first_name": "Gareth",
"updated_at": "2025-04-22T13:44:16+01:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"created_at": "2025-04-22T13:44:16+01:00",
"updated_at": "2025-04-22T13:44:16+01:00",
"joint_account_uuid": "3889bee4-2098-43b0-975d-e34fb560413c"
}