Skip to main content
POST
/
v1
/
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 '
{
  "firstName": "John",
  "lastName": "Doe",
  "email": "johndoe@zuddl.com",
  "bio": "<string>",
  "company": "<string>",
  "country": "United States",
  "designation": "<string>",
  "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",
  "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": "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",
      "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"
}

Documentation Index

Fetch the complete documentation index at: https://docs.zuddl.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Provide your API key secret in the Authorization header

Path Parameters

​
eventId
string
required

Unique identifier of the event

Pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Body

application/json
​
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"

​
email
string
required

Email address of the attendee

Maximum string length: 150
Example:

"johndoe@zuddl.com"

​
bio
string

Short biography of the attendee.

Maximum string length: 3000
​
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

​
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'.
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

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

​
socialLinks
object

Social media links of the attendee

​
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>
​
id
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

​
customFieldsData
object[]

Custom fields in the registration form

​
disclaimers
object[]

List of disclaimers

​
socialLinks
object

Social media links of the attendee

​
ticketDetails
object

Ticket and other related details

​
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

​
roles
enum<string>[]

Roles of this attendee

Roles of this attendee

Available options:
ATTENDEE,
ORGANIZER,
SPEAKER,
SPONSOR,
MODERATOR
Example:
["ATTENDEE", "SPEAKER"]
​
unsubscribedNotificationDetails
object[]

List of unsubscribed notification categories

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"