Sign in

v5

latestOpenAPI 3.1.02026-07-31151195455.5 KB
campaigns

Creates a campaign. Campaign scope only supports direct access edges: configuration.query.edgeFilter.directOnly defaults to true, is always stored as true, and passing false returns 400.

post/campaigns

Request body

namestring required

The name of the campaign.

Example request

{
  "name": "Q3 Access Review",
  "configuration": {
    "query": {
      "principalFilter": {
        "entityTypes": [
          "USER"
        ]
      }
    },
    "end_date": "2026-09-30T00:00:00Z",
    "timezone": "America/Los_Angeles"
  }
}

Response

The campaign successfully created.

campaign_idstring uuid required

The ID of the campaign.

namestring required

The name of the campaign.

status'DRAFT' | 'ONGOING' | 'COMPLETED' | 'STOPPED' | 'ENDED' required

The current status of a campaign.

is_templateboolean required

Whether this campaign is a recurring schedule template. Templates spawn draft campaigns on schedule rather than being reviewed directly.

created_atstring date-time required

The creation time of the campaign.

updated_atstring date-time required

The last updated time of the campaign.

created_by_user_idstring uuid required

The ID of the user who created the campaign.

started_atstring date-time nullable

The time the campaign was started, if started.

started_by_user_idstring uuid nullable

The ID of the user who started the campaign, if started.

stopped_atstring date-time nullable

The time the campaign was manually stopped, if stopped.

stopped_by_user_idstring uuid nullable

The ID of the user who stopped the campaign, if stopped.

ended_atstring date-time nullable

The time the campaign reached its scheduled end, if ended.

ended_by_user_idstring uuid nullable

The ID of the user who ended the campaign, if ended.

Example response

{
  "campaign_id": "f454d283-ca87-4a8a-bdbb-df212eca5353",
  "name": "Q3 Access Review",
  "status": "DRAFT",
  "is_template": false,
  "created_at": "2026-07-01T00:00:00Z",
  "updated_at": "2026-07-01T00:00:00Z",
  "created_by_user_id": "32acc112-21ff-4669-91c2-21e27683eaa1",
  "configuration": null,
  "started_at": null,
  "started_by_user_id": null,
  "stopped_at": null,
  "stopped_by_user_id": null,
  "ended_at": null,
  "ended_by_user_id": null
}