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

# Create an event

> Creates a conference, virtual event, webinar, field event or third-party event. The kind is set by eventType, and for a STANDARD event the eventFormat separates a Conference (HYBRID) from a Virtual event (VIRTUAL). Returns 422 with every problem at once when something is missing or ambiguous.

Required API key scopes: `WRITE`

**This API can only be called with an access key that was generated for Backend usage.**



## OpenAPI

````yaml https://api.prod.zuddl.com/api/v3/api-docs/api-product post /v1/events
openapi: 3.1.0
info:
  title: Zuddl API Documentation
  description: >-
    Zuddl RESTful APIs let you interact with the Zuddl platform and take action
    for your event or webinar. They let you add attendees, get attendee details,
    get event details, and more.


    The API response is returned in JSON, which your systems can easily consume.


    The API parameters allow you to customize the response using filters,
    sorting, pagination, and other parameters. Parameter values should be
    percent-encoded (URL-encoded) to ensure correct transmission, especially if
    they contain special characters such as spaces, semi-colons, or slashes.


    # Rate limits


    | Metrics | Value |

    | --- | --- |

    | Requests/second | 10 |

    | Burst or no. of concurrent calls allowed | 100 requests |

    | Total quota | 10000 requests/day |
  version: '1.0'
servers:
  - url: https://api.zuddl.com/
security:
  - api_key: []
tags:
  - name: Events
    description: API endpoints for managing events
  - name: Attendees
    description: >-
      The attendee APIs let you add and retrieve attendee in a particular event
      type.
  - name: Sessions
    description: API endpoints for managing event sessions
  - name: Speakers
    description: API endpoints for managing event speakers
  - name: Sponsors
    description: API endpoints for managing event sponsors
  - name: Teams
    description: API endpoints for reading the teams events can be created in
  - name: Locations
    description: API endpoints for managing event locations
paths:
  /v1/events:
    post:
      tags:
        - Events
      summary: Create an event
      description: >-
        Creates a conference, virtual event, webinar, field event or third-party
        event. The kind is set by eventType, and for a STANDARD event the
        eventFormat separates a Conference (HYBRID) from a Virtual event
        (VIRTUAL). Returns 422 with every problem at once when something is
        missing or ambiguous.


        Required API key scopes: `WRITE`


        **This API can only be called with an access key that was generated for
        Backend usage.**
      operationId: createEvent
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/org.events.app.domain.api_product.event.EventCreateRequest
        required: true
      responses:
        '201':
          description: Event created
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/org.events.app.domain.api_product.event.CreateEventOutcome
        '400':
          description: Malformed request body
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/org.events.app._internal._response.v1.ApiErrorResponse
        '401':
          description: The organization's plan does not include this event type
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/org.events.app._internal._response.v1.ApiErrorResponse
        '403':
          description: No permission to create events in the resolved team
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/org.events.app._internal._response.v1.ApiErrorResponse
        '422':
          description: >-
            Well-formed but cannot be acted on yet; nothing was created. code is
            NEEDS_INPUT and params.violations lists every missing or
            unresolvable field (field, code, message, options[]);
            params.resolvedPlan carries the values that were resolved so far.
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/org.events.app._internal._response.v1.ApiErrorResponse
components:
  schemas:
    org.events.app.domain.api_product.event.EventCreateRequest:
      properties:
        eventType:
          type: string
          description: >-
            Event type, in the public taxonomy shared with every /v1 read: EVENT
            covers both Conference and Virtual event (eventFormat distinguishes
            them), FIELD_EVENT, WEBINAR, THIRD_PARTY_EVENT. Determines which
            other fields apply.
          enum:
            - EVENT
            - FIELD_EVENT
            - WEBINAR
            - THIRD_PARTY_EVENT
        title:
          type: string
          description: Name of the event.
          maxLength: 400
          minLength: 0
        description:
          type: string
          description: Description of the event. Required. Rich-text HTML.
          maxLength: 20000
          minLength: 0
        startDateTime:
          type: string
          format: date-time
        endDateTime:
          type: string
          format: date-time
          description: End of the event. Required, and must be after startDateTime.
        tz:
          type: string
          description: IANA timezone of the event, e.g. Asia/Kolkata. Required.
          maxLength: 50
          minLength: 0
        teamId:
          type: string
          description: Identifier of the owning team. Required.
          minLength: 1
        eventFormat:
          type: string
          description: >-
            VIRTUAL, IN_PERSON or HYBRID. Applies to EVENT only — it is what
            separates a Conference from a Virtual event. Set by the server for
            every other type.
          enum:
            - VIRTUAL
            - IN_PERSON
            - HYBRID
        addressDetails:
          $ref: >-
            #/components/schemas/org.events.app.domain.api_product.event.EventCreateRequest.Location
        brandKitId:
          type: string
          description: Identifier of a published brand kit to apply.
        salesforceCampaignId:
          type: string
          description: >-
            Salesforce campaign ID to link. Some organizations require it; a 422
            says so.
        tagNames:
          type: array
          description: >-
            Names of existing organization tags. Maximum 10. Never created
            implicitly.
          items:
            type: string
            description: >-
              Names of existing organization tags. Maximum 10. Never created
              implicitly.
          maxItems: 10
          minItems: 0
        languageCodes:
          type: array
          items:
            type: string
      required:
        - eventType
        - startDateTime
        - teamId
        - title
        - tz
    org.events.app.domain.api_product.event.CreateEventOutcome:
      description: >-
        Result of a successful create. A request that cannot proceed is a 422
        ApiErrorResponse instead.
      properties:
        status:
          type: string
          description: >-
            NEEDS_INPUT when the request cannot proceed, CREATED when the event
            exists.
          enum:
            - NEEDS_INPUT
            - CREATED
        eventId:
          type: string
          description: >-
            Identifier of the created event. Present only when status is
            CREATED.
        eventUrl:
          type: string
          description: >-
            Link to the created event's setup page. Present only when status is
            CREATED.
    org.events.app._internal._response.v1.ApiErrorResponse:
      properties:
        timestamp:
          type: string
          format: date-time
        message:
          type: string
        description:
          type: string
        code:
          type: string
        params:
          type: object
          additionalProperties:
            type: object
        errors:
          type: object
          additionalProperties:
            type: string
    org.events.app.domain.api_product.event.EventCreateRequest.Location:
      properties:
        name:
          type: string
          minLength: 1
        locality:
          type: string
        city:
          type: string
        state:
          type: string
        country:
          type: string
        postalCode:
          type: string
        latitude:
          type: string
        longitude:
          type: string
        placeId:
          type: string
      required:
        - name
  securitySchemes:
    api_key:
      type: apiKey
      description: Provide your API key secret in the `Authorization` header
      name: Authorization
      in: header

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.