POST /api/v2/goals
Personal access token & O auth2

Headers

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

Body Required

  • account_uuids array[string] Required

    The UUIDs of the accounts who should own the goal. These must only be client accounts.

  • name string Required

    The goal's name.

  • description string Required

    The goal's description.

  • target_amount integer Required

    The goal's target amount.

  • progress integer

    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 integer

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

  • show_on_circles boolean

    Determines if goal should be shown on a circle.

  • visible_to_circles_uuids array[string]

    Circles UUIDs that can view the goal when filtering goals by circles. Leaving blank means the goal will be visible for all circles which contains the goal owners.

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
      • 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
      • custom_fields string
      • external_references string
POST /api/v2/goals 
curl \
 --request POST 'https://api.plannrcrm.com/api/v2/goals' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --header "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 --data '{"account_uuids":["68353564-1335-4ccc-9e4c-c35354369da5","9d379e7a-65c2-4fb2-81f7-55a965ca8d3c"],"name":"Reduced Mileage","description":"Reduce the amount of gas spent yearly.","target_amount":5000,"progress":68,"timeframe":"Within the year.","complete_goal_by":"2026-12-04T22:09:17+00:00","priority":4,"show_on_circles":false,"visible_to_circles_uuids":["96ac4adf-033f-4559-bec5-38ce55045924","a152190e-7ce8-467d-a0e3-e44e0bf2fbe3"]}'
Request examples 
# Headers
X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}

# Payload
{
  "account_uuids": [
    "68353564-1335-4ccc-9e4c-c35354369da5",
    "9d379e7a-65c2-4fb2-81f7-55a965ca8d3c"
  ],
  "name": "Reduced Mileage",
  "description": "Reduce the amount of gas spent yearly.",
  "target_amount": 5000,
  "progress": 68,
  "timeframe": "Within the year.",
  "complete_goal_by": "2026-12-04T22:09:17+00:00",
  "priority": 4,
  "show_on_circles": false,
  "visible_to_circles_uuids": [
    "96ac4adf-033f-4559-bec5-38ce55045924",
    "a152190e-7ce8-467d-a0e3-e44e0bf2fbe3"
  ]
}
Response examples (201) 
{
  "name": "Reduced Mileage",
  "uuid": "6819cf06-48a2-4dde-b3ad-c19ca4dee6d9",
  "priority": "4",
  "progress": "68",
  "timeframe": "Within the year.",
  "created_at": "2025-12-04T22:09:17+00:00",
  "updated_at": "2025-12-04T22:09:17+00:00",
  "description": "Reduce the amount of gas spent yearly.",
  "shared_owner": {
    "firm": "App\\Http\\Resources\\FirmResource",
    "name": "Gareth Thompson",
    "role": "client",
    "tags": "App\\Http\\Resources\\TagResource",
    "type": "client",
    "uuid": "5b9606a2-3ac5-4036-840f-7b184af8ab09",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "circles": "App\\Http\\Resources\\CircleResource",
    "last_name": "Thompson",
    "photo_url": "https://eu.ui-avatars.com/api/?name=gareth+thompson",
    "created_at": "2025-12-04T22:09:17+00:00",
    "first_name": "Gareth",
    "updated_at": "2025-12-04T22:09:17+00:00",
    "with_login": true,
    "inactive_at": "2025-12-04",
    "custom_fields": "App\\Http\\Resources\\CustomFieldValueResource",
    "introduced_by": "App\\Http\\Resources\\AccountResource",
    "primary_email": "App\\Http\\Resources\\ContactDetailResource",
    "can_be_deleted": "false",
    "assigned_adviser": "App\\Http\\Resources\\AccountResource",
    "next_review_date": "2025-12-04T22:09:17+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-12-04T22:09:17+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "joint_account_circle": "App\\Http\\Resources\\CircleResource",
    "ownership_percentage": 100,
    "previous_review_date": "2025-12-04T22:09:17+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-12-04T22:09:17+00:00"
  },
  "target_amount": {
    "amount": {
      "example": "4000",
      "description": "Money amount at their lowest denominator (for example: pennies)"
    },
    "currency": {
      "example": "GBP",
      "description": "Currency of the money"
    },
    "formatted": {
      "example": "£40.00",
      "description": "Money amount formatted with currency"
    }
  },
  "complete_goal_by": "2026-12-04T22:09:17+00:00",
  "shared_owner_type": "individual"
}