Submit Interaction

Submit collected end-user data for the current interaction to advance a GBG GO journey toward completion.

POST /journey/interaction/submit

Submit Interaction

cURL

curl --request POST \
  --url https://eu.platform.go.gbgplc.com/v2/captain/journey/interaction/submit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "instanceId": "PiKR2O0IjyUR8KV3RviKt4we",
  "interactionId": "grn:::gbg:design:interaction:segment1@latest",
  "participants": [
    {
      "domainElementId": "FullName"
    },
    {
      "domainElementId": "DateOfBirth"
    },
    {
      "domainElementId": "CurrentAddress"
    }
  ],
  "context": {
    "subject": {
      "identity": {
        "currentAddress": {
          "lines": [
            "99 STATE ST"
          ],
          "locality": "TUPELO",
          "dependentLocality": "MS",
          "postalCode": "38801",
          "country": "US"
        },
        "dateOfBirth": "2007-11-22",
        "firstName": "RED",
        "lastNames": [
          "HAWK"
        ]
      }
    }
  }
}
'

import requests

url = "https://eu.platform.go.gbgplc.com/v2/captain/journey/interaction/submit"

payload = {
    "instanceId": "PiKR2O0IjyUR8KV3RviKt4we",
    "interactionId": "grn:::gbg:design:interaction:segment1@latest",
    "participants": [{ "domainElementId": "FullName" }, { "domainElementId": "DateOfBirth" }, { "domainElementId": "CurrentAddress" }],
    "context": { "subject": { "identity": {
                "currentAddress": {
                    "lines": ["99 STATE ST"],
                    "locality": "TUPELO",
                    "dependentLocality": "MS",
                    "postalCode": "38801",
                    "country": "US"
                },
                "dateOfBirth": "2007-11-22",
                "firstName": "RED",
                "lastNames": ["HAWK"]
            } } }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    instanceId: 'PiKR2O0IjyUR8KV3RviKt4we',
    interactionId: 'grn:::gbg:design:interaction:segment1@latest',
    participants: [
      {domainElementId: 'FullName'},
      {domainElementId: 'DateOfBirth'},
      {domainElementId: 'CurrentAddress'}
    ],
    context: {
      subject: {
        identity: {
          currentAddress: {
            lines: ['99 STATE ST'],
            locality: 'TUPELO',
            dependentLocality: 'MS',
            postalCode: '38801',
            country: 'US'
          },
          dateOfBirth: '2007-11-22',
          firstName: 'RED',
          lastNames: ['HAWK']
        }
      }
    }
  })
};

fetch('https://eu.platform.go.gbgplc.com/v2/captain/journey/interaction/submit', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://eu.platform.go.gbgplc.com/v2/captain/journey/interaction/submit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'instanceId' => 'PiKR2O0IjyUR8KV3RviKt4we',
    'interactionId' => 'grn:::gbg:design:interaction:segment1@latest',
    'participants' => [
        [
                'domainElementId' => 'FullName'
        ],
        [
                'domainElementId' => 'DateOfBirth'
        ],
        [
                'domainElementId' => 'CurrentAddress'
        ]
    ],
    'context' => [
        'subject' => [
                'identity' => [
                                'currentAddress' => [
                                                                'lines' => [
                                                                                                                                '99 STATE ST'
                                                                ],
                                                                'locality' => 'TUPELO',
                                                                'dependentLocality' => 'MS',
                                                                'postalCode' => '38801',
                                                                'country' => 'US'
                                ],
                                'dateOfBirth' => '2007-11-22',
                                'firstName' => 'RED',
                                'lastNames' => [
                                                                'HAWK'
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://eu.platform.go.gbgplc.com/v2/captain/journey/interaction/submit"

	payload := strings.NewReader("{\n  \"instanceId\": \"PiKR2O0IjyUR8KV3RviKt4we\",\n  \"interactionId\": \"grn:::gbg:design:interaction:segment1@latest\",\n  \"participants\": [\n    {\n      \"domainElementId\": \"FullName\"\n    },\n    {\n      \"domainElementId\": \"DateOfBirth\"\n    },\n    {\n      \"domainElementId\": \"CurrentAddress\"\n    }\n  ],\n  \"context\": {\n    \"subject\": {\n      \"identity\": {\n        \"currentAddress\": {\n          \"lines\": [\n            \"99 STATE ST\"\n          ],\n          \"locality\": \"TUPELO\",\n          \"dependentLocality\": \"MS\",\n          \"postalCode\": \"38801\",\n          \"country\": \"US\"\n        },\n        \"dateOfBirth\": \"2007-11-22\",\n        \"firstName\": \"RED\",\n        \"lastNames\": [\n          \"HAWK\"\n        ]\n      }\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://eu.platform.go.gbgplc.com/v2/captain/journey/interaction/submit")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"instanceId\": \"PiKR2O0IjyUR8KV3RviKt4we\",\n  \"interactionId\": \"grn:::gbg:design:interaction:segment1@latest\",\n  \"participants\": [\n    {\n      \"domainElementId\": \"FullName\"\n    },\n    {\n      \"domainElementId\": \"DateOfBirth\"\n    },\n    {\n      \"domainElementId\": \"CurrentAddress\"\n    }\n  ],\n  \"context\": {\n    \"subject\": {\n      \"identity\": {\n        \"currentAddress\": {\n          \"lines\": [\n            \"99 STATE ST\"\n          ],\n          \"locality\": \"TUPELO\",\n          \"dependentLocality\": \"MS\",\n          \"postalCode\": \"38801\",\n          \"country\": \"US\"\n        },\n        \"dateOfBirth\": \"2007-11-22\",\n        \"firstName\": \"RED\",\n        \"lastNames\": [\n          \"HAWK\"\n        ]\n      }\n    }\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu.platform.go.gbgplc.com/v2/captain/journey/interaction/submit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"instanceId\": \"PiKR2O0IjyUR8KV3RviKt4we\",\n  \"interactionId\": \"grn:::gbg:design:interaction:segment1@latest\",\n  \"participants\": [\n    {\n      \"domainElementId\": \"FullName\"\n    },\n    {\n      \"domainElementId\": \"DateOfBirth\"\n    },\n    {\n      \"domainElementId\": \"CurrentAddress\"\n    }\n  ],\n  \"context\": {\n    \"subject\": {\n      \"identity\": {\n        \"currentAddress\": {\n          \"lines\": [\n            \"99 STATE ST\"\n          ],\n          \"locality\": \"TUPELO\",\n          \"dependentLocality\": \"MS\",\n          \"postalCode\": \"38801\",\n          \"country\": \"US\"\n        },\n        \"dateOfBirth\": \"2007-11-22\",\n        \"firstName\": \"RED\",\n        \"lastNames\": [\n          \"HAWK\"\n        ]\n      }\n    }\n  }\n}"

response = http.request(request)
puts response.read_body

200

success

{
  "status": "success"
}

Authorizations

Authorization · string · header · required

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

Body

application/json

instanceId · string · required

Journey instance identifier

interactionId · string · required

Interaction identifier

context · object

Subject data to submit for the interaction. See the user data schema for the full structure.

Show child attributes

participants · object[]

List of participants involved in the interaction

Show child attributes

Response

200

application/json

Success

Option 1

Option 2

status · enum<string> · required

Indicates the interaction was submitted successfully

Available options: success