Get the built fire-as-person action

curl --request GET \
  --url https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fire-as-person/{actionId}/built \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fire-as-person/{actionId}/built"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fire-as-person/{actionId}/built', 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://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fire-as-person/{actionId}/built",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fire-as-person/{actionId}/built"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fire-as-person/{actionId}/built")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fire-as-person/{actionId}/built")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "action_id": "<string>",
  "action_type": "FIRE_AS_PERSON",
  "component_ids": [
    "<string>"
  ],
  "component_references": [
    {
      "component_id": "<string>",
      "socket_names": [
        "<string>"
      ]
    }
  ],
  "enabled": true,
  "as_person_identification": {
    "person_identification_type": "EMAIL",
    "value": "<string>"
  },
  "as_person_journey": {
    "advocate_code": "<string>",
    "advocate_partner_user_id": "<string>",
    "campaign_id": "<string>",
    "container": "<string>",
    "coupon_code": "<string>",
    "journey_type": "<string>",
    "label": "<string>",
    "promotable_code": "<string>",
    "reason": "<string>",
    "share_id": "<string>",
    "shareable_id": "<string>",
    "zone": "<string>"
  },
  "data": {},
  "event_name": "<string>",
  "event_time": "2025-10-24T02:00:00-07:00",
  "extra_data": {},
  "labels": [
    "<string>"
  ],
  "person_id": "<string>"
}

GET

campaigns

{campaignId}

{version}

controllers

{controllerId}

actions

fire-as-person

{actionId}

built

Get the built fire-as-person action

curl --request GET \
  --url https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fire-as-person/{actionId}/built \
  --header 'Authorization: <api-key>'

import requests

url = "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fire-as-person/{actionId}/built"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fire-as-person/{actionId}/built', 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://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fire-as-person/{actionId}/built",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fire-as-person/{actionId}/built"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fire-as-person/{actionId}/built")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.extole.io/v2/campaigns/{campaignId}{version}/controllers/{controllerId}/actions/fire-as-person/{actionId}/built")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

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

{
  "action_id": "<string>",
  "action_type": "FIRE_AS_PERSON",
  "component_ids": [
    "<string>"
  ],
  "component_references": [
    {
      "component_id": "<string>",
      "socket_names": [
        "<string>"
      ]
    }
  ],
  "enabled": true,
  "as_person_identification": {
    "person_identification_type": "EMAIL",
    "value": "<string>"
  },
  "as_person_journey": {
    "advocate_code": "<string>",
    "advocate_partner_user_id": "<string>",
    "campaign_id": "<string>",
    "container": "<string>",
    "coupon_code": "<string>",
    "journey_type": "<string>",
    "label": "<string>",
    "promotable_code": "<string>",
    "reason": "<string>",
    "share_id": "<string>",
    "shareable_id": "<string>",
    "zone": "<string>"
  },
  "data": {},
  "event_name": "<string>",
  "event_time": "2025-10-24T02:00:00-07:00",
  "extra_data": {},
  "labels": [
    "<string>"
  ],
  "person_id": "<string>"
}

Authorizations

Authorization

string

header

required

Path Parameters

campaignId

string

required

version

string

required

Pattern: (/version/.+)?

controllerId

string

required

actionId

string

required

Response

Successful response

action_id

string

action_type

enum<string>

Available options:

FIRE_AS_PERSON

component_ids

string[]

component_references

object[]

Show child attributes

enabled

boolean

quality

enum<string>

Available options:

ALWAYS,

HIGH,

LOW

as_person_identification

EMAIL · object

EMAIL
PARTNER_EVENT_ID
PARTNER_USER_ID
PERSON_ID

Show child attributes

as_person_journey

object

Show child attributes

data

object

Show child attributes

event_name

string

event_time

The event time as configured: a literal value, or an expression (type:string) when defined dynamically.

Pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d{1,3})?(Z|[+-](?:[01][0-9]|2[0-3]):[0-5][0-9])(\[[^\]]+\])?$

Example:

"2025-10-24T02:00:00-07:00"

extra_data

The extra data as configured: a literal value, or an expression (type:string) when defined dynamically.

Show child attributes

labels

string[]

person_id

The person id as configured: a literal value, or an expression (type:string) when defined dynamically.

Delete a fire-as-person action Get an incentivize-status-update action

Getting Started

Consumer to Extole API

Server to Extole API

Management API

Management Expert API

Get the built fire-as-person action

Authorizations

Path Parameters

Response