Skip to main content
POST
/
journey
/
task
/
update
Submit task data
curl --request POST \
  --url https://eu.platform.go.gbgplc.com/v2/captain/journey/task/update \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "intent": "Complete",
  "instanceId": "PiIbYsgiHp4R8JPz2vU5Y9l4",
  "taskId": "Tkob6dMMHp4R8JPz2vU5Y9l4",
  "context": {
    "subject": {
      "identity": {
        "currentAddress": {
          "country": "GBR",
          "postalCode": "BA133BN",
          "locality": "Westbury",
          "thoroughfare": "High Street",
          "building": "4",
          "administrativeArea": "Wilts"
        },
        "dateOfBirth": "1967-01-01",
        "firstName": "pari",
        "middleNames": [
          "c"
        ],
        "lastNames": [
          "powell"
        ]
      }
    }
  }
}
'
{
  "instanceId": "<string>",
  "taskId": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
intent
string
required

The intent of the request.

Example:

"Complete"

​
instanceId
string
required

Unique identifier for the active journey instance.

Example:

"PiIbYsgiHp4R8JPz2vU5Y9l4"

​
taskId
string
required

Unique identifier for the task being updated.

Example:

"Tkob6dMMHp4R8JPz2vU5Y9l4"

​
context
object

The data required to complete the task.

Response

201 - application/json

Task data submitted successfully.

​
instanceId
string

Unique identifier for the active journey instance.

​
taskId
string

Unique identifier for the task.