Signups

Cancel a signup (soft-delete)

Marks the signup as closed. Participants are NOT notified — that flow is intentionally separate so an agent's DELETE never blasts the roster by accident. To cancel AND tell everyone, use POST /signups/{id}/cancel.

delete/signups/{id}

Request

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

Path parameters

idstring uuid required

Response

Cancelled signup

idstring uuid required
organizationIdstring required
slugstring required
titlestring required
status'draft' | 'published' | 'closed' required
eventDatestring date-time required

ISO-8601 UTC.

signupCloseDatestring date-time nullable required

ISO-8601 UTC. Null = signups never close until the event.

locationstring nullable required
isPrivateboolean required
createdAtstring date-time required
updatedAtstring date-time required
descriptionstring nullable required
maxParticipantsinteger nullable required

Cap on total participants. Null only on a plan with no participant ceiling (uncapped); elsewhere the cap is stored as the plan ceiling.

commitmentRequiredboolean required

When true, a participant must claim a slot or an item to sign up — attending without committing to anything is not offered.

requiresPhoneboolean required
timezonestring required

IANA timezone the organizer attached to this signup. Display surfaces should prefer this over the viewer's local zone when rendering eventDate / slot times.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440100",
  "organizationId": "org_123",
  "slug": "fall-fundraiser-a1b2",
  "title": "Fall fundraiser",
  "status": "published",
  "eventDate": "2026-09-15T17:00:00Z",
  "timezone": "America/Los_Angeles"
}

Changes

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