POST /v1/campaigns – Dayschedule Appointment Scheduling API

Campaigns

Create a campaign

post/v1/campaigns

Request

Base URL: https://api.dayschedule.com/v1
URL: https://api.dayschedule.com/v1/v1/campaigns
Auth: none declared

Request body

campaign_idnumber nullable

account_idnumber nullable

user_idnumber nullable

namestring required

descriptionstring nullable

type'email'

message_type'regular' | 'abtest'

connection_idnumber required

Must be a valid connection_id for email provider

last_run_atstring date-time nullable

next_run_atstring date-time nullable

is_enabledboolean

status'completed' | 'running' | 'scheduled' | 'throttled' | 'null' nullable

sentnumber nullable

opennumber nullable

clicknumber nullable

created_atstring nullable

updated_atstring nullable

Example request

{
  "campaign_id": 123,
  "account_id": 456,
  "user_id": 789,
  "name": "Newsletter Campaign",
  "description": "Monthly newsletter campaign",
  "type": "email",
  "contacts": {
    "type": "all",
    "selected": [
      1,
      2,
      3
    ]
  },
  "message_type": "regular",
  "messages": [
    {
      "body": "Hello, this is a test email.",
      "subject": "Test Email"
    }
  ],
  "connection_id": 321,
  "schedule": {
    "date": "1970-01-01T00:00:00.000Z"
  },
  "last_run_at": "1970-01-01T00:00:00.000Z",
  "next_run_at": "1970-01-01T00:00:00.000Z",
  "is_enabled": true,
  "status": "scheduled",
  "sent": 100,
  "open": 50,
  "click": 10,
  "options": {
    "hours": {
      "start": "09:00",
      "end": "17:00"
    }
  },
  "updated_at": "1970-01-01T00:00:00.000Z"
}

Response