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.

Endpoint

EndpointMethod
/api/admin/marketing/campaigns/{id}GET

Details

  • Requires an admin Bearer token in the Authorization header.
  • Unlike list rows, the detail endpoint resolves the channel, customerGroup, marketingTemplate, and marketingEvent objects. marketingEvent is an object or null when the campaign has no event.
  • An unknown id returns a 404.

Response fields

FieldTypeNotes
idintNumeric id
namestringCampaign name
subjectstringEmail subject line
statusint0 inactive / 1 active
channelobjectThe channel the campaign sends from — { id, code, name }. Detail-only (null on list rows)
customerGroupobjectThe customer group the campaign targets — { id, code, name }. Detail-only (null on list rows)
marketingTemplateobjectThe linked email template — { id, name, status }. Detail-only (null on list rows)
marketingEventobjectThe linked event — { id, name, date }, or null when the campaign has no event. Detail-only (null on list rows)
createdAtstringCreation timestamp
updatedAtstringLast-update timestamp

Released under the MIT License.