logo
Events

Update event

Update an existing event by its unique ID.

PATCH
/events/{id}

Authorization

x-kommunity-api-key<token>

In: header

Request Body

application/jsonRequired
namestring
descriptionstring
categorystring
subcategorystring
attendeeLimitinteger
countrystring
streetstring
citystring
statestring
zipCodestring
eventImgstring
startTimestring
endTimestring
timezonestring
ticketsarray<object>

Only include the ID if you want to update an existing ticket

joinUrlstring
questionsarray<object>

Only include the ID if you want to update an existing question

Path Parameters

idRequiredstring

Unique identifier for the event

Response Body

Event updated successfully

successboolean
dataobject
export interface Response {
  success?: boolean;
  data?: {
    event?: Event;
  };
}
export interface Event {
  /**
   * Name of the event
   */
  name?: string;
  /**
   * Detailed description of the event
   */
  description?: string;
  /**
   * Primary category the event belongs to
   */
  category?: string;
  /**
   * Subcategory for more specific event classification
   */
  subcategory?: string;
  /**
   * Maximum number of attendees allowed (null means no limit)
   */
  attendeeLimit?: number | null;
  /**
   * Country where the event takes place (required for in-person events)
   */
  country?: string | null;
  /**
   * Street address (required for in-person events)
   */
  street?: string | null;
  /**
   * City (required for in-person events)
   */
  city?: string | null;
  /**
   * State or province (required for in-person events)
   */
  state?: string | null;
  /**
   * Postal/ZIP code (required for in-person events)
   */
  zipCode?: string | null;
  /**
   * URL to the event image
   */
  eventImg?: string | null;
  /**
   * Event start time in ISO 8601 format (in UTC)
   */
  startTime?: string;
  /**
   * Event end time in ISO 8601 format (in UTC)
   */
  endTime?: string;
  /**
   * Timezone identifier for the event
   */
  timezone?: string;
  /**
   * Contact email for the event
   */
  email?: string;
  /**
   * Contact phone number
   */
  phone?: string;
  /**
   * @minItems 0
   */
  tickets?: {
    id?: string;
    name?: string;
    price?: number;
  }[];
  joinUrl?: string | null;
  /**
   * @minItems 0
   */
  questions?: {
    id?: string;
    question?: string;
    required?: boolean;
  }[];
}
 
curl -X PATCH "/api/v1/events/string" \
  -H "x-kommunity-api-key: <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "category": "string",
    "subcategory": "string",
    "attendeeLimit": 0,
    "country": "string",
    "street": "string",
    "city": "string",
    "state": "string",
    "zipCode": "string",
    "eventImg": "string",
    "startTime": "string",
    "endTime": "string",
    "timezone": "string",
    "tickets": [
      {
        "id": "string",
        "name": "string",
        "price": 0
      }
    ],
    "joinUrl": "string",
    "questions": [
      {
        "id": "string",
        "question": "string",
        "required": true
      }
    ]
  }'
{
  "success": true,
  "data": {
    "event": {
      "name": "string",
      "description": "string",
      "category": "string",
      "subcategory": "string",
      "attendeeLimit": 1,
      "country": "string",
      "street": "string",
      "city": "string",
      "state": "string",
      "zipCode": "string",
      "eventImg": "string",
      "startTime": "2019-08-24T14:15:22Z",
      "endTime": "2019-08-24T14:15:22Z",
      "timezone": "string",
      "email": "[email protected]",
      "phone": "string",
      "tickets": [
        {
          "id": "string",
          "name": "string",
          "price": 0
        }
      ],
      "joinUrl": "string",
      "questions": [
        {
          "id": "string",
          "question": "string",
          "required": true
        }
      ]
    }
  }
}