Skip to main content
PATCH
Update an item

Authorizations

Authorization
string
header
required

An API key created by the chain owner in the panel (Integrações → Nova chave), sent as Authorization: Bearer <key>. The key (<id>|na_…) is shown once, at creation; rotate or revoke it on the same screen. It is a server secret: never ship it in browser or mobile code.

Headers

Accept-Language
enum<string>

Language of message and of translated content such as item names (pt-BR or en). Without it, the chain's default language.

Available options:
pt-BR,
en
X-Request-Id
string

Your own correlation id (1–64 characters of A-Za-z0-9._-), echoed back; generated when absent. Quote it to support.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9._-]{1,64}$

Path Parameters

establishment
integer
required

The establishment ID

item
integer
required

The item ID

Body

application/json
queue_type
enum<string>
Available options:
single,
recurring
status
enum<string>
Available options:
active,
paused
external_reference
string | null
Maximum string length: 100
attributes
object | null

Free-form object of up to 50 keys whose values are scalars, null or lists of scalars. When sent, replaces the whole object.

translations
object

Name and description per language, keyed by locale (pt_BR, en). When sent, replaces every block; the chain's default language must stay present with a name (up to 255 characters); description (up to 2000) is optional.

Response

Item

data
Item · object
required