Skip to main content
POST
/
rewards_programs
/
{id}
/
promotions
Create a promotion
curl --request POST \
  --url https://api.pocketflows.com/rewards_programs/{id}/promotions \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "start_time": "<string>",
  "end_time": "<string>",
  "points_multiplier": 123,
  "description": "<string>",
  "image": "<any>"
}'
{
  "id": "<string>",
  "name": "<string>",
  "start_time": "<string>",
  "end_time": "<string>",
  "points_multiplier": 123,
  "description": "<string>",
  "image_url": "<string>"
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string
required

The ID of the rewards program

Body

application/json
name
string
required

The name of the promotion

start_time
string
required

The start time of the promotion

end_time
string
required

The end time of the promotion

points_multiplier
required

The points multiplier of the promotion

description
string
required

The description of the promotion

image
any

The cover image of the promotion used to display on the rewards program

Response

200 - application/json

The created Promotion object

id
string
required

The ID of the promotion

name
string
required

Name of the promotion

start_time
string
required

Start time of the promotion

end_time
string
required

End time of the promotion

points_multiplier
integer
required

Multiplier applied to earned points

description
string
required

Description of the promotion

image_url
string | null
required

URL of the promotion image

I