Headers
-
Content-Type
string -
Accept
string -
X-PLANNR-ACCOUNT-UUID
string
Body
Required
-
name
string Required Group name that must be unique.
-
participants
array[string] UUIDs of accounts to add to the group.
POST
/api/v1/group
curl \
--request POST 'https://api.plannrcrm.com/api/v1/group' \
--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":"Accounting","participants":["71253d5f-554b-48c1-a9ed-d4130ebe82d2","b1d3a372-93b3-4369-8bb3-e94337b42f64"]}'
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": "Accounting",
"participants": [
"71253d5f-554b-48c1-a9ed-d4130ebe82d2",
"b1d3a372-93b3-4369-8bb3-e94337b42f64"
]
}
Response examples (200)
{
"name": "finance",
"slug": "finance",
"uuid": "0a55de5a-ef2a-4588-865d-344286edc7f3",
"created_at": "2025-04-22T13:44:18+01:00",
"updated_at": "2025-04-22T13:44:18+01:00",
"participants": {
"name": {
"example": "Gareth Thompson",
"description": "Name of the account"
},
"role": {
"example": "client",
"description": "Role of the account"
},
"uuid": {
"example": "880686ca-c623-4bb8-b206-499d3de1b7c9",
"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"
}