increase-test
PATCH/lockbox_recipients/{lockbox_recipient_id}

Update a Lockbox Recipient

Updates the name, description, or status of a Lockbox Recipient. Supply only the fields you want to change; description and recipient_name must each contain 1 to 200 characters, and status must be an allowed value.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 3 body fields
lockbox_recipient_idstringrequired
The identifier of the Lockbox Recipient to update.

Fields to update on the Lockbox Recipient; provide only the properties you want to change.

descriptionstringoptional
The description you choose for the Lockbox Recipient.
recipient_namestringoptional
The name of the Lockbox Recipient.
statusstringoptional
The status of the Lockbox Recipient.
Allowed:activedisabledcanceled

3 status codes
200Returns the updated Lockbox Recipient object, including its current name, description, status, and mail stop code.
account_idstringrequired
The identifier for the Account that checks sent to this Lockbox Recipient will be deposited into.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox Recipient was created.
descriptionstringrequired
The description of the Lockbox Recipient.
idstringrequired
The Lockbox Recipient identifier.
idempotency_keystringrequired
The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
lockbox_address_idstringrequired
The identifier for the Lockbox Address where this Lockbox Recipient may receive physical mail.
mail_stop_codestringrequired
The mail stop code uniquely identifying this Lockbox Recipient at its Lockbox Address. It should be included in the mailing address intended for this Lockbox Recipient.
recipient_namestringrequired
The name of the Lockbox Recipient.
statusstringrequired
The status of the Lockbox Recipient.
Allowed:activedisabledcanceled
typestringrequired
A constant representing the object's type. For this resource it will always be `lockbox_recipient`.
Allowed:lockbox_recipient
4XXReturned when the request cannot be processed because of a client-side error.
5XXReturned when the request cannot be completed because of a server-side error.

Error handling

The lockbox_recipient_id path parameter must identify an existing Lockbox Recipient. description and recipient_name, if provided, must each be 1 to 200 characters, and status, if provided, must be active, disabled, or canceled.