cURL

curl --request POST \
  --url https://api.opal.dev/v1/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Q3 Access Review",
  "configuration": {
    "end_date": "2026-09-30T00:00:00.000Z",
    "timezone": "America/Los_Angeles"
  }
}
'

import requests

url = "https://api.opal.dev/v1/campaigns"

payload = {
    "name": "Q3 Access Review",
    "configuration": {
        "end_date": "2026-09-30T00:00:00.000Z",
        "timezone": "America/Los_Angeles"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Q3 Access Review',
    configuration: {end_date: '2026-09-30T00:00:00.000Z', timezone: 'America/Los_Angeles'}
  })
};

fetch('https://api.opal.dev/v1/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.opal.dev/v1/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Q3 Access Review',
    'configuration' => [
        'end_date' => '2026-09-30T00:00:00.000Z',
        'timezone' => 'America/Los_Angeles'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.opal.dev/v1/campaigns"

	payload := strings.NewReader("{\n  \"name\": \"Q3 Access Review\",\n  \"configuration\": {\n    \"end_date\": \"2026-09-30T00:00:00.000Z\",\n    \"timezone\": \"America/Los_Angeles\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.opal.dev/v1/campaigns")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Q3 Access Review\",\n  \"configuration\": {\n    \"end_date\": \"2026-09-30T00:00:00.000Z\",\n    \"timezone\": \"America/Los_Angeles\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.opal.dev/v1/campaigns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Q3 Access Review\",\n  \"configuration\": {\n    \"end_date\": \"2026-09-30T00:00:00.000Z\",\n    \"timezone\": \"America/Los_Angeles\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "campaign_id": "f454d283-ca87-4a8a-bdbb-df212eca5353",
  "name": "Q3 Access Review",
  "status": "DRAFT",
  "is_template": false,
  "created_at": "2026-07-01T00:00:00.000Z",
  "updated_at": "2026-07-01T00:00:00.000Z",
  "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
}

POST

campaigns

cURL

curl --request POST \
  --url https://api.opal.dev/v1/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Q3 Access Review",
  "configuration": {
    "end_date": "2026-09-30T00:00:00.000Z",
    "timezone": "America/Los_Angeles"
  }
}
'

import requests

url = "https://api.opal.dev/v1/campaigns"

payload = {
    "name": "Q3 Access Review",
    "configuration": {
        "end_date": "2026-09-30T00:00:00.000Z",
        "timezone": "America/Los_Angeles"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Q3 Access Review',
    configuration: {end_date: '2026-09-30T00:00:00.000Z', timezone: 'America/Los_Angeles'}
  })
};

fetch('https://api.opal.dev/v1/campaigns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.opal.dev/v1/campaigns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Q3 Access Review',
    'configuration' => [
        'end_date' => '2026-09-30T00:00:00.000Z',
        'timezone' => 'America/Los_Angeles'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.opal.dev/v1/campaigns"

	payload := strings.NewReader("{\n  \"name\": \"Q3 Access Review\",\n  \"configuration\": {\n    \"end_date\": \"2026-09-30T00:00:00.000Z\",\n    \"timezone\": \"America/Los_Angeles\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.opal.dev/v1/campaigns")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Q3 Access Review\",\n  \"configuration\": {\n    \"end_date\": \"2026-09-30T00:00:00.000Z\",\n    \"timezone\": \"America/Los_Angeles\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.opal.dev/v1/campaigns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Q3 Access Review\",\n  \"configuration\": {\n    \"end_date\": \"2026-09-30T00:00:00.000Z\",\n    \"timezone\": \"America/Los_Angeles\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "campaign_id": "f454d283-ca87-4a8a-bdbb-df212eca5353",
  "name": "Q3 Access Review",
  "status": "DRAFT",
  "is_template": false,
  "created_at": "2026-07-01T00:00:00.000Z",
  "updated_at": "2026-07-01T00:00:00.000Z",
  "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
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

CreateCampaignInfo Object

Description

The CreateCampaignInfo object is used to create a campaign.

Usage Example

Use in the POST Campaigns endpoint.

name

string

required

The name of the campaign.

Example:

"Q3 Access Review"

configuration

object

required

Configuration for the campaign. Required; use an empty object to apply defaults.

Show child attributes

Example:

{
  "end_date": "2026-09-30T00:00:00.000Z",
  "timezone": "America/Los_Angeles",
  "allow_self_review": false
}

Response

201 - application/json

The campaign successfully created.

An access review campaign.

campaign_id

string<uuid>

required

The ID of the campaign.

Example:

"f454d283-ca87-4a8a-bdbb-df212eca5353"

name

string

required

The name of the campaign.

Example:

"Q3 Access Review"

status

enum<string>

required

The current status of a campaign.

Available options:

DRAFT,

ONGOING,

COMPLETED,

STOPPED,

ENDED

Example:

"ONGOING"

is_template

boolean

required

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

Example:

false

created_at

string<date-time>

required

The creation time of the campaign.

Example:

"2026-07-01T00:00:00.000Z"

updated_at

string<date-time>

required

The last updated time of the campaign.

Example:

"2026-07-01T00:00:00.000Z"

created_by_user_id

string<uuid>

required

The ID of the user who created the campaign.

Example:

"32acc112-21ff-4669-91c2-21e27683eaa1"

configuration

object | null

The campaign's configuration, if set.

Show child attributes

Example:

{
  "configuration_id": "39a4d283-ca87-4a8a-bdbb-df212eca5fdb",
  "created_at": "2026-07-01T00:00:00.000Z",
  "updated_at": "2026-07-01T00:00:00.000Z",
  "query": null,
  "reviewer_assignment_policy": "MANUALLY",
  "allow_self_review": false,
  "send_reviewer_assignment_notification": true,
  "allow_reviewer_reassignment": false,
  "start_date": null,
  "end_date": "2026-09-30T00:00:00.000Z",
  "timezone": "America/Los_Angeles",
  "revoke_on": "END",
  "reminder_schedule": [7, 3, 1],
  "reminder_include_manager": true,
  "require_reason_on_denial": false,
  "hide_ai_suggestions": false,
  "custom_start_message": null,
  "group_asset_visibility_policy": "STRICT",
  "is_template": false,
  "cron_expression": null,
  "next_scheduled_run": null,
  "last_scheduled_run": null,
  "recurring_duration_days": null
}

started_at

string<date-time> | null

The time the campaign was started, if started.

Example:

"2026-07-02T00:00:00.000Z"

started_by_user_id

string<uuid> | null

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

Example:

"32acc112-21ff-4669-91c2-21e27683eaa1"

stopped_at

string<date-time> | null

The time the campaign was manually stopped, if stopped.

Example:

"2026-07-10T00:00:00.000Z"

stopped_by_user_id

string<uuid> | null

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

Example:

"32acc112-21ff-4669-91c2-21e27683eaa1"

ended_at

string<date-time> | null

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

Example:

"2026-07-14T00:00:00.000Z"

ended_by_user_id

string<uuid> | null

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

Example:

"32acc112-21ff-4669-91c2-21e27683eaa1"

Last modified on July 27, 2026

Get campaigns Get campaign by ID

⌘I

API Concepts

SDKs

Opal API

Post campaigns

Authorizations

Body

CreateCampaignInfo Object

Description

Usage Example

Response