Rivier/ Reference/ campaigns

Pause, resume or change a schedule

patch/workspace/schedules/{id}

Before you call

Credential
Authorization: Bearer $KEY
Scope
campaigns:write
Graphql
Mutation.campaignsScheduleUpdate
Sdk
campaigns.schedule.update
Cli
campaigns schedule update

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • enabledboolean
  • cadencestring
    One of: hourly, daily, weekly.
  • namestring
    At most 120 characters.

Responses

  • 200application/json
    Success

    object

  • 400application/json
    The request was malformed
    • errorstringrequired
    • messagestring
  • 401application/json
    No valid credential
    • errorstringrequired
    • messagestring
  • 403application/json
    The credential lacks the scope, origin or address
    • errorstringrequired
    • messagestring
  • 429application/json
    Over the key's rate limit; see Retry-After
    • errorstringrequired
    • messagestring

This page as Markdown