Skip to main content
POST
Upsert prompt

Authorizations

Authorization
string
header
required

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

Body

The payload containing the details of the prompt to upsert.

title
string
required

Title of the prompt.

Maximum string length: 100
type
enum<string>
required
Available options:
ThirdPartyConsent,
Regular,
PreferredStore,
PushConsent
startDate
string<date-time>
required

Start date and time when the prompt becomes active. Required if Prompt.Api.DTO.Requests.Admin.UpsertPromptRequest.IsReadyToDistribute is true.

id
integer<int32> | null

Internal identifier of the prompt (optional for creation, required for update).

headline
string | null

Optional headline displayed for the prompt.

Maximum string length: 255
body
string | null

Optional detailed body content of the prompt.

Maximum string length: 5000
imageId
integer<int32> | null

Optional identifier of an image associated with the prompt.

imageUrl
string | null

Optional URL of an image to be displayed inside the the prompt.

approveButtonText
string | null

Text displayed on the approve button for the prompt.

Maximum string length: 255
declineButtonText
string | null

Text displayed on the decline button for the prompt.

Maximum string length: 255
segmentationType
enum<string>
Available options:
All,
File,
ExternalSource,
Audience,
Customer
segmentationFileIds
integer<int32>[] | null

Optional list of file IDs used for segmentation.

endDate
string<date-time> | null

Optional end date and time when the prompt expires.

validForDays
integer<int32> | null

Optional number of days a member-specific prompt remains valid after allocation.

isReadyToDistribute
boolean

Indicates whether the prompt is ready to be distributed.

metadata
object
source
string | null

Optional source information for the prompt.

Maximum string length: 300
analyticsIdentifier
string | null

Tracking identifier used for analytics.

Maximum string length: 300
unifiedCampaignId
string | null

Optional unified campaign identifier.

Maximum string length: 64
segmentationFileUrls
string[] | null

Collection of URLs pointing to segmentation files associated with the prompt.

authorId
string | null

Unique identifier of the author.

Maximum string length: 255
authorName
string | null

Name of the author.

Maximum string length: 255

Response

Success

id
integer<int32>

Unique identifier of the upserted prompt

Last modified on August 10, 2026