Skip to main content
GET
Get campaign

Endpoints

  • GET /campaigns/:id
  • PATCH /campaigns/:id
Only drafts can be updated. Assigning from.address requires a verified domain in the current project; assigning audiences and a template version also requires them to belong to that project.

Update request

The response includes readiness reasons, selected-audience subscriber counts, and delivery analytics. A draft can be reviewed and scheduled from the SendRealm dashboard after it is ready.

Authorizations

Authorization
string
header
required

Integration key for backend workloads, or a scoped personal key (sr_user_) for account discovery and supported project operations. MCP accepts only personal keys.

Headers

X-Sendrealm-Project-Id
string<uuid>

Explicit project context. Required for personal-key project resource calls; integration keys retain their configured default. MCP clients supply project_id in each tool call instead.

Path Parameters

id
string<uuid>
required

Response

Campaign details

status
integer
required

HTTP response status code

data
object
required