Skip to main content
POST
Create a promotion

Authorizations

Authorization
string
header
required

API key from the Rigaly dashboard: Authorization: Bearer rgly_sk_...

Body

application/json

On create, title is required (3–255 chars); on update, all fields are optional.

title
string
Required string length: 3 - 255
Example:

"Double points weekend"

description
string | null
Maximum string length: 1000
active
boolean
default:false

Defaults to false (inactive) on create — set true to publish immediately.

start_date
string<date> | null
Example:

"2026-08-01"

end_date
string<date> | null
Example:

"2026-08-03"

time_active
object

Per-day time-of-day windows. Omit a day to leave it unrestricted; omit the whole field for always-active.

Example:

Response

Promotion created

success
boolean
Example:

true

message
string
data
object