Items

Delete an item, optionally releasing the claims on it

Delete an item, immediately. The item must belong to the signup in the path (an item of another signup is 404 not_found, and nothing is written). An item people have claimed is refused with 409 conflict and nothing changes, unless release_claims=true (query): then the item and every claim on it are deleted, and the people who held an Open claim are emailed, and texted when they consented, that it is gone — with the optional JSON body's message prepended (participant-facing, not a private note). A claim on a past or cancelled date is Locked history: it is deleted with the item and its holder is not told. The response reports the blast radius: claimants (people), claims (units) and notified. A client or proxy that strips DELETE bodies sends the email and text without message. Deleting is by id, so a repeat DELETE is 404 not_found and tells nobody again. The account behind the credential must have a verified email (the call can email participants), or it is 403 forbidden.

delete/signups/{id}/items/{itemId}

Request

  • Base URL: https://thesignup.app/api/v1
  • URL: https://thesignup.app/api/v1/signups/{id}/items/{itemId}
  • Auth: HTTP bearer

Path parameters

idstring uuid required
itemIdstring uuid required

Query parameters

release_claims'true' | 'false'

true deletes an item people have claimed, deleting their claims with it and emailing (and texting, when they consented) the people who held an Open claim. Absent or false refuses a claimed item with 409 conflict and writes nothing.

Request body

messagestring nullable

Participant-facing: prepended to the email, and the text when they consented, each person who held an Open claim on the item is sent when release_claims is true. Not a private note. Ignored when nobody is told.

Response

The item is gone, and what that did to its claims

idstring uuid required

The item that was deleted.

deletedtrue required

Always true: the item and its claims are gone.

claimsinteger required

Units that had been claimed, summed across the claims that were deleted. 0 when the item had no claims.

claimantsinteger required

People who held a claim — a party of three is one claimant. 0 when the item had no claims.

Changes

No recorded changes to this operation across all 1 revision of this API.