Campaigns

Fetch campaign

Get a Scribeless campaign by ID.

Fetch a campaign when your integration needs to check campaign configuration, campaign status, recipient metrics, or the product/template connected to a campaign.

GET https://platform.scribeless.co/api/campaigns/{campaignId}

Headers

X-API-Key: YOUR_API_KEY

Path parameters

Parameter	Type	Description
`campaignId`	string	Scribeless campaign ID.

Example request

curl --request GET 'https://platform.scribeless.co/api/campaigns/CAMPAIGN_ID' \
  --header 'X-API-Key: YOUR_API_KEY'

Successful requests return the campaign, its core configuration, product and template summary, recipient metrics, variables detected in the published template, and the latest rendered recipient where available.

{
  "id": "CAMPAIGN_ID",
  "name": "API postcard campaign",
  "status": "pending",
  "delivery_method": "directMail",
  "frequency": "oneTime",
  "include_envelope": false,
  "product": {
    "id": "PRODUCT_ID",
    "name": "A6 postcard",
    "category": "postcard",
    "standard": "ISO"
  },
  "template": {
    "id": "TEMPLATE_ID",
    "name": "Postcard template"
  },
  "latest_recipient": {
    "id": "RECIPIENT_ID"
  },
  "metrics": {
    "total": 12,
    "pending": 10,
    "ready": 2,
    "printing": 0,
    "shipped": 0,
    "delivered": 0,
    "deleted": 0
  },
  "variables": [
    {
      "id": "custom1",
      "label": "Custom 1"
    }
  ]
}

Notes

The response only includes campaigns your API key can access.
latest_recipient is returned when Scribeless has a rendered recipient to show for the campaign.
Use metrics when you need a quick campaign-level recipient count by status.
Treat any non-2xx response as failed and inspect the response body for the error message.

Status codes

Status	Meaning
`200`	Campaign found.
`401`	Missing, malformed, invalid, or unauthorized API key.
`500`	Campaign could not be fetched. Check the ID and retry, or contact support if it persists.

Create campaign

Create a Scribeless campaign through the API.

Create recipients