Interface: CampaignResponse

API response for a campaign, as returned by GET /api/sdk/v2/campaigns. Contains the data structure as it comes from the server.

Properties

endDate?

optional endDate?: string | null;

ISO date string; null when the campaign has no end.

endTime?

optional endTime?: string | null;

id?

optional id?: string;

images?

optional images?: CampaignImageResponse[];

name?

optional name?: string;

order?

optional order?: number;

Alias of sortOrder.

schedules?

optional schedules?: CampaignScheduleResponse[];

sortOrder?

optional sortOrder?: number;

Per-group playlist order of this campaign (0 = first).

startDate?

optional startDate?: string;

ISO date string.

startTime?

optional startTime?: string;

status?

optional status?: string;