Skip to main content
POST
/
api
/
public
/
email-campaign
Create an email campaign
curl --request POST \
  --url https://api.vambe.me/api/public/email-campaign \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "title": "<string>",
  "email_template_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email_channel_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recipients": [
    {
      "to_emails": [
        {
          "email": "jsmith@example.com",
          "name": "<string>"
        }
      ],
      "cc_emails": [
        {
          "email": "jsmith@example.com",
          "name": "<string>"
        }
      ],
      "bcc_emails": [
        {
          "email": "jsmith@example.com",
          "name": "<string>"
        }
      ],
      "variables": {},
      "attachments": [
        "<string>"
      ]
    }
  ]
}
'
{
  "id": "<string>",
  "title": "<string>",
  "status": "draft",
  "email_template_id": "<string>",
  "email_channel_id": "<string>",
  "scheduled_at": "2023-11-07T05:31:56Z",
  "sent_at": "2023-11-07T05:31:56Z",
  "total_recipients": 123,
  "created_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.vambe.me/llms.txt

Use this file to discover all available pages before exploring further.

Headers

x-api-key
string
required

API key needed to authorize the request

Body

application/json
title
string
required
Minimum string length: 1
email_template_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
email_channel_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
recipients
object[]
required
Minimum array length: 1
scheduled_at
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Response

id
string
required
title
string
required
status
enum<string>
required
Available options:
draft,
scheduled,
sending,
sent,
failed
email_template_id
string
required
email_channel_id
string
required
scheduled_at
string<date-time> | null
required
sent_at
string<date-time> | null
required
total_recipients
number
required
created_at
string<date-time>
required