Skip to main content
PATCH
Change a wish list item

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Path Parameters

id
string
required

The wish list item's ID.

Body

application/json
name
string

Cannot be empty.

description
string | null
category
enum<string>
Available options:
food,
medical,
supplies,
equipment,
enrichment,
other
quantity_needed
integer
Required range: x >= 1
unit
string | null
priority
enum<string>
Available options:
low,
normal,
urgent
estimated_unit_cost_cents
integer | null

What one costs, in whole cents. Null clears it.

Required range: x >= 0
external_url
string | null
status
enum<string>

closed means you have stopped asking, which is not the same as enough having arrived: see is_fulfilled.

Available options:
open,
closed
closed_reason
string

Why you stopped asking. Required when status is closed.

Response

The item, as it now is, with its deliveries.

item
object
fulfillments
object[]

The deliveries, most recent first.