Campaigns

Patch campaign by id

patch/v1/campaigns/:id

Request

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

Path parameters

idnumber required

Request body

namestring
descriptionstring nullable
type'email'
message_type'regular' | 'abtest'
connection_idnumber

Must be a valid connection_id for email provider

is_enabledboolean

Example request

{
  "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"
  },
  "is_enabled": true,
  "options": {
    "hours": {
      "start": "09:00",
      "end": "17:00"
    }
  }
}

Response

OK

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.