Add an attendee

curl --request POST \
  --url https://api.zuddl.com/v1/events/{eventId}/attendees \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventId": "d812a64f-8865-4289-9024-9a120792c3d8",
  "firstName": "John",
  "lastName": "Doe",
  "email": "[email protected]",
  "bio": "<string>",
  "company": "<string>",
  "country": "United States",
  "designation": "<string>",
  "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
}
'

{
  "kind": "<string>",
  "url": "<string>",
  "id": "d5e31ba5-2d1e-4918-bb60-dd1514b4b397",
  "eventId": "d812a64f-8865-4289-9024-9a120792c3d8",
  "profile": {
    "firstName": "Jane",
    "lastName": "Smith",
    "email": "[email protected]",
    "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",
      "value": "New York City"
    }
  ],
  "disclaimers": [
    {
      "text": "<p>I agree to the terms and conditions</p>",
      "consentGiven": true
    }
  ],
  "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"
}

POST

events

{eventId}

attendees

Add an attendee

curl --request POST \
  --url https://api.zuddl.com/v1/events/{eventId}/attendees \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "eventId": "d812a64f-8865-4289-9024-9a120792c3d8",
  "firstName": "John",
  "lastName": "Doe",
  "email": "[email protected]",
  "bio": "<string>",
  "company": "<string>",
  "country": "United States",
  "designation": "<string>",
  "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
}
'

{
  "kind": "<string>",
  "url": "<string>",
  "id": "d5e31ba5-2d1e-4918-bb60-dd1514b4b397",
  "eventId": "d812a64f-8865-4289-9024-9a120792c3d8",
  "profile": {
    "firstName": "Jane",
    "lastName": "Smith",
    "email": "[email protected]",
    "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",
      "value": "New York City"
    }
  ],
  "disclaimers": [
    {
      "text": "<p>I agree to the terms and conditions</p>",
      "consentGiven": true
    }
  ],
  "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"
}

Authorizations

Authorization

string

header

required

Provide your API key secret in the Authorization header

Path Parameters

eventId

string

required

Unique identifier of the event

Body

application/json

eventId

string<uuid>

required

Unique identifier of the event for the attendee

Minimum string length: 1

Example:

"d812a64f-8865-4289-9024-9a120792c3d8"

firstName

string

required

First name of the attendee

Maximum string length: 150

Example:

"John"

lastName

string

required

Last name of the attendee

Maximum string length: 150

Example:

"Doe"

string

required

Email address of the attendee

Maximum string length: 150

Example:

"[email protected]"

bio

string

Short biography of the attendee.

Maximum string length: 2000

company

string

Company of the attendee

Maximum string length: 255

country

string

Country of the attendee

Maximum string length: 255

Example:

"United States"

designation

string

Designation of the attendee

Maximum string length: 255

phoneNumber

object

Phone number of the attendee

Show child attributes

phoneNumber.code

string

required

Country calling code

Example:

"+1"

phoneNumber.number

string

required

Phone number (without country code)

Example:

"2125551234"

customFieldsData

object[]

Custom registration fields and their values. Each object must include a 'fieldSlug' and a corresponding 'value'.

For dropdown (single-select) fields, provide one option as a simple string (e.g., "value": "Option1").
For multiselect fields, provide comma-separated values (e.g., "value": "Option1, Option2").
→ In both dropdown and multiselect, the provided values must match the defined options.
For date fields, use the format 'YYYY-MM-DD'.
For number fields, provide numeric values (e.g., age).
For all other supported field types, provide a simple string in the 'value'.

Show child attributes

customFieldsData.fieldSlug

string

Slug of the custom field

Example:

"city1"

customFieldsData.value

object

Value of the custom field

Example:

"New York City"

Example:

[
  {
    "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

object[]

Disclaimers of the registration

Show child attributes

disclaimers.id

string<uuid>

Disclaimer id

Example:

"66a2a042-afcf-4535-823e-65ea80deb6a9"

Whether the attendee has given consent

Available options:

true,

false

Example:

true

Example:

[
  {
    "id": "66a2a042-afcf-4535-823e-65ea80deb6a9",
    "consentGiven": "true"
  }
]

flowId

string<uuid>

The unique identifier of the registration flow for the attendee.

Example:

"814d4453-16e2-45cb-814a-7baf152c4f3b"

ticketDetails

object

Ticket details for the attendee

Show child attributes

ticketDetails.ticketTypeId

string<uuid>

required

Unique identifier of the ticket type associated with the attendee

Minimum string length: 1

Example:

"cce22fae-3536-4b28-b927-bec560dd4c37"

Social media links of the attendee

Show child attributes

Attendee’s LinkedIn profile URL

Example:

"https://www.linkedin.com/company/zuddl"

Attendee’s Twitter profile URL

Example:

"https://x.com/wearezuddl"

Attendee’s GitHub profile URL

Example:

"https://www.instagram.com/wearezuddl"

Attendee’s Facebook profile URL

Example:

"https://facebook.com/zuddl"

Attendee’s personal website URL

Example:

"https://www.zuddl.com"

sendRegistrationConfirmationEmail

enum<boolean>

default:false

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

Available options:

true,

false

Example:

true

Response

Registered attendee successfully

kind

string

url

string<uri>

string<uuid>

Unique Identifier of the event registration for the attendee

Example:

"d5e31ba5-2d1e-4918-bb60-dd1514b4b397"

eventId

string<uuid>

Unique identifier of the event for the attendee

Example:

"d812a64f-8865-4289-9024-9a120792c3d8"

profile

object

Profile details of the attendee

Show child attributes

profile.firstName

string

First name of the attendee

Example:

"Jane"

profile.lastName

string

Last name of the attendee

Example:

"Smith"

profile.email

string

Email address of the attendee

Example:

"[email protected]"

profile.company

string

Company name of the attendee

Example:

"Zuddl"

profile.designation

string

Title or designation of the attendee

Example:

"Senior Software Engineer"

profile.bio

string

Short biography of the attendee.

Example:

"Jane is a senior engineer with over 10 years of experience in cloud architecture."

profile.headline

string

Professional headline of the attendee

Example:

"Cloud Architecture Expert | Tech Speaker"

profile.industry

string

Industry of the attendee’s company

Example:

"Information Technology"

profile.country

string

Country of the attendee

Example:

"United States"

profile.phoneNumber

string

Phone number of the attendee

Example:

"+1-2125551234"

profile.profilePictureUrl

string

URL to the attendee’s profile picture

Example:

"https://cdn.zuddl.com/attendees/atnd_12345abcde/profile.jpg"

customFieldsData

object[]

Custom fields in the registration form

Show child attributes

customFieldsData.fieldSlug

string

Slug of the custom field

Example:

"city1"

customFieldsData.value

object

Value of the custom field

Example:

"New York City"

disclaimers

object[]

List of disclaimers

Show child attributes

disclaimers.text

string

Disclaimer rich text

Example:

"<p>I agree to the terms and conditions</p>"

Whether the attendee has given consent

Social media links of the attendee

Show child attributes

Attendee’s LinkedIn profile URL

Example:

"https://www.linkedin.com/company/zuddl"

Attendee’s Twitter profile URL

Example:

"https://x.com/wearezuddl"

Attendee’s GitHub profile URL

Example:

"https://www.instagram.com/wearezuddl"

Attendee’s Facebook profile URL

Example:

"https://facebook.com/zuddl"

Attendee’s personal website URL

Example:

"https://www.zuddl.com"

ticketDetails

object

Ticket and other related details

Show child attributes

ticketDetails.ticketTypeId

string

Unique identifier of the ticket type created on Zuddl

Example:

"f6b8cf1f-64e5-4801-935c-f6398bb111cd"

ticketDetails.ticketName

string

Ticket name

Example:

"VIP Pass"

Promo code

Example:

"SPRING2025"

ticketDetails.addOns

object[]

List of add-ons purchased for the ticket

Show child attributes

ticketDetails.addOns.id

string

Unique identifier of an add-on

Example:

"67f6ccf5-4c3d-4fed-bcca-822e3c3cf25a"

ticketDetails.addOns.name

string

Name of the add-on

Example:

"Advanced Workshop"

ticketDetails.addOns.sessions

object[]

Sessions included with this add-on

Show child attributes

ticketDetails.addOns.sessions.id

string

Unique identifier of the session

Example:

"0b838477-24bf-46a7-a9bd-c40bfa2b2c53"

ticketDetails.addOns.sessions.name

string

Name of the session

Example:

"Session name"

qrCodeImgUrl

string

URL of the attendee's QR code image

Example:

"https://cdn.zuddl.com/qrcodes/atnd_12345abcde.png"

confirmationCode

string

Confirmation code for registration

Example:

"01U6K9"

status

enum<string>

Status of the attendee

Available options:

PENDING,

REJECTED,

REGISTERED,

APPROVED_NOT_REGISTERED,

INCOMPLETE,

ATTENDED_VIRTUALLY,

ATTENDED_IN_PERSON,

ATTENDED_BOTH,

NO_SHOW

Example:

"REGISTERED"

statusUpdatedAt

string<date-time>

Timestamp when the attendee’s status was updated

Example:

"2025-04-07T09:57:55.71874Z"

statusSource

enum<string>

Source of the attendee's status

Available options:

MANUAL_UPDATE,

SYSTEM_UPDATE

Example:

"MANUAL_UPDATE"

source

object

Registration source details

Show child attributes

source.type

enum<string>

Type of registration source

Available options:

ATTENDEE_SIDE,

ORGANIZER_SIDE,

INTEGRATION,

LEAD_CAPTURE,

ZUDDL_API,

UNKNOWN

Example:

"ZUDDL_API"

source.referrer

string

Referrer information

Example:

"https://site.zuddl.com/landing-page"

source.utmParams

object

UTM parameters

Show child attributes

source.utmParams.id

string

UTM id

Example:

"123456"

source.utmParams.source

string

UTM source

Example:

"newsletter"

source.utmParams.medium

string

UTM medium

Example:

"email"

source.utmParams.campaign

string

UTM campaign

Example:

"march_promo"

source.utmParams.term

string

UTM term

Example:

"newsletter"

source.utmParams.content

string

UTM content

Example:

"newsletter"

source.metadata

object

Metadata associated with the registration source

Show child attributes

source.metadata.ipAddress

string

IP address of the device used for registration

Example:

"192.168.1.100"

source.metadata.deviceType

enum<string>

Type of device used for registration

Available options:

IOS,

ANDROID,

WEB,

DESKTOP,

MOBILE,

TABLET,

UNKNOWN

Example:

"DeviceType::MOBILE"

source.metadata.ipCity

string

City of the IP address

Example:

"New York"

source.metadata.ipCountry

string

Country of the IP address

Example:

"USA"

source.metadata.ipCountryIsoCode

string

ISO code of the country of the IP address

Example:

"US"

source.metadata.ipState

string

State or region of the IP address

Example:

"NY"

source.metadata.ipStateIsoCode

string

ISO code of the state or region of the IP address

Example:

"NY"

source.metadata.userAgent

string

User-agent string used by the user for registration

Example:

"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/58.0.3029.110 Safari/537.3"

source.metadata.latitude

string

Latitude of the IP address

Example:

"40.7128"

source.metadata.longitude

string

Longitude of the IP address

Example:

"-74.006"

source.metadata.osType

enum<string>

Operating system type used by the device for registration

Available options:

ANDROID,

IOS,

UNKNOWN

Example:

"OsType::IOS"

source.metadata.platformType

enum<string>

Platform type used by the device for registration

Available options:

WEB,

APP

Example:

"PlatformType::WEB"

Example:

{ "key": "value" }

roles

enum<string>[]

Roles of this attendee

Available options:

ATTENDEE,

ORGANIZER,

SPEAKER,

SPONSOR,

MODERATOR

Example:

["ATTENDEE", "SPEAKER"]

unsubscribedNotificationDetails

object[]

List of unsubscribed notification categories

Show child attributes

unsubscribedNotificationDetails.unsubscribeReason

string

Reason for unsubscribing from a notification category

Example:

"unsubscribeReasonExample"

unsubscribedNotificationDetails.categoryName

string

Category name of the notification that was unsubscribed from

Example:

"PROMOTIONAL"

Example:

[
  {
    "unsubscribeReason": "unsubscribeReasonExample",
    "categoryName": "PROMOTIONAL"
  }
]

createdAt

string<date-time>

Creation timestamp

Example:

"2025-04-07T09:57:55.826749Z"

createdBy

string

User ID of the creator

Example:

"a412e3d2-e15e-4fe0-bf35-7fcfb235a4b2"

updatedAt

string<date-time>

Update timestamp

Example:

"2025-04-07T09:57:56.045946Z"

Get all attendee details

Get attendee details

⌘I

API Reference

APIs

Add an attendee

Authorizations

Path Parameters

Body

Response