Skip to navigation

Get Email Campaign

View as Markdown

Returns one campaign with the same fields as Get Email Campaign List.

For a Tribe Campaign it also returns tribe_campaigns: one entry per tribe that has sent its copy, each with its own id, tribe_id, tribe, status, sent_at and counts. The Tribe Campaign’s own counts are the sum of those entries.

A campaign that has not finished sending, or that belongs to another organisation or tribe, returns 404.

API key permissions — a key limited to chosen endpoints needs Marketing › Email Campaigns ticked, or it gets 403.

Not cached, because the numbers change as opens and clicks arrive. Success is HTTP 201, not 200.

Full guide: Email campaign results on the API.

Path parameters

idstringRequired

Headers

GorillaDash-Api-KeystringOptional
Gorilla Dash API Key
GorillaDash-Api-SecretstringOptional
Gorilla Dash API Secret

Response

Created
statusinteger
successboolean
dataobject