CampaignsVersion: v3New
Get Bulk Action Campaign by ID
GET/emails/locations/{locationId}/campaigns/bulk-actions/{campaignId}
Get a single bulk action campaign by its ID
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
Scope:
emails/Auth methods:
OAuthPrivate IntegrationToken type:
Sub-Account TokenRequest
Headers
Versionstringrequired
API Version
Available options
v3Example:
v3Path Parameters
locationIdstringrequired
Location ID
Example:
ve9EPM428h8vShlRW1KTcampaignIdstringrequired
Campaign ID
Example:
OI72xYec4Mho6VBykTvjResponse
Success
idstringrequired
Campaign ID
Example:
OI72xYec4Mho6VBykTvjsourcestring
Source of the campaign
Example:
email-marketingsourceIdstring
Source ID of the campaign
Example:
115b9030-907c-474c-90a5-2debd838a024namestring
Campaign name
Example:
Test Mailstatusstringrequired
Campaign status
Available options
processingscheduledpausedcompletecancelledExample:
completescheduleTypestring
Schedule type (NOW, SCHEDULED, or DRIP)
Available options
NOWSCHEDULEDDRIPExample:
SCHEDULEDfromNamestring
Sender name
Example:
John Doesubjectstring
Email subject line
Example:
Welcome to our newsletterpreviewTextstring
Preview text
Example:
Check out our latest updateseditorTypestring
Editor type for this campaign
Available options
htmlbuildertextExample:
htmlisPlainTextboolean
Whether the campaign uses plain text
Example:
falseeditorContentUrlstring
URL to fetch the rendered campaign content as HTML. Issue a GET against this URL to retrieve the body.
Example:
https://storage.googleapis.com/email-templates/abc123.htmldeletedbooleanrequired
Whether the campaign is deleted
Example:
falsecreatedAtstringrequired
Created at timestamp
Example:
2025-07-24T11:55:43.598ZupdatedAtstringrequired
Last updated timestamp
Example:
2026-02-09T04:49:12.322ZcompletedAtstring
Processing completion timestamp
Example:
2025-07-24T11:55:48.000ZtraceIdstring
Trace ID of the request
Example:
019e4ef5-a65e-4198-8cf9-8e93dca9bda4