Sign in
latestOpenAPI 3.0.12026-08-101936151.3 KB

61701b027c74

Postbox Confirmations

Create a confirmation for a Postbox item

Creates a confirmation for the Postbox item specified in the request URL and sets 'has_been_confirmed' to true for the item

post/v1/postbox/items/{item_id}/confirmations

Path parameters

item_idstring required

ID of the Postbox item.

Request body

person_idstring

ID of the person who is confirming the Postbox item.

idempotency_keystring

Optional property you may supply to prevent the execution of duplicate requests. If the API receives a request with a previously used idempotency key, then it will return the previously created confirmation.

Example request

{
  "person_id": "28a2197ff6e04a05b6316f83a38ccper"
}

Response

The confirmation was created successfully.

idstring

ID of the confirmation.

person_idstring

ID of the person who confirmed the Postbox item.

confirmed_atstring

UTC timestamp from when the person confirmed the Postbox item.