Create a goal | PlannrCRM API documentation

Create a goal Run in API Explorer

POST /api/v1/client/{client_uuid}/goal

Personal access token & O auth2

Headers

X-PLANNR-ACCOUNT-UUID string

Path parameters

client_uuid string Required

application/json

Body

name string Required

The goal's name.
description string Required

The goal's description.
target_amount integer

The goal's target amount.
progress number(float)

The goal's progress as a percentage.

Minimum value is 0.0, maximum value is 100.0.
timeframe string

The goal's timeframe.
complete_goal_by string

The goal's deadline as a specific date.
priority integer

The goal's priority on a scale from 1 to 5.

Values are 1, 2, 3, 4, or 5.
shared_owner_uuid string

Optional UUID of an owner account. The client must be a shared type.

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 goal's name.
- description string
  
  The goal's description.
- target_amount object
  
  The goal's target amount.
  
  Hide target_amount attributes Show target_amount attributes object
  
  amount object
  
  Hide amount attributes Show amount attributes object
  
  example string
  
  description string
  
  formatted object
  
  Hide formatted attributes Show formatted attributes object
  
  example string
  
  description string
  
  currency object
  
  Hide currency attributes Show currency attributes object
  
  example string
  
  description string
- progress string
  
  The goal's progress as a percentage.
- timeframe string
  
  The goal's timeframe.
- complete_goal_by string
  
  The goal's deadline as a specific date.
- priority string
  
  The goal's priority on a scale from 1 to 5.
- shared_owner_type string
  
  Denotes if the goal is shared across the client or belongs to one of the owners of the client. (Only applicable for joint/business/trust clients)
- shared_owner object
  
  The owner of the goal. Only provided if the shared_owner_type is "individual".
  
  Hide shared_owner attributes Show shared_owner attributes object
  
  uuid string
  
  created_at string
  
  updated_at string
  
  type string
  
  role string
  
  first_name string
  
  last_name string
  
  name string
  
  email string
  
  photo_url string
  
  firm string
  
  primary_phone_number string
  
  primary_email string
  
  current_time_entry string
  
  assigned_adviser string
  
  assigned_administrator string
  
  assigned_paraplanner string
  
  introduced_by string
  
  business_unit string
  
  groups string
  
  tags string
  
  owners string
  
  first_contact_date string
  
  next_review_date string
  
  previous_review_date string
  
  anniversary_review_date string
  
  with_login boolean
  
  has_joint_account boolean
  
  can_be_deleted string
  
  joint_account_circle string
  
  circles string
  
  ownership_percentage integer
  
  inactive_at string
  
  last_interaction_at string
  
  referral_code string
  
  permissions object
  
  Hide permissions attributes Show permissions attributes object
  
  firm:read array[string]
  
  network:read array[string]
  
  custom_fields string
  
  external_references string

POST /api/v1/client/{client_uuid}/goal

curl \
 --request POST 'https://api.plannrcrm.com/api/v1/client/6ff8f7f6-1eb3-3525-be4a-3932c805afed/goal' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"name":"Reduced Mileage","description":"Reduce the amount of gas spent yearly.","target_amount":5000,"progress":68.0,"timeframe":"Within the year.","complete_goal_by":"2027-04-28T22:34:35+01:00","priority":4,"shared_owner_uuid":"2995e97d-f52c-4cd5-9ade-4f241dc313ee"}'

Request examples

# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "name": "Reduced Mileage",
  "description": "Reduce the amount of gas spent yearly.",
  "target_amount": 5000,
  "progress": 68.0,
  "timeframe": "Within the year.",
  "complete_goal_by": "2027-04-28T22:34:35+01:00",
  "priority": 4,
  "shared_owner_uuid": "2995e97d-f52c-4cd5-9ade-4f241dc313ee"
}

Response examples (201)

Reduce the amount of gas spent yearly.

{
  "uuid": "1c4d9f75-abc8-4d31-9cf4-79312eb58e2e",
  "created_at": "2026-04-28T22:34:35+01:00",
  "updated_at": "2026-04-28T22:34:35+01:00",
  "name": "Reduced Mileage",
  "description": "Reduce the amount of gas spent yearly.",
  "target_amount": {
    "amount": {
      "example": "4000",
      "description": "Money amount at their lowest denominator (for example: pennies)"
    },
    "formatted": {
      "example": "£40.00",
      "description": "Money amount formatted with currency"
    },
    "currency": {
      "example": "GBP",
      "description": "Currency of the money"
    }
  },
  "progress": "68",
  "timeframe": "Within the year.",
  "complete_goal_by": "2027-04-28T22:34:35+01:00",
  "priority": "4",
  "shared_owner_type": "individual",
  "shared_owner": {
    "uuid": "a2ded8d5-53bb-44ff-92dc-0df3699a802e",
    "created_at": "2026-04-28T22:34:35+01:00",
    "updated_at": "2026-04-28T22:34:35+01:00",
    "type": "client",
    "role": "client",
    "first_name": "Gareth",
    "last_name": "Thompson",
    "name": "Gareth Thompson",
    "email": "gareth@codepotato.co.uk",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "firm": "App\\Http\\Resources\\FirmResource",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "business_unit": "App\\Http\\Resources\\BusinessUnitResource",
    "groups": "App\\Http\\Resources\\GroupResource",
    "tags": "App\\Http\\Resources\\TagResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "first_contact_date": "2026-04-28T22:34:35+01:00",
    "next_review_date": "2026-04-28T22:34:35+01:00",
    "previous_review_date": "2026-04-28T22:34:35+01:00",
    "anniversary_review_date": "2026-04-28T22:34:35+01:00",
    "with_login": true,
    "has_joint_account": true,
    "can_be_deleted": "false",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "inactive_at": "2026-04-28",
    "last_interaction_at": "2026-04-28 22:34:35",
    "referral_code": "ABC12345",
    "permissions": {
      "firm:read": [
        "firm"
      ],
      "network:read": [
        "network:uuid"
      ]
    },
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource"
  }
}