Campaign Detail
Returns a single campaign with its full field set — the data behind the admin Marketing → Communications → Campaigns view screen.
TIP
New here? Read the Campaigns overview for what a campaign does and how its fields behave.
Operation
| Operation | Type | Purpose |
|---|---|---|
adminMarketingCampaign | Query | Fetch one campaign by id |
Details
- Requires an admin Bearer token in the
Authorizationheader. - Pass the campaign's IRI (e.g.
/api/admin/marketing/campaigns/5) as theidargument;_idin the response is the numeric id. - Unlike list rows, the detail query resolves the
channel,customerGroup, andmarketingTemplateobjects — sub-select the fields you need from each. - The campaign's event is REST-only: it is not field-selectable over GraphQL. Read it via the REST detail (
marketingEvent), which is an object ornullwhen the campaign has no event.
Fields
| Field | Type | Notes |
|---|---|---|
id | ID | The campaign's IRI |
_id | Int | Numeric id |
name | String | Campaign name |
subject | String | Email subject line |
status | Int | 0 inactive / 1 active |
channel | Object | The channel the campaign sends in — sub-select id, _id, code, name. Detail-only (null on list rows) |
customerGroup | Object | The recipient customer group — sub-select id, _id, code, name. Detail-only (null on list rows) |
marketingTemplate | Object | The linked email template — sub-select id, _id, name, status. Detail-only (null on list rows) |
marketingEvent | — | The linked event. REST-only — not field-selectable over GraphQL; read it via the REST detail |
createdAt | String | Creation timestamp |
updatedAt | String | Last-update timestamp |

