Update a goal

PUT /api/v2/goals/{uuid}
Personal access token & O auth2

Path parameters

  • uuid integer Required
  • goal string Required

    The uuid of the goal which to update.

application/json

Body

Responses

  • 200 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.

    • 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".
PUT /api/v2/goals/{uuid} 
curl \
 --request PUT 'https://api.plannrcrm.com/api/v2/goals/uuid' \
 --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 '{"account_uuids":["94c1b921-ef87-43cf-a6f3-3a5043ec50a5","3d8f60c9-3b00-422b-904f-2a79630ac5d6"],"name":"Reduced Mileage","description":"Reduce the amount of gas spent yearly.","target_amount":5000,"progress":68,"timeframe":"Within the year.","complete_goal_by":"2026-04-22T13:44:22+01:00","priority":4}'
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
{
  "account_uuids": [
    "94c1b921-ef87-43cf-a6f3-3a5043ec50a5",
    "3d8f60c9-3b00-422b-904f-2a79630ac5d6"
  ],
  "name": "Reduced Mileage",
  "description": "Reduce the amount of gas spent yearly.",
  "target_amount": 5000,
  "progress": 68,
  "timeframe": "Within the year.",
  "complete_goal_by": "2026-04-22T13:44:22+01:00",
  "priority": 4
}
Response examples (200) 
{
  "name": "Reduced Mileage",
  "uuid": "1e516dcd-e81d-4d25-8a4e-bc799550e697",
  "priority": "4",
  "progress": "68",
  "timeframe": "Within the year.",
  "created_at": "2025-04-22T13:44:22+01:00",
  "updated_at": "2025-04-22T13:44:22+01: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": "362ce239-1533-410f-be00-ef6e3775b912",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2025-04-22T13:44:22+01:00",
    "first_name": "Gareth",
    "updated_at": "2025-04-22T13:44:22+01:00",
    "with_login": true,
    "inactive_at": "2025-04-22",
    "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-04-22T13:44:22+01:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2025-04-22T13:44:22+01: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-04-22T13:44:22+01:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2025-04-22T13:44:22+01: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-04-22T13:44:22+01:00",
  "shared_owner_type": "individual"
}