Sign in

v1

latestOpenAPI 3.1.02026-07-22285495.1 KB
Attendees

Add an attendee

This API endpoint adds an attendee by passing the required registration details in the request payload. The attendee must be associated with a registration flow. If it is a ticketed event, the attendee must also be associated with a ticket as well. A unique registrationId is created that identifies the particular attendee.

Required API key scopes: WRITE

This API can only be called with an access key that was generated for Backend usage.

post/v1/events/{eventId}/attendees

Path parameters

eventIdstring required

Unique identifier of the event

Request body

firstNamestring required

First name of the attendee

lastNamestring required

Last name of the attendee

emailstring required

Email address of the attendee

biostring

Short biography of the attendee.

companystring

Company of the attendee

countrystring

Country of the attendee

designationstring

Designation of the attendee

flowIdstring uuid

The unique identifier of the registration flow for the attendee.

sendRegistrationConfirmationEmailtrue | false

A boolean that specifies whether a registration confirmation email is to be sent to the attendee.

Example request

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "johndoe@zuddl.com",
  "country": "United States",
  "phoneNumber": {
    "code": "+1",
    "number": "2125551234"
  },
  "customFieldsData": [
    {
      "fieldSlug": "city1",
      "value": "New York City"
    },
    {
      "fieldSlug": "age",
      "value": 30
    },
    {
      "fieldSlug": "interests",
      "value": "Reading, Music, Travel"
    },
    {
      "fieldSlug": "birthDate",
      "value": "2001-06-27"
    },
    {
      "fieldSlug": "country",
      "value": "United States"
    }
  ],
  "disclaimers": [
    {
      "id": "66a2a042-afcf-4535-823e-65ea80deb6a9",
      "consentGiven": "true"
    }
  ],
  "flowId": "814d4453-16e2-45cb-814a-7baf152c4f3b",
  "ticketDetails": {
    "ticketTypeId": "cce22fae-3536-4b28-b927-bec560dd4c37"
  },
  "socialLinks": {
    "linkedin": "https://www.linkedin.com/company/zuddl",
    "twitter": "https://x.com/wearezuddl",
    "instagram": "https://www.instagram.com/wearezuddl",
    "facebook": "https://facebook.com/zuddl",
    "website": "https://www.zuddl.com"
  },
  "sendRegistrationConfirmationEmail": true
}

Response

Registered attendee successfully

kindstring
urlstring uri
idstring uuid

Unique Identifier of the event registration for the attendee

eventIdstring uuid

Unique identifier of the event for the attendee

qrCodeImgUrlstring

URL of the attendee's QR code image

confirmationCodestring

Confirmation code for registration

status'PENDING' | 'REJECTED' | 'REGISTERED' | 'APPROVED_NOT_REGISTERED' | 'INCOMPLETE' | 'ATTENDED_VIRTUALLY' | 'ATTENDED_IN_PERSON' | 'ATTENDED_BOTH' | 'NO_SHOW'

Status of the attendee

statusUpdatedAtstring date-time

Timestamp when the attendee’s status was updated

statusSource'MANUAL_UPDATE' | 'SYSTEM_UPDATE'

Source of the attendee's status

rolesstring[]

Roles of this attendee

createdAtstring date-time

Creation timestamp

createdBystring

User ID of the creator

updatedAtstring date-time

Update timestamp

Example response

{
  "id": "d5e31ba5-2d1e-4918-bb60-dd1514b4b397",
  "eventId": "d812a64f-8865-4289-9024-9a120792c3d8",
  "profile": {
    "firstName": "Jane",
    "lastName": "Smith",
    "email": "jane.smith@example.com",
    "company": "Zuddl",
    "designation": "Senior Software Engineer",
    "bio": "Jane is a senior engineer with over 10 years of experience in cloud architecture.",
    "headline": "Cloud Architecture Expert | Tech Speaker",
    "industry": "Information Technology",
    "country": "United States",
    "phoneNumber": "+1-2125551234",
    "profilePictureUrl": "https://cdn.zuddl.com/attendees/atnd_12345abcde/profile.jpg"
  },
  "customFieldsData": [
    {
      "fieldSlug": "city1"
    }
  ],
  "disclaimers": [
    {
      "id": "f6b8cf1f-64e5-4801-935c-f6398bb111cd",
      "slug": "termsConsent",
      "text": "<p>I agree to the terms and conditions</p>"
    }
  ],
  "socialLinks": {
    "linkedin": "https://www.linkedin.com/company/zuddl",
    "twitter": "https://x.com/wearezuddl",
    "instagram": "https://www.instagram.com/wearezuddl",
    "facebook": "https://facebook.com/zuddl",
    "website": "https://www.zuddl.com"
  },
  "ticketDetails": {
    "ticketTypeId": "f6b8cf1f-64e5-4801-935c-f6398bb111cd",
    "ticketName": "VIP Pass",
    "promoCode": "SPRING2025",
    "addOns": [
      {
        "id": "67f6ccf5-4c3d-4fed-bcca-822e3c3cf25a",
        "name": "Advanced Workshop",
        "sessions": [
          {
            "id": "0b838477-24bf-46a7-a9bd-c40bfa2b2c53",
            "name": "Session name"
          }
        ]
      }
    ]
  },
  "qrCodeImgUrl": "https://cdn.zuddl.com/qrcodes/atnd_12345abcde.png",
  "confirmationCode": "01U6K9",
  "status": "REGISTERED",
  "statusUpdatedAt": "2025-04-07T09:57:55.71874Z",
  "statusSource": "MANUAL_UPDATE",
  "source": {
    "type": "ZUDDL_API",
    "referrer": "https://site.zuddl.com/landing-page",
    "utmParams": {
      "id": "123456",
      "source": "newsletter",
      "medium": "email",
      "campaign": "march_promo",
      "term": "newsletter",
      "content": "newsletter"
    },
    "metadata": {
      "key": "value"
    }
  },
  "roles": [
    "ATTENDEE",
    "SPEAKER"
  ],
  "unsubscribedNotificationDetails": [
    {
      "unsubscribeReason": "unsubscribeReasonExample",
      "categoryName": "PROMOTIONAL"
    }
  ],
  "createdAt": "2025-04-07T09:57:55.826749Z",
  "createdBy": "a412e3d2-e15e-4fe0-bf35-7fcfb235a4b2",
  "updatedAt": "2025-04-07T09:57:56.045946Z"
}