Skip to main content
PATCH
/
cases
/
{case_id}
/
goals
/
{goal_id}
Update a goal
curl --request PATCH \
  --url https://api.example.com/v1/cases/{case_id}/goals/{goal_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "status": "pending"
}
'
{
  "data": {
    "id": "01K5XE10FJ8T55HRYE78AN7MNO",
    "type": "discover_financial_accounts",
    "status": "in_progress",
    "completed_at": "2023-11-07T05:31:56Z",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
case_id
string
required

Unique case identifier (ULID format).

​
goal_id
string
required

Goal identifier.

Body

application/json
​
status
enum<string>
Available options:
pending,
in_progress,
completed

Response

Goal updated.

​
data
object