Skip to main content
PUT
Change the pantry settings

Authorizations

Authorization
string
header
required

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

Body

application/json
enabled
boolean
records
enum<string>
Available options:
both,
named,
anonymous
allowance_small
number | null

Pounds a month for each small pet. Null for no limit.

Required range: 0 <= x <= 2000
allowance_medium
number | null

Pounds a month for each medium pet.

Required range: 0 <= x <= 2000
allowance_large
number | null

Pounds a month for each large pet.

Required range: 0 <= x <= 2000
allowance_extra_large
number | null

Pounds a month for each extra large pet.

Required range: 0 <= x <= 2000
allowance_unsized
number | null

Pounds a month for a pet with no size given, and for a size with no allowance of its own.

Required range: 0 <= x <= 2000
allowance_max
number | null

A household's most in a month, whatever its pets add up to.

Required range: 0 <= x <= 20000
visits_per_month
integer | null

Visits a household may make in a calendar month.

Required range: 1 <= x <= 31
proof_required
boolean

Whether a household needs proof of need on file.

Response

The settings, as they now are.

Every rule is optional and none of them refuses a visit: a household over a limit is served, and the visit and the household carry warnings in words.

enabled
boolean
required

Whether your organization runs a pet food pantry. Off until it is switched on.

records
enum<string>
required

What is kept about the people served. both: a household when there is one, a walk-up when there is not. named: every visit is to a household. anonymous: visits are counted without names, and no households are kept.

Available options:
both,
named,
anonymous
allowance_small
number | null
required

Pounds a month for each small pet. Null for no limit.

Required range: 0 <= x <= 2000
allowance_medium
number | null
required

Pounds a month for each medium pet.

Required range: 0 <= x <= 2000
allowance_large
number | null
required

Pounds a month for each large pet.

Required range: 0 <= x <= 2000
allowance_extra_large
number | null
required

Pounds a month for each extra large pet.

Required range: 0 <= x <= 2000
allowance_unsized
number | null
required

Pounds a month for a pet with no size given, and for a size with no allowance of its own.

Required range: 0 <= x <= 2000
allowance_max
number | null
required

A household's most in a month, whatever its pets add up to.

Required range: 0 <= x <= 20000
visits_per_month
integer | null
required

Visits a household may make in a calendar month.

Required range: 1 <= x <= 31
proof_required
boolean
required

Whether a household needs proof of need on file.