Create a circle
Headers
-
Content-Type string
-
Accept string
-
X-PLANNR-ACCOUNT-UUID string
Body Required
-
Circle name
-
Account UUIDs that are being added to the circle. Between 2 and 50 account UUIDs are required.
-
Groups UUIDs the circle will belong to.
POST
/api/v1/circles
curl \
-X POST https://api.plannrcrm.com/api/v1/circles \
-H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
-d '{"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": "39094e88-ff3e-4460-8c6b-b36e7bf7e839",
"groups": [
{
"name": "finance",
"slug": "finance",
"uuid": "45bb443f-f6db-47dc-b699-025ac970f61c",
"created_at": "2025-01-20T22:37:16+00:00",
"updated_at": "2025-01-20T22:37:16+00:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "1e732613-0ec2-4636-a48f-48a80071c198",
"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": "3b96bb48-0698-485f-ac6c-010d21525b6a",
"email": "gareth@codepotato.co.uk",
"last_name": "Thompson",
"photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
"created_at": "2025-01-20T22:37:16+00:00",
"first_name": "Gareth",
"updated_at": "2025-01-20T22:37:16+00:00",
"external_references": "App\\Http\\Resources\\ExternalReferenceResource"
}
],
"created_at": "2025-01-20T22:37:16+00:00",
"updated_at": "2025-01-20T22:37:16+00:00"
}