Skip to content
RallyHere Docs

Create External Key Campaigns

POST
/v1/sandbox/{sandbox_id}/external-key-campaign

Create External Key Campaigns. Requires permission sandbox:config:edit.

Authorizations

Parameters

Path Parameters

sandbox_id
required

Sandbox ID

string format: uuid

Sandbox ID

Request Body required

A collection of External Key Campaigns to create.

object
data
required

The External Key Campaigns to create.

Array<object>
>= 1 items

External Key Campaign to create.

object
custom_data

Custom data associated with the resource

object
key
additional properties
string
name

Name of the resource

string
>= 1 characters <= 125 characters
description

Description of the resource

string
>= 1 characters <= 250 characters
key_types

The types of keys that can be distributed by this campaign.

Array<string>
default:

Responses

201

Successful Response

Array<object>

A campaign to distribute external keys to players.

object
custom_data

Custom data associated with the resource

object
key
additional properties
string
name

Name of the resource

string
>= 1 characters <= 125 characters
description

Description of the resource

string
>= 1 characters <= 250 characters
key_types

The types of keys that can be distributed by this campaign.

Array<string>
default:
sandbox_id

ID of the Sandbox

string format: uuid
last_modified_account_id

Account ID of the user who last modified the resource

string format: uuid
last_modified_timestamp

Timestamp of when the resource was last modified

string format: date-time
created_timestamp

Timestamp of when the resource was created

string format: date-time
external_key_campaign_id
required

The External Key Campaign ID.

string format: uuid

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string