Create an Event - Zeeg Developer Hub

POST

event

curl --request POST \
  --url https://api.zeeg.me/v2/event \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "date": "2026-04-15",
  "name": "Sophie Laurent",
  "email": "sophie.laurent@northwind.io",
  "timeZone": "Europe/Paris",
  "start": "09:00"
}
'

{
  "uri": "https://api.zeeg.me/v2/scheduled-events/zg-O69bac566950c6",
  "uuid": "zg-O69bac566950c6",
  "title": "30-Minute Discovery Call",
  "type": "ONE_ON_ONE",
  "startTime": "2026-04-15T07:00:00.000000Z",
  "endTime": "2026-04-15T07:30:00.000000Z",
  "duration": 30,
  "status": "confirmed",
  "eventTypeUri": "https://api.zeeg.me/v2/event-types/80f46bf5-eb01-4c07-960e-a9a3e18aae5e",
  "location": {
    "type": "Google Meet",
    "joinUrl": "https://meet.google.com/abc-defg-hij"
  },
  "maxActiveInvitees": 1,
  "activeInviteesCount": 1,
  "invitees": [
    {
      "uuid": "zg-O69bad4047abf0",
      "salutation": null,
      "fullName": "Sophie Laurent",
      "email": "sophie.laurent@northwind.io",
      "guests": [
        "alex.chen@northwind.io"
      ],
      "timeZone": "Europe/Paris",
      "cancellation": {
        "cancelledAt": null,
        "cancelledBy": null,
        "cancellerType": null,
        "cancellationReason": null
      },
      "payment": null,
      "questions": [
        {
          "answer": "Product demo and pricing options",
          "answer_type": "STRING",
          "question": "What would you like to discuss?"
        }
      ],
      "noShow": false,
      "noShowAt": null,
      "scheduledAt": "2026-04-10T08:30:00.000000Z",
      "utm": {
        "utm_campaign": "spring_launch",
        "utm_source": "linkedin",
        "utm_medium": "social",
        "utm_content": null,
        "utm_term": null
      },
      "customQueryParams": {}
    }
  ],
  "guests": [
    "alex.chen@northwind.io"
  ],
  "hosts": [
    {
      "firstName": "Lena",
      "lastName": "Meier",
      "email": "lena.meier@horizondigital.de",
      "slug": "lena-meier",
      "url": "https://zeeg.me/lena-meier",
      "avatarUrl": null
    }
  ],
  "teamName": "Sales",
  "createdAt": "2026-04-10T08:30:00.000000Z",
  "updatedAt": "2026-04-10T08:30:00.000000Z",
  "currentTime": "2026-04-10T08:30:00+00:00"
}

Authorizations

Authorization

string

header

required

Body

application/json

Required fields may vary based on the event type's configuration.
Before creating an event, verify availability using the availability endpoint.
Validate any required custom fields (guests, phone, questions) by checking the event type's settings first.

date

string<date>

required

The event date in YYYY-MM-DD format.

name

string

required

Invitee's full name.

string<email>

required

Invitee's email address.

timeZone

string

required

Invitee's IANA timezone identifier.

Example:

"Europe/Paris"

start

string<time>

required

Start time in HH:mm format (in the specified timeZone).

Example:

"09:00"

eventTypeId

string

The scheduling page's id, as GET /event-types returns it. Replaces ownerSlug, eventTypeSlug and sharedLink.

ownerSlug

string

The slug of the scheduling page owner, can be a user or a team. Required with eventTypeSlug unless eventTypeId or sharedLink is sent.

eventTypeSlug

string

The slug of the scheduling page.

duration

integer

Optional. Meeting duration in minutes, one of the durations the scheduling page offers. When omitted, or when the page does not offer it, the booking takes the page's default duration.

phone

string

Invitee's phone number (required for "PHONE_CALL" location type).

guests

string<email>[]

Array of additional guest email addresses.

location

string

The location type the invitee books. If the scheduling page offers one or more locations, this field is required, and the request fails with 422 when it is absent. If the scheduling page offers no location, omit it. Send the type the scheduling page is configured with. A type the page does not offer fails with 422. Accepted values:

"IN_PERSON": Physical in-person meeting (requires locationOptions with address and details).
"PHONE_CALL": Phone call meeting (requires locationOptions.callType and phone field).
"CUSTOM": Free-text location. The scheduling page holds the text, so send no locationOptions.
"GOOGLE_MEET", "MICROSOFT_TEAMS", "MICROSOFT_SKYPE", "ZOOM", "WEBEX", "DEMODESK", "ALFAVIEW", "WHATSAPP", "WHEREBY", "JITSI": The scheduling page holds the account or the link, so send no locationOptions.

locationOptions

object

Additional location details, required for certain location types:

For in-person meetings (location: "IN_PERSON"): provide address and details.
For phone call meetings (location: "PHONE_CALL"): provide callType (e.g. "I_WILL_CALL").

Hide child attributes

locationOptions.address

string

locationOptions.details

string

locationOptions.callType

string

locationKey

string

Optional. The per-location stable key from the scheduling page's location resource (key field, e.g. loc_42, or room_<resourceId> for a room). Pins the exact location row when the scheduling page offers several locations of the same type; recommended whenever it is available, and the only reliable way to target a specific same-type location on a paid scheduling page (where paid option values are withheld until payment).

Example:

"loc_42"

question_answers

object[]

Array of question-answer pairs for custom invitee questions configured on the scheduling page.

Hide child attributes

question_answers.question_id

integer

The numeric ID of the question (obtain from scheduling page settings).

question_answers.answer

The answer to the question. A string for single-answer questions, or an array of strings for multi-select questions.

customQueryParams

object

Custom URL parameters to pass through.

utm

object

UTM tracking parameters.

Hide child attributes

utm.utm_campaign

string

utm.utm_source

string

utm.utm_medium

string

utm.utm_content

string

utm.utm_term

string

sharedLink

string

The shared link token, required when booking via a shared or collective scheduling link.

Response

A scheduled event resource. This is the single canonical shape returned by all scheduled-event endpoints and embedded in the AI agent call webhook payload.

uri

string<uri>

required

Public API URI of the scheduled event resource.

uuid

string

required

Zeeg event identifier (zg-XXX format)

Example:

"zg-O69bac566950c6"

title

string

required

Title of the scheduled event.

type

string

required

Event type kind (e.g. ONE_ON_ONE, GROUP, ROUND_ROBIN).

startTime

string<date-time>

required

ISO 8601 UTC start time of the booked event.

endTime

string<date-time>

required

ISO 8601 UTC end time of the booked event.

duration

integer

required

Event duration in minutes.

status

string

required

Booking status (e.g. confirmed, cancelled).

eventTypeUri

string<uri>

required

Public API URI of the event type this booking was made against.

maxActiveInvitees

integer

required

Maximum number of active invitees the event allows.

activeInviteesCount

integer

required

Current number of active (non-cancelled) invitees.

invitees

object[]

required

Invitees booked on the scheduled event.

Hide child attributes

invitees.fullName

string | null

required

Full name of the invitee.

invitees.email

string<email> | null

required

Email address of the invitee.

invitees.timeZone

string | null

required

IANA time zone of the invitee.

invitees.noShow

boolean

required

Whether the invitee has been marked as a no-show. Always present.

invitees.scheduledAt

string<date-time> | null

required

ISO 8601 UTC timestamp when the invitee booked.

invitees.uuid

string

Zeeg attendee identifier (zg-XXX format)

Example:

"zg-O69bac566950c6"

invitees.salutation

string | null

Salutation for the invitee, if collected.

invitees.guests

string[]

Email addresses of additional guests the invitee added. An empty array when the invitee added none.

invitees.cancellation

object

Cancellation details. All fields are null when the invitee is not cancelled.

Hide child attributes

invitees.cancellation.cancelledAt

string<date-time> | null

ISO 8601 UTC timestamp when the invitee was cancelled.

invitees.cancellation.cancelledBy

string | null

Identifier of who cancelled the booking.

invitees.cancellation.cancellerType

string | null

Type of canceller (e.g. host, invitee).

invitees.cancellation.cancellationReason

string | null

Reason given for the cancellation.

invitees.payment

object | null

Payment details for the booking, or null when no payment applies.

Hide child attributes

invitees.payment.gateway

string

Payment provider, e.g. stripe or paypal.

invitees.payment.price

number

invitees.payment.currency

string

invitees.payment.transactionId

string | null

invitees.payment.createdAt

string<date-time>

invitees.payment.status

enum<string>

pending until the transaction completes.

Available options:

pending,

success

invitees.noShowAt

string<date-time> | null

ISO 8601 UTC timestamp when the invitee was marked as a no-show, or null when they were not.

invitees.utm

object

UTM tracking parameters captured at booking time. Always holds these five keys, in snake_case; a key holds null when the booking did not carry a value for it.

Hide child attributes

invitees.utm.utm_campaign

string | null

required

invitees.utm.utm_source

string | null

required

invitees.utm.utm_medium

string | null

required

invitees.utm.utm_content

string | null

required

invitees.utm.utm_term

string | null

required

invitees.adAttribution

object | null

Ad-click identifiers captured at booking time, keyed by provider. Only the keys that were actually captured are present; null when none were captured.

Hide child attributes

invitees.adAttribution.gclid

string | null

Google Ads click ID.

invitees.adAttribution.gbraid

string | null

Google click ID for iOS app-to-web clicks. Mutually exclusive with gclid per click.

invitees.adAttribution.wbraid

string | null

Google click ID for web-to-app clicks. Mutually exclusive with gclid per click.

invitees.adAttribution.fbclid

string | null

Meta click ID.

invitees.adAttribution.fbp

string | null

Meta browser ID cookie (_fbp) captured at booking time.

invitees.adAttribution.fbc

string | null

Meta click cookie (_fbc) captured at booking time.

invitees.adAttribution.landingUrl

string | null

Full URL of the host page the booking widget was embedded on.

invitees.customQueryParams

object

Custom query parameters captured at booking time, keyed by the c__-prefixed parameter name. An empty object when the booking captured none.

Example:

{ "c__ref": "nl-2026-04" }

invitees.questions

object[] | null

Booking questions answered by the invitee.

Hide child attributes

invitees.questions.answer

string

invitees.questions.answer_type

string

invitees.questions.question

string

invitees.agentBookingReference

string | null

Reference code for bookings made via the AI agent; null otherwise.

invitees.cancelUrl

string<uri> | null

Public URL the invitee uses to cancel this booking. null once the booking is cancelled.

invitees.rescheduleUrl

string<uri> | null

Public URL the invitee uses to reschedule this booking. null once the booking is cancelled.

invitees.rescheduled

boolean

True once this booking has been superseded by a reschedule. A rescheduled booking reports status: cancelled for backward compatibility; rescheduled and nextRescheduling are how a caller tells a reschedule apart from an actual cancellation.

invitees.rescheduling

object | null

Present when this booking is the result of a reschedule. null when this booking was not itself created by rescheduling an earlier one.

Hide child attributes

invitees.rescheduling.oldStartAt

string<date-time> | null

ISO 8601 UTC start time the previous booking held before the reschedule.

invitees.rescheduling.newStartAt

string<date-time> | null

ISO 8601 UTC start time the new booking was moved to.

invitees.rescheduling.rescheduledAt

string<date-time>

ISO 8601 UTC timestamp when the reschedule was performed.

invitees.rescheduling.previousEventUuid

string | null

uuid of the superseded booking (zg-XXX format). Use it directly as the uuid path parameter of GET /scheduled-events/{uuid} to fetch that booking.

Example:

"zg-O69bad4047abf0"

invitees.rescheduling.previousInviteeUuid

string | null

uuid of the invitee on the superseded booking. No public endpoint accepts an invitee uuid as a path parameter.

Example:

"zg-O69bac566950c6"

invitees.rescheduling.reason

string | null

Reason given for the reschedule, if any.

invitees.rescheduling.rescheduledBy

string | null

Who performed the reschedule (e.g. host, invitee).

invitees.rescheduling.reschedulerFullName

string | null

Full name of the person who performed the reschedule, when known.

invitees.nextRescheduling

object | null

Present when this booking has been superseded by a later reschedule. null when the booking has not been rescheduled.

Hide child attributes

invitees.nextRescheduling.oldStartAt

string<date-time> | null

ISO 8601 UTC start time the previous booking held before the reschedule.

invitees.nextRescheduling.newStartAt

string<date-time> | null

ISO 8601 UTC start time the new booking was moved to.

invitees.nextRescheduling.rescheduledAt

string<date-time>

ISO 8601 UTC timestamp when the reschedule was performed.

invitees.nextRescheduling.previousEventUuid

string | null

uuid of the superseded booking (zg-XXX format). Use it directly as the uuid path parameter of GET /scheduled-events/{uuid} to fetch that booking.

Example:

"zg-O69bad4047abf0"

invitees.nextRescheduling.previousInviteeUuid

string | null

uuid of the invitee on the superseded booking. No public endpoint accepts an invitee uuid as a path parameter.

Example:

"zg-O69bac566950c6"

invitees.nextRescheduling.reason

string | null

Reason given for the reschedule, if any.

invitees.nextRescheduling.rescheduledBy

string | null

Who performed the reschedule (e.g. host, invitee).

invitees.nextRescheduling.reschedulerFullName

string | null

Full name of the person who performed the reschedule, when known.

teamName

string | null

required

Name of the team that owns the scheduling page the booking was made on, or null for a personal scheduling page. The key is always present. This is the same value the invitee.scheduled webhook sends as teamName for the same booking.

Example:

"Sales"

createdAt

string<date-time>

required

ISO 8601 UTC timestamp when the booking was created.

location

object | null

Meeting location for the booking.

Hide child attributes

location.type

string

required

Location type (e.g. google_meet, zoom, phone, in_person).

location.joinUrl

string<uri> | null

Join URL for the meeting, when applicable.

guests

string[]

Email addresses of additional guests added across all invitees. An empty array when none were added.

hosts

object[] | null

Hosts assigned to the scheduled event.

Hide child attributes

hosts.firstName

string | null

required

Host's first name.

hosts.email

string<email> | null

required

Host's email address.

hosts.slug

string | null

required

Host's public profile slug.

hosts.url

string<uri>

required

Host's public profile URL.

hosts.lastName

string

Host's last name. Empty string when not set.

hosts.avatarUrl

string<uri> | null

URL of the host's avatar image, if set.

updatedAt

string<date-time>

ISO 8601 UTC timestamp when the booking was last updated.

currentTime

string<date-time>

Current server time

Last modified on April 29, 2026

curl --request POST \
  --url https://api.zeeg.me/v2/event \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "date": "2026-04-15",
  "name": "Sophie Laurent",
  "email": "sophie.laurent@northwind.io",
  "timeZone": "Europe/Paris",
  "start": "09:00"
}
'

{
  "uri": "https://api.zeeg.me/v2/scheduled-events/zg-O69bac566950c6",
  "uuid": "zg-O69bac566950c6",
  "title": "30-Minute Discovery Call",
  "type": "ONE_ON_ONE",
  "startTime": "2026-04-15T07:00:00.000000Z",
  "endTime": "2026-04-15T07:30:00.000000Z",
  "duration": 30,
  "status": "confirmed",
  "eventTypeUri": "https://api.zeeg.me/v2/event-types/80f46bf5-eb01-4c07-960e-a9a3e18aae5e",
  "location": {
    "type": "Google Meet",
    "joinUrl": "https://meet.google.com/abc-defg-hij"
  },
  "maxActiveInvitees": 1,
  "activeInviteesCount": 1,
  "invitees": [
    {
      "uuid": "zg-O69bad4047abf0",
      "salutation": null,
      "fullName": "Sophie Laurent",
      "email": "sophie.laurent@northwind.io",
      "guests": [
        "alex.chen@northwind.io"
      ],
      "timeZone": "Europe/Paris",
      "cancellation": {
        "cancelledAt": null,
        "cancelledBy": null,
        "cancellerType": null,
        "cancellationReason": null
      },
      "payment": null,
      "questions": [
        {
          "answer": "Product demo and pricing options",
          "answer_type": "STRING",
          "question": "What would you like to discuss?"
        }
      ],
      "noShow": false,
      "noShowAt": null,
      "scheduledAt": "2026-04-10T08:30:00.000000Z",
      "utm": {
        "utm_campaign": "spring_launch",
        "utm_source": "linkedin",
        "utm_medium": "social",
        "utm_content": null,
        "utm_term": null
      },
      "customQueryParams": {}
    }
  ],
  "guests": [
    "alex.chen@northwind.io"
  ],
  "hosts": [
    {
      "firstName": "Lena",
      "lastName": "Meier",
      "email": "lena.meier@horizondigital.de",
      "slug": "lena-meier",
      "url": "https://zeeg.me/lena-meier",
      "avatarUrl": null
    }
  ],
  "teamName": "Sales",
  "createdAt": "2026-04-10T08:30:00.000000Z",
  "updatedAt": "2026-04-10T08:30:00.000000Z",
  "currentTime": "2026-04-10T08:30:00+00:00"
}