Skip to main content
PATCH
Upsert reward code external id

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required
codeId
string<uuid>
required

Body

application/json
system
enum<string>
required
Available options:
shopify,
stripe
discountId
string
required
Required string length: 1 - 500
syncStatus
enum<string>
required
Available options:
synced,
pending,
error
codeId
string | null
Required string length: 1 - 500
error
string | null
Maximum string length: 2000

Response

object | null

Successful response

id
string<uuid>
required
rewardId
string<uuid>
required
code
string
required
status
enum<string>
required
Available options:
available,
reserved,
redeemed,
expired,
revoked
reservedFor
string | null
required
redeemedBy
string | null
required
redeemedAt
string | null
required
orderId
string | null
required
externalOrderId
string | null
required
createdAt
string
required
expiresAt
string | null
required
updatedAt
string | null
required
externalIds
object
required