Кампанит ажил

Түншүүдэд илгээх и-мэйл кампанит ажил.

GET/v1/workspaces/{workspaceId}/campaigns

Campaigns of the program, oldest first.

Шаардлагатай API түлхүүрийн хамрах хүрээ: campaigns.read

Параметр (6)

Нэр	Байрлал	Төрөл	Заавал
`workspaceId`	path	string	тийм
`kind`	query	string
`status`	query	string
`pageSize`	query	integer (int32)
`startingAfter`	query	string
`endingBefore`	query	string

Хариу: 200 CampaignDto[]

POST/v1/workspaces/{workspaceId}/campaigns

Create a draft (R26, R27, R28, R29). 422 for unknown variables and unsafe links.

Шаардлагатай API түлхүүрийн хамрах хүрээ: campaigns.write

Параметр (1)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм

Хүсэлтийн бие (CreateCampaign)

Нэр	Төрөл	Заавал	Тайлбар
`kind`	string	тийм	`marketing` or `transactional`.
`name`	string	тийм
`subject`	string	тийм
`previewText`	string
`body`	string	тийм	Markdown, up to 100,000 characters; `{{variables}}` allowed.
`fromName`	string
`locales`	object		Per-locale variants: `{ "mn": { "subject", "previewText", "body" } }`.
`groupIds`	string[]
`partnerTagIds`	string[]
`statuses`	array
`conditions`	object		Transactional only: `joinsProgram` or a set of milestone conditions (AND).
`trackOpens`	boolean
`trackClicks`	boolean

Хариу: 201 CampaignDto

GET/v1/workspaces/{workspaceId}/campaigns/{campaignId}

One campaign with the live audience estimate and counters.

Шаардлагатай API түлхүүрийн хамрах хүрээ: campaigns.read

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`campaignId`	path	string	тийм

Хариу: 200 CampaignDto

PATCH/v1/workspaces/{workspaceId}/campaigns/{campaignId}

Edit a campaign: marketing drafts only (R33); transactional campaigns may change while active and then only affect partners not yet sent (R34, audited).

Шаардлагатай API түлхүүрийн хамрах хүрээ: campaigns.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`campaignId`	path	string	тийм

Хүсэлтийн бие (PatchCampaign)

Нэр	Төрөл	Заавал	Тайлбар
`name`	string
`subject`	string
`previewText`	string
`body`	string
`fromName`	string
`locales`	object
`groupIds`	array
`partnerTagIds`	array
`statuses`	array
`conditions`	object
`trackOpens`	boolean
`trackClicks`	boolean

Хариу: 200 CampaignDto

DELETE/v1/workspaces/{workspaceId}/campaigns/{campaignId}

Delete a draft or canceled marketing campaign, or a draft or archived transactional one (R33).

Шаардлагатай API түлхүүрийн хамрах хүрээ: campaigns.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`campaignId`	path	string	тийм

Хариу: 204

POST/v1/workspaces/{workspaceId}/campaigns/{campaignId}/activate

Activate a transactional campaign (R34): only active campaigns evaluate triggers.

Шаардлагатай API түлхүүрийн хамрах хүрээ: campaigns.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`campaignId`	path	string	тийм

Хүсэлтийн бие (ActivateBody)

Нэр	Төрөл	Заавал	Тайлбар
`sendToExisting`	boolean		Also send to partners who already satisfy the condition (default off, R29).

Хариу: 200 CampaignDto

POST/v1/workspaces/{workspaceId}/campaigns/{campaignId}/archive

Archive a transactional campaign.

Шаардлагатай API түлхүүрийн хамрах хүрээ: campaigns.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`campaignId`	path	string	тийм

Хариу: 200 CampaignDto

POST/v1/workspaces/{workspaceId}/campaigns/{campaignId}/cancel

Cancel a marketing campaign; mails already sent stay sent (R33).

Шаардлагатай API түлхүүрийн хамрах хүрээ: campaigns.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`campaignId`	path	string	тийм

Хариу: 200 CampaignDto

POST/v1/workspaces/{workspaceId}/campaigns/{campaignId}/pause

Pause a sending marketing campaign or an active transactional one.

Шаардлагатай API түлхүүрийн хамрах хүрээ: campaigns.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`campaignId`	path	string	тийм

Хариу: 200 CampaignDto

POST/v1/workspaces/{workspaceId}/campaigns/{campaignId}/preview

Email the rendered campaign to up to five addresses (R32): prefixed subject, not tracked, not counted, no working unsubscribe, ten per user and hour.

Шаардлагатай API түлхүүрийн хамрах хүрээ: campaigns.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`campaignId`	path	string	тийм

Хүсэлтийн бие (PreviewBody)

Нэр	Төрөл	Заавал	Тайлбар
`template`	string	тийм
`locale`	string		`en` (default) or `mn`.
`vars`	object

Хариу: 202 Queued

GET/v1/workspaces/{workspaceId}/campaigns/{campaignId}/recipients

Recipients with their delivery state (R45).

Шаардлагатай API түлхүүрийн хамрах хүрээ: campaigns.read

Параметр (8)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`campaignId`	path	string	тийм
`status`	query	string
`opened`	query	boolean		Only recipients who opened (hidden for opt-outs and automatic opens, R45).
`clicked`	query	boolean
`bounced`	query	boolean
`pageSize`	query	integer (int32)
`startingAfter`	query	string

Хариу: 200 RecipientDto[]

POST/v1/workspaces/{workspaceId}/campaigns/{campaignId}/resume

Resume a paused campaign (also after the bounce guard).

Шаардлагатай API түлхүүрийн хамрах хүрээ: campaigns.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`campaignId`	path	string	тийм

Хариу: 200 CampaignDto

POST/v1/workspaces/{workspaceId}/campaigns/{campaignId}/send

Send now or schedule a marketing campaign (R33, R35, R48).

Шаардлагатай API түлхүүрийн хамрах хүрээ: campaigns.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`campaignId`	path	string	тийм

Хүсэлтийн бие (SendBody)

Нэр	Төрөл	Заавал	Тайлбар
`scheduledAt`	string (date-time)		At least 5 minutes and at most 90 days ahead; omit to send now.

Хариу: 202 CampaignDto

GET/v1/workspaces/{workspaceId}/campaigns/{campaignId}/stats

Counters of the campaign (R45).

Шаардлагатай API түлхүүрийн хамрах хүрээ: campaigns.read

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`campaignId`	path	string	тийм

Хариу: 200

POST/v1/workspaces/{workspaceId}/campaigns/{campaignId}/unschedule

Back to draft from scheduled; not within 5 minutes of the send time (R33).

Шаардлагатай API түлхүүрийн хамрах хүрээ: campaigns.write

Параметр (2)

Нэр	Байрлал	Төрөл	Заавал	Тайлбар
`workspaceId`	path	string	тийм
`campaignId`	path	string	тийм

Хариу: 200 CampaignDto