increase-test
PATCH/lockbox_addresses/{lockbox_address_id}

Update a Lockbox Address

Updates the description or status of a Lockbox Address. Supply only the fields you want to change; description must 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 · 2 body fields
lockbox_address_idstringrequired
The identifier of the Lockbox Address to update.

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

descriptionstringoptional
The description you choose for the Lockbox Address.
statusstringoptional
The status of the Lockbox Address.
Allowed:activedisabledcanceled

3 status codes
200Returns the updated Lockbox Address object, including its current status, description, and address details.
addressobjectrequired
The mailing address for the Lockbox Address. It will be present after Increase generates it.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox Address was created.
descriptionstringrequired
The description you choose for the Lockbox Address.
idstringrequired
The Lockbox Address 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).
statusstringrequired
The status of the Lockbox Address.
Allowed:pendingactivedisabledcanceled
typestringrequired
A constant representing the object's type. For this resource it will always be `lockbox_address`.
Allowed:lockbox_address
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_address_id path parameter must identify an existing Lockbox Address. description, if provided, must be 1 to 200 characters, and status, if provided, must be active, disabled, or canceled.