custom-fields:write · Idempotency-Key: optional
Creates and updates the options of a DROPDOWN or MULTIPLE_CHOICE field, keyed by your externalId. Use it to keep a dropdown in step with a list in your own system, such as your events.
The field’s
id from GET /v1/payable-custom-fields.Body
Your key for the option, for example your event id. 1 to 255 characters. Each
externalId can appear once per request.The text people choose from. Up to 100 characters, not blank. Leading and trailing spaces are removed, and runs of spaces become one. Two options can share a label.
true archives the option: it can no longer be chosen on new bills, and bills that already chose it keep it. false restores it. Leave it out to keep the option’s archived state as it is.id or value. An unknown top-level field answers 400 validation_error.
How options are matched
Nothing is ever deleted. To retire an option, send it with
archived: true.
A request that matches what is stored writes nothing, so you can resend your whole list on a schedule. Two syncs to the same field run one after the other, so neither loses the other’s options.
Example
Response
200 with the custom field and its full options list: archived options, and options you did not send, included.
Retrying
The sync is safe to repeat without a key: the same list a second time changes nothing. With anIdempotency-Key, a retry with the same body returns the first answer, and the same key with a different body answers 409 idempotency_conflict. See Idempotency.