Campaigns

Public Create Campaign

Campaigns endpoint for POST /campaigns.

post/campaigns

Request

  • Base URL: https://public.outreach2day.com
  • URL: https://public.outreach2day.com/campaigns
  • Auth: HTTP bearer

Query parameters

workspaceIdinteger required

Headers

Idempotency-Keystring nullable

Request body

namestring required
priority'HIGH' | 'MEDIUM' | 'LOW'
priorityModestring nullable

Example request

{
  "schedule": {
    "timezone": "America/Los_Angeles",
    "weekdays": [
      "mon",
      "tue",
      "wed",
      "thu",
      "fri"
    ],
    "windows": [
      {
        "end": "18:00",
        "start": "10:00"
      }
    ]
  }
}

Response

Successful Response

idstring nullable
workspaceIdinteger nullable
namestring nullable
priority'HIGH' | 'MEDIUM' | 'LOW' nullable
status'draft' | 'active' | 'paused' | 'completed' | 'errored' | 'archived' | 'unknown' nullable
statusRawstring nullable

Original upstream status value before canonicalization. Present when aliased or unknown.

priorityModestring nullable
createdAtstring date-time nullable
updatedAtstring date-time nullable

Example response

{
  "statusRaw": "RUNNING"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.