Campaigns

Retrieve supplier campaigns

To use this capability, add octo/campaigns to your Octo-Capabilities header.

This capability adds the campaigns catalog endpoint.

List Campaigns

get

Returns all campaigns available for the resolved supplier.

Responses

200

Returns an array of campaign objects.

application/json

From capability octo/campaigns.

idstring · uuidRequired

Unique identifier for this resource.

Example: e7cc8bb4-8d1c-4848-8824-5dbedb718681

namestringRequired

Name value.

Example: Spring Campaign

typestringOptional

Type value.

Example: PERCENT

codestringOptional

Code value.

Example: SPRING10

startAtstringOptional

Start at value.

Example: 2026-03-01T00:00:00Z

endAtstringOptional

End at value.

Example: 2026-04-01T00:00:00Z

activebooleanOptional

Whether active is enabled.

Example: true

internalNamestringOptional

Internal name value.

Example: Morning City Tour

get/campaigns

GET /octo/campaigns HTTP/1.1
Host: api.ventrata.com
Accept: */*

200

Returns an array of campaign objects.

[
  {
    "id": "e7cc8bb4-8d1c-4848-8824-5dbedb718681",
    "name": "Spring Campaign",
    "type": "PERCENT",
    "code": "SPRING10",
    "startAt": "2026-03-01T00:00:00Z",
    "endAt": "2026-04-01T00:00:00Z",
    "active": true,
    "internalName": "Morning City Tour"
  }
]

Schema Additions (JSON)

These are additive fragments showing only fields introduced by this capability.

NotifyRequest

{
  "// ...rest of notify request object": "...",
  "campaignId": "campaign_spring_2026"
}