Create a group Run in API Explorer

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://apidocs.plannrcrm.com/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json
{
  "PlannrCRM MCP server": {
    "url": "https://apidocs.plannrcrm.com/mcp"
  }
}

Close
POST /api/v1/group

Headers

  • X-PLANNR-ACCOUNT-UUID string
application/json

Body

  • name string Required

    Group name that must be unique.

  • participants array[string(uuid)]

    UUIDs of accounts to add to the group.

  • business_unit string(uuid) | null

    UUID of business unit to link this group to

Responses

  • 200 application/json
    Hide response attributes Show response attributes object
    • uuid string

      UUID of the group

    • name string

      Name of the group

    • slug string

      Slug of the group

    • participants_count string

      Number of participants in the group

    • participants object

      Participants in this group

      Hide participants attributes Show participants attributes object
      • uuid object
        Hide uuid attributes Show uuid attributes object
        • example string
        • description string
      • role object
        Hide role attributes Show role attributes object
        • example string
        • description string
      • first_name object
        Hide first_name attributes Show first_name attributes object
        • example string
        • description string
      • last_name object
        Hide last_name attributes Show last_name attributes object
        • example string
        • description string
      • name object
        Hide name attributes Show name attributes object
        • example string
        • description string
      • email object
        Hide email attributes Show email attributes object
        • example string
        • description string
    • created_at string

      Timestamp of when the group was created

    • updated_at string

      Timestamp of when the group was updated

POST /api/v1/group
curl \
 --request POST 'https://api.plannrcrm.com/api/v1/group' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"name":"Accounting","participants":["43f884d7-390a-4e9e-8dee-94ccceae1b38","74037e44-7846-411f-afd0-a48be62436d4","fd503e91-d562-47e9-8ba2-a382306f16c9"],"business_unit":"2057f17e-8f35-4e60-81ae-c3f04e3db0ec"}'
Request examples
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Accounting",
  "participants": [
    "43f884d7-390a-4e9e-8dee-94ccceae1b38",
    "74037e44-7846-411f-afd0-a48be62436d4",
    "fd503e91-d562-47e9-8ba2-a382306f16c9"
  ],
  "business_unit": "2057f17e-8f35-4e60-81ae-c3f04e3db0ec"
}
Response examples (200)
{
  "uuid": "6c3cd3d0-49e9-4339-83ac-9c194492767c",
  "name": "finance",
  "slug": "finance",
  "participants_count": "3",
  "participants": {
    "uuid": {
      "example": "5345df12-0143-42b5-84cb-fb281d6e6a54",
      "description": "UUID of the account"
    },
    "role": {
      "example": "client",
      "description": "Role of the account"
    },
    "first_name": {
      "example": "Gareth",
      "description": "First name of the account"
    },
    "last_name": {
      "example": "Thompson",
      "description": "Last name of the account"
    },
    "name": {
      "example": "Gareth Thompson",
      "description": "Name of the account"
    },
    "email": {
      "example": "gareth@codepotato.co.uk",
      "description": "Email of the account"
    }
  },
  "created_at": "2026-06-27T09:33:41+01:00",
  "updated_at": "2026-06-27T09:33:41+01:00"
}