Creates an audience snapshot based on the provided audience ID. An audience snapshot is a captured state of the audience customers.

curl --request POST \
  --url https://{host}/audience/v1/audiences/{audienceId}/snapshot \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "authorName": "<string>"
}
'

import requests

url = "https://{host}/audience/v1/audiences/{audienceId}/snapshot"

payload = { "authorName": "<string>" }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({authorName: '<string>'})
};

fetch('https://{host}/audience/v1/audiences/{audienceId}/snapshot', 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://{host}/audience/v1/audiences/{audienceId}/snapshot",
  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([
    'authorName' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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://{host}/audience/v1/audiences/{audienceId}/snapshot"

	payload := strings.NewReader("{\n  \"authorName\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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://{host}/audience/v1/audiences/{audienceId}/snapshot")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"authorName\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/audience/v1/audiences/{audienceId}/snapshot")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"authorName\": \"<string>\"\n}"

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

{
  "snapshotId": "<string>",
  "executionId": "<string>",
  "name": "<string>",
  "creationState": "Pending",
  "state": "Draft",
  "authorName": "<string>",
  "size": 123,
  "source": "<string>"
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

POST

audiences

{audienceId}

snapshot

Creates an audience snapshot based on the provided audience ID. An audience snapshot is a captured state of the audience customers.

curl --request POST \
  --url https://{host}/audience/v1/audiences/{audienceId}/snapshot \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "authorName": "<string>"
}
'

import requests

url = "https://{host}/audience/v1/audiences/{audienceId}/snapshot"

payload = { "authorName": "<string>" }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({authorName: '<string>'})
};

fetch('https://{host}/audience/v1/audiences/{audienceId}/snapshot', 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://{host}/audience/v1/audiences/{audienceId}/snapshot",
  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([
    'authorName' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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://{host}/audience/v1/audiences/{audienceId}/snapshot"

	payload := strings.NewReader("{\n  \"authorName\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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://{host}/audience/v1/audiences/{audienceId}/snapshot")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"authorName\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/audience/v1/audiences/{audienceId}/snapshot")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"authorName\": \"<string>\"\n}"

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

{
  "snapshotId": "<string>",
  "executionId": "<string>",
  "name": "<string>",
  "creationState": "Pending",
  "state": "Draft",
  "authorName": "<string>",
  "size": 123,
  "source": "<string>"
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path Parameters

audienceId

string

required

Body

authorName

string

required

Name of the user who creates the snapshot.

Maximum string length: 64

Response

Accepted

snapshotId

string | null

executionId

string | null

name

string | null

creationState

enum<string>

Available options:

Pending,

Created

state

enum<string>

Available options:

Draft,

Published,

Archived

authorName

string | null

size

integer<int32>

source

string | null

Last modified on August 10, 2026

⌘I