Create a goal

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

Headers

Path parameters

application/json

Body Required

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.

      Additional properties are allowed.

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

      Additional properties are allowed.
POST /api/v1/client/{client_uuid}/goal 
curl \
 -X POST https://api.plannrcrm.com/api/v1/client/client_uuid/goal \
 -H "Authorization: Bearer {OAUTH_ACCESS_TOKEN or PERSONAL_ACCESS_TOKEN}" \
 -H "Content-Type: application/json" \
 -H "Accept: application/json" \
 -H "X-PLANNR-ACCOUNT-UUID: {YOUR_PLANNR_ACCOUNT_UUID}" \
 -d '{"name":"Reduced Mileage","description":"Reduce the amount of gas spent yearly.","target_amount":5000,"progress":68,"timeframe":"Within the year.","complete_goal_by":"2025-11-20T13:24:00+00:00","priority":4,"shared_owner_uuid":"3169f3a0-22f0-4ee5-b89c-482566bac84b"}'
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": "Reduced Mileage",
  "description": "Reduce the amount of gas spent yearly.",
  "target_amount": 5000,
  "progress": 68,
  "timeframe": "Within the year.",
  "complete_goal_by": "2025-11-20T13:24:00+00:00",
  "priority": 4,
  "shared_owner_uuid": "3169f3a0-22f0-4ee5-b89c-482566bac84b"
}
Response examples (201) 
{
  "name": "Reduced Mileage",
  "uuid": "4d51745e-a5bc-416b-80ab-a6c224fb764b",
  "priority": "4",
  "progress": "68",
  "timeframe": "Within the year.",
  "created_at": "2024-11-20T13:24:00+00:00",
  "updated_at": "2024-11-20T13:24:00+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": "27b3988b-d90a-4baf-bbe5-1252a357bb23",
    "email": "gareth@codepotato.co.uk",
    "groups": "App\\Http\\Resources\\GroupResource",
    "owners": "App\\Http\\Resources\\AccountResource",
    "last_name": "Thompson",
    "created_at": "2024-11-20T13:24:00+00:00",
    "first_name": "Gareth",
    "updated_at": "2024-11-20T13:24:00+00:00",
    "with_login": true,
    "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": "2024-11-20T13:24:00+00:00",
    "has_joint_account": true,
    "current_time_entry": "App\\Http\\Resources\\TimeEntryResource",
    "first_contact_date": "2024-11-20T13:24:00+00:00",
    "external_references": "App\\Http\\Resources\\ExternalReferenceResource",
    "assigned_paraplanner": "App\\Http\\Resources\\AccountResource",
    "previous_review_date": "2024-11-20T13:24:00+00:00",
    "primary_phone_number": "App\\Http\\Resources\\ContactDetailResource",
    "assigned_administrator": "App\\Http\\Resources\\AccountResource",
    "anniversary_review_date": "2024-11-20T13:24:00+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": "2025-11-20T13:24:00+00:00",
  "shared_owner_type": "individual"
}