v4

latestOpenAPI 3.1.02026-08-012402353.8 MB

Update a Lockbox Recipient

patch/lockbox_recipients/{lockbox_recipient_id}

Path parameters

lockbox_recipient_idstring required

The identifier of the Lockbox Recipient.

Request body

descriptionstring

The description you choose for the Lockbox Recipient.

recipient_namestring

The name of the Lockbox Recipient.

status'active' | 'disabled' | 'canceled'

The status of the Lockbox Recipient.

Example request

{
  "status": "active"
}

Response

Lockbox Recipient

account_idstring required

The identifier for the Account that checks sent to this Lockbox Recipient will be deposited into.

created_atstring date-time required

The ISO 8601 time at which the Lockbox Recipient was created.

descriptionstring nullable required

The description of the Lockbox Recipient.

idstring required

The Lockbox Recipient identifier.

idempotency_keystring nullable required

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.

lockbox_address_idstring required

The identifier for the Lockbox Address where this Lockbox Recipient may receive physical mail.

mail_stop_codestring required

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_namestring nullable required

The name of the Lockbox Recipient.

status'active' | 'disabled' | 'canceled' nullable required

The status of the Lockbox Recipient.

type'lockbox_recipient' required

A constant representing the object's type. For this resource it will always be lockbox_recipient.

Example response

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "created_at": "2020-01-31T23:59:59Z",
  "description": null,
  "id": "lockbox_3xt21ok13q19advds4t5",
  "idempotency_key": null,
  "lockbox_address_id": "lockbox_address_lw6sbzl9ol5dfd8hdml6",
  "mail_stop_code": "VRE6P",
  "recipient_name": "Company Inc.",
  "status": "active",
  "type": "lockbox_recipient"
}