Update campaign schedule

Update schedule

Use this endpoint to update the schedule of an existing campaign.

Consider the following points before using the API:

• Campaigns in the following statuses cannot be updated:

  • Completed
  • Archived
  • Executing

• Launched campaigns can be updated based on the campaign type:

  • One-time, recurring & segment-triggered: Cannot be updated.
  • Event-triggered: This can be updated, but changes may take up to 20 minutes to propagate.

Payload options

• One-time campaigns:

  • startdate: Specify the campaign start date.

• Segment-triggered campaigns:

  • startdate: Specify the campaign start date.
  • enddate: Specify the campaign end date.
  • recurring_schedule: Specify the schedule type (daily or continuously).

• Event-triggered campaigns:

  • startdate: Specify the campaign start date.
  • enddate: Specify the campaign end date.

• Live content campaigns:

  • startdate: Specify the campaign start date.
  • enddate: Specify the campaign end date.

• Recurring campaigns:

  • startdate: Specify the campaign start date.
  • enddate: Specify the campaign end date.
  • repeating_schedule_attributes: Configure recurring schedule with the following properties:
    • interval_size: Positive integer indicating the recurrence interval.
    • interval_unit: One of day, week, or month.
    • day_of_month: Specify the monthly schedule type:
      • nth_day: Executes on the nth day of each month, based on the campaign start date.
      • nth_weekday: Executes on the nth occurrence of a specific weekday each month, e.g., the 1st Wednesday.
      • last_day: Executes on the last calendar day of each month.
    • days_of_week: Array of days, e.g., ['mon', 'tue', 'wed'].

Note

You can find the campaign_uuid (campaign ID) in the campaign editor's URL.

Try it out

1. Add the User API key as the Username and leave the Password field blank.
2. Click the Base URL dropdown and select the API endpoint URL for your Blueshift region.
3. Click Try It.

You can also try the API using Blueshift's API collection in Postman.