POST
Create a goal

Authorizations

Authorization
string
header
required

A key from Settings → API keys. It starts with gd_key_.

Body

application/json
partyId
string<uuid>
required
desiredOutcome
string
required
Required string length: 1 - 120
description
string | null
Maximum string length: 2000
valueAmount
integer | null
Required range: x >= 0
valueCurrency
string | null
Required string length: 3
targetDate
string | null
Pattern: ^\d{4}-\d{2}-\d{2}$

Response

The goal

message
string
required
Example:

"Goal created"

metaData
object
required
data
object
required