Skip to main content

CreateEventRequest

Request body for creating an event.

display_namestringrequired

The scheduler's full name.

emailemailrequired

The scheduler's email address.

end_atdate-timerequired

The ISO-8601 timestamp when the event ends.

fields object[]

A list of custom fields.

  • Array [
  • idstringrequired

    The field ID.

    labelstringrequired

    The field label.

    typestringrequired

    The field type.

    valuestringrequired

    The field value submitted by the attendee.

  • ]
  • metadata object

    An object containing custom metadata attached to the event.

    property name*any

    An object containing custom metadata attached to the event.

    phone_numberstringnullable

    The scheduler's phone number, formatted like +15555555555 (optional unless "Always gather phone number" is enabled in the scheduling link settings).

    start_atdate-timerequired

    The ISO-8601 timestamp when the event starts.

    time_zonestringrequired

    The scheduler's local Olson time zone.

    Example: America/New_York
    CreateEventRequest
    {
    "display_name": "Jane Smith",
    "email": "jane@example.com",
    "end_at": "2024-01-20T14:30:00Z",
    "fields": [
    {
    "id": "field_123",
    "label": "Company",
    "type": "text",
    "value": "Example Corp"
    }
    ],
    "metadata": {
    "project_type": "Web Application",
    "source": "website"
    },
    "phone_number": "+15555555555",
    "start_at": "2024-01-20T14:00:00Z",
    "time_zone": "America/New_York"
    }