Create a circle

POST /api/v1/circles
Personal access token & OAuth2

Headers

application/json

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.

Responses

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

      The UUID of the resource.

    • created_at string

      The timestamp of when the resource was created.

    • updated_at string

      The timestamp of when the resource was updated.

    • name string

      The Circle name

    • accounts array[object]

      Accounts belonging to the circle

      Additional properties are allowed.

    • groups array[object]

      Groups the circle belongs to

      Additional properties are allowed.
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": "59899c0c-2e52-4676-b5ae-949f63faaaee",
  "groups": [
    {
      "name": "finance",
      "slug": "finance",
      "uuid": "6c15dedc-d91f-4cdb-9ce7-c133497e96d8",
      "created_at": "2025-02-20T10:13:01+00:00",
      "updated_at": "2025-02-20T10:13:01+00:00",
      "participants": {
        "name": {
          "example": "Gareth Thompson",
          "description": "Name of the account"
        },
        "role": {
          "example": "client",
          "description": "Role of the account"
        },
        "uuid": {
          "example": "24567d72-521e-486f-924c-7209dd771109",
          "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": "8aecbc31-f6d4-4369-a287-77f837f67594",
      "email": "gareth@codepotato.co.uk",
      "last_name": "Thompson",
      "photo_url": "https://eu.ui-avatars.com/api/?name=Gareth+Thompson",
      "created_at": "2025-02-20T10:13:01+00:00",
      "first_name": "Gareth",
      "updated_at": "2025-02-20T10:13:01+00:00",
      "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
    }
  ],
  "created_at": "2025-02-20T10:13:01+00:00",
  "updated_at": "2025-02-20T10:13:01+00:00"
}