Skip to main content
GET
Get Campaign Settings
This endpoint requires at least the Email Pro plan.
The response is not wrapped in data.
  • general.labels, general.sequenceId, senders.espRouting and schedule.scheduleIds are read-only.
  • senders.espMatching gives the team value when the campaign does not set it.
  • A campaign hidden from the user of the API key answers 404. An API key not linked to a user acts as the first user of the team.

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

campaignId
string
required

The unique identifier of the campaign

Response

Success

All the settings of a campaign.

campaignId
string
required

The campaign ID.

timezone
string | null
required

The campaign timezone, null when not set.

senderStrategy
string
required

How the campaign picks the sender of each lead: random (the sender pool), contactOwner, leadImporter or customField:<fieldName>.

Pattern: ^(random|contactOwner|leadImporter|customField:.+)$
general
object
required

Labels, sequence and unsubscribe link.

senders
object
required

Sender matching.

automation
object
required

Auto-review.

tracking
object
required

Open, click and reply tracking.

onReplied
object
required

What happens when a lead replies.

What happens when a lead clicks a tracked link.

onMeetingBooked
object
required

What happens when a lead books a meeting.

aiFeatures
object
required

AI reply handling.

schedule
object
required

Sending schedule options. Read and change the schedules themselves with the Schedules endpoints.