Skip to main content
Version: v3New

Get Email Campaign by ID

GET 
/emails/locations/:locationId/campaigns/emails/:campaignId

Get a single email campaign by its ID

Request​

Version stringrequired

API Version

Available optionsv3
locationId stringrequired

Location ID

campaignId stringrequired

Campaign ID

application/json

Success

Schema
    idstringrequired

    Campaign ID

    sourcestring

    Source of the campaign

    sourceIdstring

    Source ID of the campaign

    namestring

    Campaign name

    statusstring

    Campaign status

    Available optionsallsentfailedarchiveddraftprocessingscheduledcancelledpaused
    campaignTypestring

    Campaign delivery type

    campaignCategorystring

    Campaign category

    variationsobject[]

    AB test variation identifiers (available only for AB test campaigns)

    editorTypestring

    Original editor type the campaign was created with

    Available optionshtmlbuildertext
    isPlainTextboolean

    Whether the campaign uses plain text

    editorContentUrlstring

    URL to fetch the rendered campaign content as HTML. Issue a GET against this URL to retrieve the body.

    fromNamestring

    Sender name

    fromEmailstring

    Sender email address

    subjectstring

    Email subject line

    replyToAddressstring

    Reply-to email address

    previewTextstring

    Preview text

    deletedbooleanrequired

    Whether the campaign is deleted

    createdAtstringrequired

    Created at timestamp

    updatedAtstringrequired

    Last updated timestamp

    traceIdstring

    Trace ID of the request