Schedule a campaign event for a campaign

post/campaigns/{id}/schedule

Request

Base URL
https://rudder.example.com/rudder/api/latest
Auth
API key in header X-API-Token
TypeScript
https://skmtc.dev/rudder/apis/rudder-api/docs/campaigns/:id/schedule/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

Example:0076a379-f32d-4732-9e91-33ab219d8fde

Id of the campaign

Response

Campaign events details result

result'success' | 'error' required

Result of the request

action'scheduleCampaign' required

The id of the action

Example response

{
  "data": {
    "campaignEvents": [
      {
        "id": "0076a379-f32d-4732-9e91-33ab219d8fde",
        "name": "Update all systems #1"
      }
    ]
  }
}

Changes

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