Campaigns | Orishare docs

List campaigns

Authorization

bearer

AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Response Body

`application/json`

curl -X GET "https://example.com/campaigns"

{  "data": [    {      "id": "string",      "name": "string",      "status": "draft",      "starts_at": "string",      "ends_at": "string",      "priority": 0,      "stacking_group": "string",      "exclusive": true,      "budget": {        "amount": 0,        "currency": "string",        "window": "string",        "used": 0      },      "audience": {        "segments": [          "string"        ]      },      "version": 0,      "created_at": "string",      "updated_at": "string"    }  ],  "next_cursor": "string",  "has_more": true}

Create a campaign

Authorization

bearer

AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Header Parameters

Idempotency-Key?string

Required by the API on this route (400 idempotency_key_required without it); the official clients generate a UUID when you omit it.

Length1 <= length <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 120

status?string

Value in

"draft"
"active"
"paused"
"ended"

starts_at?|null

ends_at?|null

priority?integer

Range-9007199254740991 <= value <= 9007199254740991

stacking_group?|null

exclusive?boolean

budget?|null

audience?|null

Response Body

`application/json`

curl -X POST "https://example.com/campaigns" \  -H "Content-Type: application/json" \  -d '{    "name": "Launch week",    "status": "active",    "priority": 10,    "budget": {      "amount": 100000,      "currency": "points",      "window": "none"    }  }'

{  "id": "string",  "name": "string",  "status": "draft",  "starts_at": "string",  "ends_at": "string",  "priority": 0,  "stacking_group": "string",  "exclusive": true,  "budget": {    "amount": 0,    "currency": "string",    "window": "string",    "used": 0  },  "audience": {    "segments": [      "string"    ]  },  "version": 0,  "created_at": "string",  "updated_at": "string"}

One campaign with budget usage

Authorization

bearer

AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string

Length1 <= length

Response Body

`application/json`

curl -X GET "https://example.com/campaigns/string"

{  "id": "string",  "name": "string",  "status": "draft",  "starts_at": "string",  "ends_at": "string",  "priority": 0,  "stacking_group": "string",  "exclusive": true,  "budget": {    "amount": 0,    "currency": "string",    "window": "string",    "used": 0  },  "audience": {    "segments": [      "string"    ]  },  "version": 0,  "created_at": "string",  "updated_at": "string"}

Update schedule, priority, stacking, budget, audience or status

Authorization

bearer

AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?string

Length1 <= length <= 120

status?string

Value in

"draft"
"active"
"paused"
"ended"

starts_at?|null

ends_at?|null

priority?integer

Range-9007199254740991 <= value <= 9007199254740991

stacking_group?|null

exclusive?boolean

budget?|null

audience?|null

Response Body

`application/json`

curl -X PATCH "https://example.com/campaigns/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "id": "string",  "name": "string",  "status": "draft",  "starts_at": "string",  "ends_at": "string",  "priority": 0,  "stacking_group": "string",  "exclusive": true,  "budget": {    "amount": 0,    "currency": "string",    "window": "string",    "used": 0  },  "audience": {    "segments": [      "string"    ]  },  "version": 0,  "created_at": "string",  "updated_at": "string"}

Delete a draft or ended campaign with no rules

Authorization

bearer

AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string

Length1 <= length

Response Body

`application/json`

curl -X DELETE "https://example.com/campaigns/string"

Empty

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

204

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`