API Reference/Quickstart

Quickstart

Get an API key and reach a successful, real API response in five steps.

01

Create an API key

API access is granted per account by Stynar, not by plan. Contact support to request it. Once enabled, go to Settings → API Access and click Create API Key. Copy it immediately — it's shown once, in full.

02

Authenticate

Send your key as a Bearer token on every request. Call Get account to confirm it works.

curl "https://api.stynar.com/v1/account" \
  -H "Authorization: Bearer esk_your_key_here"
03

Create a campaign

Create a DRAFT campaign — the same starting point as clicking “New Campaign” in the app.

curl -X POST "https://api.stynar.com/v1/campaigns/" \
  -H "Authorization: Bearer esk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"name":"Q3 outbound","mail":{"subject":"Quick question about {{company}}","body":"<p>Hi {{firstName}},</p>..."}}'
04

Check the response

You'll get back the created campaign, including its campaignId — you'll need it for the next step.

201 response
{
  "campaign": {
    "campaignId": "cmp_abc123",
    "name": "Q3 outbound",
    "status": "DRAFT",
    "senderIds": [],
    "mail": {
      "subject": "Quick question about {{company}}",
      "body": "<p>Hi {{firstName}},</p>..."
    },
    "createdAt": "2026-08-16T10:02:11Z"
  }
}
05

Start the campaign

Start it once it has a sender and leads — identical behavior to clicking “Start” in the app.

curl -X POST "https://api.stynar.com/v1/campaigns/cmp_abc123/start" \
  -H "Authorization: Bearer esk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{}'

That's a full create → check → start loop. From here, browse the API Reference for every other endpoint — leads, templates, meetings, AI prompts, and sending accounts.