Participants

Edit a registration

Edit one person's registration on the signup: name, email, phone, attendees, name visibility, and the days they attend. Supply only the fields to change; at least one is required (422 otherwise). rid is the registration's id from GET /signups/{id}/registrations; a registration of another signup is 404. Works on an Attend-only registration (one with no Commitments). Notifies nobody. Returns the registration.

patch/signups/{id}/registrations/{rid}

Request

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

Path parameters

idstring uuid required
ridstring uuid required

Request body

namestring

The person's name as the organizer sees it, and as the public list shows it when nameVisible.

emailstring email

The person's address. Written directly, as the dashboard's edit does: no confirmation email goes to either address. Another registration on this signup already using it is a 409.

phonestring nullable

The person's phone, or null to clear it. A number different from the one on file turns their SMS consent off: they are not texted until they opt in again.

attendeesinteger

How many people this registration covers, the person included. At most the signup's maxAttendeesPerSignup (400 otherwise), and within the signup's capacity.

nameVisibleboolean

Whether the person's name is shown on the public signup page's list of who signed up.

daysstring[]

The event days (event_days.id, from the signup's days, as get_signup returns them) this person attends, as the COMPLETE list. Because days REPLACES the whole set, read the current list first (the registration's days, returned by every registration read and write) and send it back with your change: a day you omit is REMOVED. Removing attendance is allowed on any day, past or cancelled, and [] removes all of it; their slots and items stay. Safe to repeat. Adding a day follows the Guest's rules: the signup must be accepting signups, a cancelled date is refused, a required day question must already be answered, and on a signup that requires a commitment no day can be added (so attendance removed there cannot be re-added through days). Also refused: adding a day that has passed (400), and adding any day while the registration is no longer attending (400; [] still works). A day of another signup is 404. Any refusal writes nothing. Notifies nobody.

Response

The updated registration

idstring uuid required
eventIdstring uuid required
namestring required
emailstring email required
phonestring nullable required
attendingboolean required
attendOnlyboolean required
attendeesinteger required

How many people this registration covers, the person included.

nameVisibleboolean required

Whether the person's name is shown on the public signup page's list of who signed up.

eventCustomFieldResponsestring nullable required
dayCustomFieldResponsesobject nullable required
daysstring[] required

The event days (event_days.id) this person is attending, sorted by id. Includes the day a slot they hold is on, unless it was removed with days.

createdAtstring date-time required
lastModifiedAtstring date-time required

Changes

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