Skip to main content
PATCH
/
v1alpha1
/
offers
/
{id}
UpdateOffer
curl --request PATCH \
  --url https://api.toffeepay.com/v1alpha1/offers/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "description": "<string>",
  "image": "<string>",
  "category": "<string>",
  "label": "<string>",
  "items": [
    {
      "id": "<string>",
      "icon": "<string>",
      "amount": 123
    }
  ],
  "price": 123,
  "stock": 123,
  "country": "<string>",
  "return_url": "<string>",
  "wallet_enabled": true
}
'
{}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
title
string | null
​
description
string | null
​
image
string | null
Pattern: ^(https?://|data:)
​
category
string | null
​
label
string | null
​
status
enum<string> | null
Available options:
inactive,
active
​
items
OfferItem · object[]
Minimum array length: 1
​
price
integer<int32> | null
​
currency
enum<string> | null
Available options:
USD,
GBP,
EUR
​
stock
integer<int32> | null
​
country
string | null

ISO 3166-1 alpha-2: "US", "GB", "DE"

Required string length: 2
Pattern: ^[A-Z]{2}$
​
return_url
string<uri> | null
​
wallet_enabled
boolean | null

Response

200 - application/json

Success

The response is of type UpdateOfferResponse · object.