Review a promotion purchase

POST

/api/v3/promotions/purchases/{purchaseUniqueId}

curl --request POST \
  --url 'https://api.tryletterhead.com/api/v3/promotions/purchases/example?api=true' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "status": "rejected", "feedback": "The creative image is below our minimum resolution requirement." }'

• Production

The publisher’s review decision on a pending purchase: approve it, reject it, or request changes from the advertiser. feedback is required when rejecting or requesting changes, so the buyer knows why. A purchase’s payment status is never editable here.

v3 endpoints expect a company API key.

Authorizations

• bearerAuth

Parameters

Path Parameters

purchaseUniqueId

required

string

UUID of the purchase to review

Query Parameters

api

required

boolean

Required. Set to true.

Request Body ^required

Media type application/json

object

status

required

approved | rejected | changesRequested

string

feedback

Required when status is rejected or changesRequested. Max 2000 characters.

string

Example

{
  "status": "rejected",
  "feedback": "The creative image is below our minimum resolution requirement."
}

Responses

200

200 OK

Media type application/json

object

items

string

nullable

message

string

total

integer

Example

{
  "items": null,
  "message": "Promotion purchase rejected successfully",
  "total": 1
}