Update a registration

Correct a registrant’s name, company or job title, and approve, decline or cancel the registration. Send any combination; the whole request applies or none of it does. The email cannot be changed here.

action:

• approve — a pending_approval registration becomes confirmed. Any other status answers 409.
• decline — a pending_approval or confirmed registration becomes declined. If the event’s approval workflow has a request for the registration, the decision is recorded there and its notifications go out. Any other status (including waitlisted) answers 409.
• cancel — the registration becomes canceled. Already canceled or transferred registrations are left as they are (200). Cancelling does not refund the order.

note goes on the approval decision.

Recorded in the event’s History as an API change. Requires write:registrations.

PATCH /v1/event/{eventId}/registrations/{registrationId}

cURL

approve

curl --request PATCH \
  --url https://public-api.sessionboard.com/v1/event/{eventId}/registrations/{registrationId} \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "action": "approve"
}
'

200

Example

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "event_id": 123,
    "status": "incomplete",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "company": "<string>",
    "job_title": "<string>",
    "ticket_type": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "registrant_type": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "form": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "kind": "<string>"
    },
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contact_id": "<string>",
    "badge_id": "<string>",
    "answers": {},
    "session_ids": [
      "<string>"
    ],
    "membership": {},
    "awaiting_assignment": true,
    "checked_in_at": "2023-11-07T05:31:56Z",
    "badge": {
      "printed": true,
      "print_count": 123,
      "last_printed_at": "2023-11-07T05:31:56Z"
    },
    "approval": {
      "id": "<string>",
      "status": "<string>"
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

ApiKeyBearerToken

x-access-token · string · header · required

Organization API token. Generate from Organization Settings → API Tokens.

Path Parameters

eventId · integer · required

Event ID

registrationId · string<uuid> · required

The registration ID.

Body

application/json

first_name · string

last_name · string

company · string | null

job_title · string | null

action · enum<string>

Available options: approve, decline, cancel

note · string

Recorded with an approve or decline decision.

Response

200

application/json

The registration after the change.

data · object

One person's registration for the event.

Show child attributes