Campaigns

Public Update Campaign Schedule

Campaigns endpoint for PUT /campaigns/{campaign_id}/schedule.

put/campaigns/{campaign_id}/schedule

Request

  • Base URL: https://public.outreach2day.com
  • URL: https://public.outreach2day.com/campaigns/{campaign_id}/schedule
  • Auth: HTTP bearer

Path parameters

campaign_idstring required

Query parameters

workspaceIdinteger required

Request body

timezonestring required

IANA timezone, e.g. America/Los_Angeles

weekdaysstring[] required

Example request

{
  "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 1 revision of this API.