Submit task data

Send data to complete a task in a customer’s journey. See the submit data guide for details.

post/journey/task/update

Request

  • Base URL
    https://eu.platform.go.gbgplc.com/captain/api
  • Auth
    HTTP bearer

Request body

intentstring required

The intent of the request.

instanceIdstring required

Unique identifier for the active journey instance.

taskIdstring required

Unique identifier for the task being updated.

Example request

{
  "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"
        ]
      }
    }
  }
}

Response

Task data submitted successfully.

instanceIdstring

Unique identifier for the active journey instance.

taskIdstring

Unique identifier for the task.

Changes

No recorded changes to this operation across all 1 revision of this API.