Create content item

curl --request POST \
  --url https://{host}/feed/v1/Content \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "authorId": "<string>",
  "authorName": "<string>",
  "title": "<string>",
  "publishDate": "2023-11-07T05:31:56Z",
  "expirationDate": "2023-11-07T05:31:56Z",
  "isReadyToDistribute": true,
  "createdBy": "<string>",
  "externalId": "<string>",
  "campaignName": "<string>",
  "analyticsIdentifier": "<string>",
  "imageUrl": "<string>",
  "altText": "<string>",
  "videoUrl": "<string>",
  "topMessage": "<string>",
  "bottomMessage": "<string>",
  "longDescription": "<string>",
  "buttonText": "<string>",
  "externalUrl": "<string>",
  "useWebWrapper": true,
  "deepLinkId": "<string>",
  "deepLinkParameters": {},
  "deepLinkUrl": "<string>",
  "audienceIds": [
    "<string>"
  ],
  "storeId": "<string>",
  "storeIds": [
    "<string>"
  ],
  "isBoardContent": true,
  "customProperties": {},
  "chainIds": [
    "<string>"
  ],
  "priority": 123,
  "requiresApproval": true,
  "unifiedCampaignId": "<string>"
}
'

import requests

url = "https://{host}/feed/v1/Content"

payload = {
    "authorId": "<string>",
    "authorName": "<string>",
    "title": "<string>",
    "publishDate": "2023-11-07T05:31:56Z",
    "expirationDate": "2023-11-07T05:31:56Z",
    "isReadyToDistribute": True,
    "createdBy": "<string>",
    "externalId": "<string>",
    "campaignName": "<string>",
    "analyticsIdentifier": "<string>",
    "imageUrl": "<string>",
    "altText": "<string>",
    "videoUrl": "<string>",
    "topMessage": "<string>",
    "bottomMessage": "<string>",
    "longDescription": "<string>",
    "buttonText": "<string>",
    "externalUrl": "<string>",
    "useWebWrapper": True,
    "deepLinkId": "<string>",
    "deepLinkParameters": {},
    "deepLinkUrl": "<string>",
    "audienceIds": ["<string>"],
    "storeId": "<string>",
    "storeIds": ["<string>"],
    "isBoardContent": True,
    "customProperties": {},
    "chainIds": ["<string>"],
    "priority": 123,
    "requiresApproval": True,
    "unifiedCampaignId": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    authorId: '<string>',
    authorName: '<string>',
    title: '<string>',
    publishDate: '2023-11-07T05:31:56Z',
    expirationDate: '2023-11-07T05:31:56Z',
    isReadyToDistribute: true,
    createdBy: '<string>',
    externalId: '<string>',
    campaignName: '<string>',
    analyticsIdentifier: '<string>',
    imageUrl: '<string>',
    altText: '<string>',
    videoUrl: '<string>',
    topMessage: '<string>',
    bottomMessage: '<string>',
    longDescription: '<string>',
    buttonText: '<string>',
    externalUrl: '<string>',
    useWebWrapper: true,
    deepLinkId: '<string>',
    deepLinkParameters: {},
    deepLinkUrl: '<string>',
    audienceIds: ['<string>'],
    storeId: '<string>',
    storeIds: ['<string>'],
    isBoardContent: true,
    customProperties: {},
    chainIds: ['<string>'],
    priority: 123,
    requiresApproval: true,
    unifiedCampaignId: '<string>'
  })
};

fetch('https://{host}/feed/v1/Content', 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}/feed/v1/Content",
  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([
    'authorId' => '<string>',
    'authorName' => '<string>',
    'title' => '<string>',
    'publishDate' => '2023-11-07T05:31:56Z',
    'expirationDate' => '2023-11-07T05:31:56Z',
    'isReadyToDistribute' => true,
    'createdBy' => '<string>',
    'externalId' => '<string>',
    'campaignName' => '<string>',
    'analyticsIdentifier' => '<string>',
    'imageUrl' => '<string>',
    'altText' => '<string>',
    'videoUrl' => '<string>',
    'topMessage' => '<string>',
    'bottomMessage' => '<string>',
    'longDescription' => '<string>',
    'buttonText' => '<string>',
    'externalUrl' => '<string>',
    'useWebWrapper' => true,
    'deepLinkId' => '<string>',
    'deepLinkParameters' => [
        
    ],
    'deepLinkUrl' => '<string>',
    'audienceIds' => [
        '<string>'
    ],
    'storeId' => '<string>',
    'storeIds' => [
        '<string>'
    ],
    'isBoardContent' => true,
    'customProperties' => [
        
    ],
    'chainIds' => [
        '<string>'
    ],
    'priority' => 123,
    'requiresApproval' => true,
    'unifiedCampaignId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json-patch+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}/feed/v1/Content"

	payload := strings.NewReader("{\n  \"authorId\": \"<string>\",\n  \"authorName\": \"<string>\",\n  \"title\": \"<string>\",\n  \"publishDate\": \"2023-11-07T05:31:56Z\",\n  \"expirationDate\": \"2023-11-07T05:31:56Z\",\n  \"isReadyToDistribute\": true,\n  \"createdBy\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"campaignName\": \"<string>\",\n  \"analyticsIdentifier\": \"<string>\",\n  \"imageUrl\": \"<string>\",\n  \"altText\": \"<string>\",\n  \"videoUrl\": \"<string>\",\n  \"topMessage\": \"<string>\",\n  \"bottomMessage\": \"<string>\",\n  \"longDescription\": \"<string>\",\n  \"buttonText\": \"<string>\",\n  \"externalUrl\": \"<string>\",\n  \"useWebWrapper\": true,\n  \"deepLinkId\": \"<string>\",\n  \"deepLinkParameters\": {},\n  \"deepLinkUrl\": \"<string>\",\n  \"audienceIds\": [\n    \"<string>\"\n  ],\n  \"storeId\": \"<string>\",\n  \"storeIds\": [\n    \"<string>\"\n  ],\n  \"isBoardContent\": true,\n  \"customProperties\": {},\n  \"chainIds\": [\n    \"<string>\"\n  ],\n  \"priority\": 123,\n  \"requiresApproval\": true,\n  \"unifiedCampaignId\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+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}/feed/v1/Content")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"authorId\": \"<string>\",\n  \"authorName\": \"<string>\",\n  \"title\": \"<string>\",\n  \"publishDate\": \"2023-11-07T05:31:56Z\",\n  \"expirationDate\": \"2023-11-07T05:31:56Z\",\n  \"isReadyToDistribute\": true,\n  \"createdBy\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"campaignName\": \"<string>\",\n  \"analyticsIdentifier\": \"<string>\",\n  \"imageUrl\": \"<string>\",\n  \"altText\": \"<string>\",\n  \"videoUrl\": \"<string>\",\n  \"topMessage\": \"<string>\",\n  \"bottomMessage\": \"<string>\",\n  \"longDescription\": \"<string>\",\n  \"buttonText\": \"<string>\",\n  \"externalUrl\": \"<string>\",\n  \"useWebWrapper\": true,\n  \"deepLinkId\": \"<string>\",\n  \"deepLinkParameters\": {},\n  \"deepLinkUrl\": \"<string>\",\n  \"audienceIds\": [\n    \"<string>\"\n  ],\n  \"storeId\": \"<string>\",\n  \"storeIds\": [\n    \"<string>\"\n  ],\n  \"isBoardContent\": true,\n  \"customProperties\": {},\n  \"chainIds\": [\n    \"<string>\"\n  ],\n  \"priority\": 123,\n  \"requiresApproval\": true,\n  \"unifiedCampaignId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/feed/v1/Content")

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-patch+json'
request.body = "{\n  \"authorId\": \"<string>\",\n  \"authorName\": \"<string>\",\n  \"title\": \"<string>\",\n  \"publishDate\": \"2023-11-07T05:31:56Z\",\n  \"expirationDate\": \"2023-11-07T05:31:56Z\",\n  \"isReadyToDistribute\": true,\n  \"createdBy\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"campaignName\": \"<string>\",\n  \"analyticsIdentifier\": \"<string>\",\n  \"imageUrl\": \"<string>\",\n  \"altText\": \"<string>\",\n  \"videoUrl\": \"<string>\",\n  \"topMessage\": \"<string>\",\n  \"bottomMessage\": \"<string>\",\n  \"longDescription\": \"<string>\",\n  \"buttonText\": \"<string>\",\n  \"externalUrl\": \"<string>\",\n  \"useWebWrapper\": true,\n  \"deepLinkId\": \"<string>\",\n  \"deepLinkParameters\": {},\n  \"deepLinkUrl\": \"<string>\",\n  \"audienceIds\": [\n    \"<string>\"\n  ],\n  \"storeId\": \"<string>\",\n  \"storeIds\": [\n    \"<string>\"\n  ],\n  \"isBoardContent\": true,\n  \"customProperties\": {},\n  \"chainIds\": [\n    \"<string>\"\n  ],\n  \"priority\": 123,\n  \"requiresApproval\": true,\n  \"unifiedCampaignId\": \"<string>\"\n}"

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

{
  "id": 123
}

POST

Content

Create content item

curl --request POST \
  --url https://{host}/feed/v1/Content \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json-patch+json' \
  --data '
{
  "authorId": "<string>",
  "authorName": "<string>",
  "title": "<string>",
  "publishDate": "2023-11-07T05:31:56Z",
  "expirationDate": "2023-11-07T05:31:56Z",
  "isReadyToDistribute": true,
  "createdBy": "<string>",
  "externalId": "<string>",
  "campaignName": "<string>",
  "analyticsIdentifier": "<string>",
  "imageUrl": "<string>",
  "altText": "<string>",
  "videoUrl": "<string>",
  "topMessage": "<string>",
  "bottomMessage": "<string>",
  "longDescription": "<string>",
  "buttonText": "<string>",
  "externalUrl": "<string>",
  "useWebWrapper": true,
  "deepLinkId": "<string>",
  "deepLinkParameters": {},
  "deepLinkUrl": "<string>",
  "audienceIds": [
    "<string>"
  ],
  "storeId": "<string>",
  "storeIds": [
    "<string>"
  ],
  "isBoardContent": true,
  "customProperties": {},
  "chainIds": [
    "<string>"
  ],
  "priority": 123,
  "requiresApproval": true,
  "unifiedCampaignId": "<string>"
}
'

import requests

url = "https://{host}/feed/v1/Content"

payload = {
    "authorId": "<string>",
    "authorName": "<string>",
    "title": "<string>",
    "publishDate": "2023-11-07T05:31:56Z",
    "expirationDate": "2023-11-07T05:31:56Z",
    "isReadyToDistribute": True,
    "createdBy": "<string>",
    "externalId": "<string>",
    "campaignName": "<string>",
    "analyticsIdentifier": "<string>",
    "imageUrl": "<string>",
    "altText": "<string>",
    "videoUrl": "<string>",
    "topMessage": "<string>",
    "bottomMessage": "<string>",
    "longDescription": "<string>",
    "buttonText": "<string>",
    "externalUrl": "<string>",
    "useWebWrapper": True,
    "deepLinkId": "<string>",
    "deepLinkParameters": {},
    "deepLinkUrl": "<string>",
    "audienceIds": ["<string>"],
    "storeId": "<string>",
    "storeIds": ["<string>"],
    "isBoardContent": True,
    "customProperties": {},
    "chainIds": ["<string>"],
    "priority": 123,
    "requiresApproval": True,
    "unifiedCampaignId": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json-patch+json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json-patch+json'},
  body: JSON.stringify({
    authorId: '<string>',
    authorName: '<string>',
    title: '<string>',
    publishDate: '2023-11-07T05:31:56Z',
    expirationDate: '2023-11-07T05:31:56Z',
    isReadyToDistribute: true,
    createdBy: '<string>',
    externalId: '<string>',
    campaignName: '<string>',
    analyticsIdentifier: '<string>',
    imageUrl: '<string>',
    altText: '<string>',
    videoUrl: '<string>',
    topMessage: '<string>',
    bottomMessage: '<string>',
    longDescription: '<string>',
    buttonText: '<string>',
    externalUrl: '<string>',
    useWebWrapper: true,
    deepLinkId: '<string>',
    deepLinkParameters: {},
    deepLinkUrl: '<string>',
    audienceIds: ['<string>'],
    storeId: '<string>',
    storeIds: ['<string>'],
    isBoardContent: true,
    customProperties: {},
    chainIds: ['<string>'],
    priority: 123,
    requiresApproval: true,
    unifiedCampaignId: '<string>'
  })
};

fetch('https://{host}/feed/v1/Content', 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}/feed/v1/Content",
  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([
    'authorId' => '<string>',
    'authorName' => '<string>',
    'title' => '<string>',
    'publishDate' => '2023-11-07T05:31:56Z',
    'expirationDate' => '2023-11-07T05:31:56Z',
    'isReadyToDistribute' => true,
    'createdBy' => '<string>',
    'externalId' => '<string>',
    'campaignName' => '<string>',
    'analyticsIdentifier' => '<string>',
    'imageUrl' => '<string>',
    'altText' => '<string>',
    'videoUrl' => '<string>',
    'topMessage' => '<string>',
    'bottomMessage' => '<string>',
    'longDescription' => '<string>',
    'buttonText' => '<string>',
    'externalUrl' => '<string>',
    'useWebWrapper' => true,
    'deepLinkId' => '<string>',
    'deepLinkParameters' => [
        
    ],
    'deepLinkUrl' => '<string>',
    'audienceIds' => [
        '<string>'
    ],
    'storeId' => '<string>',
    'storeIds' => [
        '<string>'
    ],
    'isBoardContent' => true,
    'customProperties' => [
        
    ],
    'chainIds' => [
        '<string>'
    ],
    'priority' => 123,
    'requiresApproval' => true,
    'unifiedCampaignId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json-patch+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}/feed/v1/Content"

	payload := strings.NewReader("{\n  \"authorId\": \"<string>\",\n  \"authorName\": \"<string>\",\n  \"title\": \"<string>\",\n  \"publishDate\": \"2023-11-07T05:31:56Z\",\n  \"expirationDate\": \"2023-11-07T05:31:56Z\",\n  \"isReadyToDistribute\": true,\n  \"createdBy\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"campaignName\": \"<string>\",\n  \"analyticsIdentifier\": \"<string>\",\n  \"imageUrl\": \"<string>\",\n  \"altText\": \"<string>\",\n  \"videoUrl\": \"<string>\",\n  \"topMessage\": \"<string>\",\n  \"bottomMessage\": \"<string>\",\n  \"longDescription\": \"<string>\",\n  \"buttonText\": \"<string>\",\n  \"externalUrl\": \"<string>\",\n  \"useWebWrapper\": true,\n  \"deepLinkId\": \"<string>\",\n  \"deepLinkParameters\": {},\n  \"deepLinkUrl\": \"<string>\",\n  \"audienceIds\": [\n    \"<string>\"\n  ],\n  \"storeId\": \"<string>\",\n  \"storeIds\": [\n    \"<string>\"\n  ],\n  \"isBoardContent\": true,\n  \"customProperties\": {},\n  \"chainIds\": [\n    \"<string>\"\n  ],\n  \"priority\": 123,\n  \"requiresApproval\": true,\n  \"unifiedCampaignId\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json-patch+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}/feed/v1/Content")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json-patch+json")
  .body("{\n  \"authorId\": \"<string>\",\n  \"authorName\": \"<string>\",\n  \"title\": \"<string>\",\n  \"publishDate\": \"2023-11-07T05:31:56Z\",\n  \"expirationDate\": \"2023-11-07T05:31:56Z\",\n  \"isReadyToDistribute\": true,\n  \"createdBy\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"campaignName\": \"<string>\",\n  \"analyticsIdentifier\": \"<string>\",\n  \"imageUrl\": \"<string>\",\n  \"altText\": \"<string>\",\n  \"videoUrl\": \"<string>\",\n  \"topMessage\": \"<string>\",\n  \"bottomMessage\": \"<string>\",\n  \"longDescription\": \"<string>\",\n  \"buttonText\": \"<string>\",\n  \"externalUrl\": \"<string>\",\n  \"useWebWrapper\": true,\n  \"deepLinkId\": \"<string>\",\n  \"deepLinkParameters\": {},\n  \"deepLinkUrl\": \"<string>\",\n  \"audienceIds\": [\n    \"<string>\"\n  ],\n  \"storeId\": \"<string>\",\n  \"storeIds\": [\n    \"<string>\"\n  ],\n  \"isBoardContent\": true,\n  \"customProperties\": {},\n  \"chainIds\": [\n    \"<string>\"\n  ],\n  \"priority\": 123,\n  \"requiresApproval\": true,\n  \"unifiedCampaignId\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/feed/v1/Content")

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-patch+json'
request.body = "{\n  \"authorId\": \"<string>\",\n  \"authorName\": \"<string>\",\n  \"title\": \"<string>\",\n  \"publishDate\": \"2023-11-07T05:31:56Z\",\n  \"expirationDate\": \"2023-11-07T05:31:56Z\",\n  \"isReadyToDistribute\": true,\n  \"createdBy\": \"<string>\",\n  \"externalId\": \"<string>\",\n  \"campaignName\": \"<string>\",\n  \"analyticsIdentifier\": \"<string>\",\n  \"imageUrl\": \"<string>\",\n  \"altText\": \"<string>\",\n  \"videoUrl\": \"<string>\",\n  \"topMessage\": \"<string>\",\n  \"bottomMessage\": \"<string>\",\n  \"longDescription\": \"<string>\",\n  \"buttonText\": \"<string>\",\n  \"externalUrl\": \"<string>\",\n  \"useWebWrapper\": true,\n  \"deepLinkId\": \"<string>\",\n  \"deepLinkParameters\": {},\n  \"deepLinkUrl\": \"<string>\",\n  \"audienceIds\": [\n    \"<string>\"\n  ],\n  \"storeId\": \"<string>\",\n  \"storeIds\": [\n    \"<string>\"\n  ],\n  \"isBoardContent\": true,\n  \"customProperties\": {},\n  \"chainIds\": [\n    \"<string>\"\n  ],\n  \"priority\": 123,\n  \"requiresApproval\": true,\n  \"unifiedCampaignId\": \"<string>\"\n}"

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

{
  "id": 123
}

Authorizations

Authorization

string

header

required

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

Body

The request payload containing the information required to create a content item.

authorId

string

required

deprecated

Identifier of the author creating the content item.

Maximum string length: 100

authorName

string

required

deprecated

Name of the author creating the content item.

Maximum string length: 255

title

string

required

Title of the content item.

Maximum string length: 100

feedType

enum<string>

required

Available options:

Inspiration,

Purchase,

GreenNews,

StoreOffer,

StoreNews,

StoreSpecial,

GoodPrice,

WeeklyGoodPrice,

Survey,

Event,

SpecialPoll,

PartnerBenefit,

PartnerBenefitBanner

contentType

enum<string>

required

Available options:

Image,

Video,

Text

publishDate

string<date-time>

required

The date and time when the content should be published. This field is required if IsReadyToDistribute is true

expirationDate

string<date-time>

required

The date and time when the content expires and should no longer be displayed. This field is required if IsReadyToDistribute is true

isReadyToDistribute

boolean

required

Indicates whether the content is ready to be distributed.

createdBy

string | null

Optional identifier of the actor creating the content item; defaults to "integration" in the published event.

Maximum string length: 255

externalId

string | null

Optional external identifier for the content item.

Maximum string length: 50

campaignName

string | null

Name of the content to be easily identified.

Maximum string length: 100

analyticsIdentifier

string | null

Tracking identifier used for analytics.

Maximum string length: 50

imageUrl

string | null

URL of the image displayed in the content item.

Maximum string length: 2047

altText

string | null

Alternative text describing the image, used for accessibility.

Maximum string length: 255

videoUrl

string | null

URL of the video displayed in the content item.

Maximum string length: 2047

topMessage

string | null

Short message displayed at the top of the content.

bottomMessage

string | null

Short message displayed at the bottom of the content.

longDescription

string | null

Message displayed when the content type is text.

buttonText

string | null

Text displayed on the action button.

Maximum string length: 50

Available options:

External,

DeepLink

externalUrl

string | null

External URL to be opened when button is clicked.

Maximum string length: 2047

useWebWrapper

boolean | null

Indicates whether the external content should be opened in a web wrapper.

deepLinkId

string | null

Deep link identifier. Used to open a specific page from the application when button is clicked.

Maximum string length: 64

deepLinkParameters

object | null

Additional parameters for deep link. (e.g. redirect user to a specific entity from the page configured with DeepLinkId)

Show child attributes

deepLinkUrl

string | null

Deep link URL for navigation.

segmentationType

enum<string>

Available options:

None,

Audience,

Customer,

File

audienceIds

string[] | null

List of audience identifiers targeted by this content.

storeId

string | null

deprecated

Identifier of the store targeted by this content.

Maximum string length: 256

storeIds

string[] | null

List of store identifiers targeted by this content.

isBoardContent

boolean

Client specific property used for custom integration.

customProperties

object | null

Dictionary of custom properties.(e.g. logoUrl, terms)

Show child attributes

chainIds

string[] | null

List of chain identifiers targeted by this content.

priority

integer<int32> | null

Priority with which the content is displayed in the application.

requiresApproval

boolean | null

Indicates whether the content requires approval before being published.

unifiedCampaignId

string | null

Unified campaign identifier used for cross-platform campaign tracking.

Maximum string length: 64

Response

integer<int64>

required

Last modified on August 10, 2026

⌘I