Skip to content

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

OperationTypePurpose
adminMarketingCampaignQueryFetch one campaign by id

Details

  • Requires an admin Bearer token in the Authorization header.
  • Pass the campaign's IRI (e.g. /api/admin/marketing/campaigns/5) as the id argument; _id in the response is the numeric id.
  • Unlike list rows, the detail query resolves the channel, customerGroup, and marketingTemplate objects — 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 or null when the campaign has no event.

Fields

FieldTypeNotes
idIDThe campaign's IRI
_idIntNumeric id
nameStringCampaign name
subjectStringEmail subject line
statusInt0 inactive / 1 active
channelObjectThe channel the campaign sends in — sub-select id, _id, code, name. Detail-only (null on list rows)
customerGroupObjectThe recipient customer group — sub-select id, _id, code, name. Detail-only (null on list rows)
marketingTemplateObjectThe linked email template — sub-select id, _id, name, status. Detail-only (null on list rows)
marketingEventThe linked event. REST-only — not field-selectable over GraphQL; read it via the REST detail
createdAtStringCreation timestamp
updatedAtStringLast-update timestamp

Released under the MIT License.