Skip to main content
PATCH
Edit one of your top-up listings

Authorizations

Authorization
string
header
required

Your API key, from the cabinet under Seller → API keys.

Path Parameters

id
string<uuid>
required

Body

application/json

Every field optional; absent means "leave unchanged".

title
string
Required string length: 8 - 128
description
string
Maximum string length: 4096
price
integer<int64>

US cents.

images
string<uri>[]

Replaces the whole gallery.

Maximum array length: 10
tags
string[]

Replaces the whole list. Same limits as on create.

attributes
object

Replaces the whole map — send every field the category asks for, not only the one that changed.

delivery_type
enum<string>

Changing it replaces the listing's unit pool.

Available options:
instant,
manual
units
object[]

Read only when delivery_type switches to instant, as the pool the listing starts over with. Ignored otherwise: stock is added through POST .../units.

manual_delivery_value
integer<int32>

The handover time you promise.

manual_delivery_unit
enum<string>

What the value counts.

Available options:
minutes,
hours,
days
delivery_method
string

A key from GET /v1/offers/delivery-methods.

delivery_instructions
string

What the buyer is told to do at handover.

Maximum string length: 2048

Response

OK

How a listing sold by hand promises to hand over.

id
string<uuid>
title
string
description
string
attributes
object

The category's own fields, keyed by the schema's key.

tags
string[]
status
enum<string>

draft on create, then active once you publish it. paused and archived are yours too, through pause and DELETE. reserved and sold follow an order. removed is a takedown after publishing, which no call in this API performs.

Available options:
draft,
active,
paused,
reserved,
sold,
removed,
archived
created_at
string<date-time> | null
updated_at
string<date-time> | null
published_at
string<date-time> | null

When publish put it on the marketplace. null while it is a draft, and written once — pausing and unpausing leave it alone.

manual_delivery_value
integer<int32> | null

The handover time promised, read together with the unit — 2 and hours.

manual_delivery_unit
enum<string> | null

What the value counts. Both are null on a listing delivered instantly.

Available options:
minutes,
hours,
days,
null
price
integer<int64>

US cents.

currency
string

Always USD.

Example:

"USD"

images
string<uri>[]
delivery_type
enum<string>

instant sells out of the unit pool; manual you hand over yourself.

Available options:
instant,
manual
delivery_method
string | null

The key this listing hands over by.

delivery_instructions
string

What the buyer is told to do at handover.