Submit interaction data

POST

journey

interaction

submit

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": "<string>",
  "interactionId": "<string>",
  "participants": [
    {
      "domainElementId": "<string>",
      "instructions": [
        "<string>"
      ]
    }
  ]
}
'

import requests

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

payload = {
    "instanceId": "<string>",
    "interactionId": "<string>",
    "participants": [
        {
            "domainElementId": "<string>",
            "instructions": ["<string>"]
        }
    ]
}
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: '<string>',
    interactionId: '<string>',
    participants: [{domainElementId: '<string>', instructions: ['<string>']}]
  })
};

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' => '<string>',
    'interactionId' => '<string>',
    'participants' => [
        [
                'domainElementId' => '<string>',
                'instructions' => [
                                '<string>'
                ]
        ]
    ]
  ]),
  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\": \"<string>\",\n  \"interactionId\": \"<string>\",\n  \"participants\": [\n    {\n      \"domainElementId\": \"<string>\",\n      \"instructions\": [\n        \"<string>\"\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\": \"<string>\",\n  \"interactionId\": \"<string>\",\n  \"participants\": [\n    {\n      \"domainElementId\": \"<string>\",\n      \"instructions\": [\n        \"<string>\"\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\": \"<string>\",\n  \"interactionId\": \"<string>\",\n  \"participants\": [\n    {\n      \"domainElementId\": \"<string>\",\n      \"instructions\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}"

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

{
  "status": "success"
}

{
  "errors": [
    {
      "code": "<string>",
      "name": "<string>",
      "problem": "<string>",
      "action": "<string>",
      "location": "Path"
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "name": "<string>",
      "problem": "<string>",
      "action": "<string>",
      "location": "Path"
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "name": "<string>",
      "problem": "<string>",
      "action": "<string>",
      "location": "Path"
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "name": "<string>",
      "problem": "<string>",
      "action": "<string>",
      "location": "Path"
    }
  ]
}

Authorizations

Authorization

string

header

required

Customer JWT token for journey lifecycle operations. Required for: journey/start, journey/state/fetch, device/start

Body

application/json

instanceId

string

required

Journey Instance Id, a unique identifier for a started journey instance.

Required string length: 16 - 64

Pattern: ^[A-Za-z0-9_-]+$

interactionId

string

required

Minimum string length: 1

participants

object[]

Show child attributes

context

object

Show child attributes

{key}

any

Response

Submission accepted

status

enum<string>

required

Available options:

success

⌘I

Submit interaction data

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": "<string>",
  "interactionId": "<string>",
  "participants": [
    {
      "domainElementId": "<string>",
      "instructions": [
        "<string>"
      ]
    }
  ]
}
'

import requests

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

payload = {
    "instanceId": "<string>",
    "interactionId": "<string>",
    "participants": [
        {
            "domainElementId": "<string>",
            "instructions": ["<string>"]
        }
    ]
}
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: '<string>',
    interactionId: '<string>',
    participants: [{domainElementId: '<string>', instructions: ['<string>']}]
  })
};

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' => '<string>',
    'interactionId' => '<string>',
    'participants' => [
        [
                'domainElementId' => '<string>',
                'instructions' => [
                                '<string>'
                ]
        ]
    ]
  ]),
  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\": \"<string>\",\n  \"interactionId\": \"<string>\",\n  \"participants\": [\n    {\n      \"domainElementId\": \"<string>\",\n      \"instructions\": [\n        \"<string>\"\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\": \"<string>\",\n  \"interactionId\": \"<string>\",\n  \"participants\": [\n    {\n      \"domainElementId\": \"<string>\",\n      \"instructions\": [\n        \"<string>\"\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\": \"<string>\",\n  \"interactionId\": \"<string>\",\n  \"participants\": [\n    {\n      \"domainElementId\": \"<string>\",\n      \"instructions\": [\n        \"<string>\"\n      ]\n    }\n  ]\n}"

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

{
  "status": "success"
}

{
  "errors": [
    {
      "code": "<string>",
      "name": "<string>",
      "problem": "<string>",
      "action": "<string>",
      "location": "Path"
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "name": "<string>",
      "problem": "<string>",
      "action": "<string>",
      "location": "Path"
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "name": "<string>",
      "problem": "<string>",
      "action": "<string>",
      "location": "Path"
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "name": "<string>",
      "problem": "<string>",
      "action": "<string>",
      "location": "Path"
    }
  ]
}

Introduction

Migration

Journey execution

Interaction journey execution

Authorizations

Body

Response