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 '
{
  "ownerSlug": "lena-meier",
  "eventTypeSlug": "30min-discovery-call",
  "date": "2026-04-15",
  "duration": 30,
  "name": "Sophie Laurent",
  "email": "sophie.laurent@northwind.io",
  "guests": [
    "alex.chen@northwind.io"
  ],
  "location": "GOOGLE_MEET",
  "timeZone": "Europe/Paris",
  "start": "09:00",
  "question_answers": [
    {
      "question_id": 1,
      "answer": "Product demo and pricing options"
    }
  ],
  "customQueryParams": {},
  "utm": {
    "utm_campaign": "spring_launch",
    "utm_source": "linkedin",
    "utm_medium": "social"
  }
}
'

{
  "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?"
        }
      ],
      "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
    }
  ],
  "createdAt": "2026-04-10T08:30:00.000000Z",
  "updatedAt": "2026-04-10T08:30:00.000000Z",
  "currentTime": "2026-04-10T08:30:00+00:00"
}

{
  "success": false,
  "message": "The requested time slot is not available for booking. Please select another time.",
  "status": 400
}

{
  "message": "Unauthenticated."
}

{
  "success": false,
  "message": "You cannot access this resource.",
  "status": 403
}

{
  "error": "Entry for EventType not found"
}

{
  "message": "The date field must be a valid date.",
  "errors": {
    "date": [
      "The date field must be a valid date."
    ]
  }
}

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.

ownerSlug

string

required

The slug of the scheduling page owner, can be a user or a team.

eventTypeSlug

string

required

The slug of the scheduling page.

date

string<date>

required

The event date in YYYY-MM-DD format.

duration

integer

required

Meeting duration in minutes.

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"

phone

string

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

guests

string<email>[]

Array of additional guest email addresses.

location

string

Location type identifier (required if locations are enabled in the scheduling page). 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).
Other types as configured in the scheduling page (e.g. "ZOOM", "GOOGLE_MEET", "MICROSOFT_TEAMS").

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

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.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[] | null

Array of additional emails invited

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.utm

object

UTM tracking parameters captured at booking time.

Hide child attributes

invitees.utm.utm_campaign

string | null

invitees.utm.utm_source

string | null

invitees.utm.utm_medium

string | null

invitees.utm.utm_content

string | null

invitees.utm.utm_term

string | null

invitees.customQueryParams

any[]

Custom query parameters captured at booking time.

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.

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[] | null

Array of additional emails invited

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

Get Available Time Slots by Shared Link

Get All Availability Schedules

curl --request POST \
  --url https://api.zeeg.me/v2/event \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ownerSlug": "lena-meier",
  "eventTypeSlug": "30min-discovery-call",
  "date": "2026-04-15",
  "duration": 30,
  "name": "Sophie Laurent",
  "email": "sophie.laurent@northwind.io",
  "guests": [
    "alex.chen@northwind.io"
  ],
  "location": "GOOGLE_MEET",
  "timeZone": "Europe/Paris",
  "start": "09:00",
  "question_answers": [
    {
      "question_id": 1,
      "answer": "Product demo and pricing options"
    }
  ],
  "customQueryParams": {},
  "utm": {
    "utm_campaign": "spring_launch",
    "utm_source": "linkedin",
    "utm_medium": "social"
  }
}
'

{
  "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?"
        }
      ],
      "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
    }
  ],
  "createdAt": "2026-04-10T08:30:00.000000Z",
  "updatedAt": "2026-04-10T08:30:00.000000Z",
  "currentTime": "2026-04-10T08:30:00+00:00"
}

{
  "success": false,
  "message": "The requested time slot is not available for booking. Please select another time.",
  "status": 400
}

{
  "message": "Unauthenticated."
}

{
  "success": false,
  "message": "You cannot access this resource.",
  "status": 403
}

{
  "error": "Entry for EventType not found"
}

{
  "message": "The date field must be a valid date.",
  "errors": {
    "date": [
      "The date field must be a valid date."
    ]
  }
}