Photo Collect API
Photo Collect ↗
DELETEInvitations

Delete an invitation

Delete an invitation and any associated image assets that have not yet been exported.

DELETE/apiv1/invitation

Deletes an existing invitation and its image assets when they have not yet been exported.

Warning: Use DELETE /invitation only in exceptional cases where the invitation record itself must be deleted, such as recalling an invitation that is no longer relevant. In all other cases, use DELETE /export to remove the photo.

For Deeplink-created invitations, deleting the invitation does not remove the unique Deeplink identifier. The signed Deeplink therefore remains single-use.

Request parameters

Parameter Required Description
invitation_key Yes The single invitation to delete.
language_interface No Response language. ISO locale codes such as en_US are recommended. Two-letter codes such as en are matched on a best-effort basis.

Response

{
  "photo_status": "deleted",
  "deleted_at": "2019-05-19T23:28:14+02:00"
}

Unknown invitations return HTTP 400 with DELETE_INVITATION_FAILED.

⌁

Connect your API

Credentials are kept in this session only.