# Updates an Event (V1) by ID

Updates an existing event. Supports updating single occurrences or entire recurring series based on the recurrenceTarget parameter.

Endpoint: PUT /v1/events/{eventId}
Version: 191.0.3
Security: bearerAuth, oAuthSandbox

## Security:

  - `bearerAuth` (unknown)
    http bearer JWT

  - `oAuthSandbox` (unknown)
    oauth2

## Path parameters:

  - `eventId` (integer, required)
    ID of the event to update

## Query parameters:

  - `recurrenceTarget` (string, required)
    This parameter defines whether the series of events will be updated or just a single occurrence.
- **SERIES**: Updates the entire recurring series
- **OCCURRENCE**: Updates only the single occurrence

  - `responseFields` (string)
    A URL-encoded, comma-delimited list of field names to include in the response data. Supported values:
- **ALL**: Returns all field names.
- Example: id, title, start, end, duration

## Header parameters:

  - `Organization-ID` (string, required)
    Organization context for the request. Must match the organization authorized by the access token.

## Request body:

  - `application/json` (unknown)
    **Purpose:** Update the Event identified by the path parameter.
**Required fields:** Only included properties are updated; omitted fields are unchanged.
**Idempotency:** Not supported.

## Request fields (application/json):

  - `title` (string, required)

  - `description` (string)
    Example: This is a detailed description of the event.

  - `start` (string, required)
    Example: 2018-07-09T19:00:00.000Z

  - `end` (string)
    Example: 2018-07-09T20:00:00.000Z

  - `allDay` (boolean)
    Example: true

  - `recurrenceType` (string)
    Enum: "WEEKLY", "MONTHLY"

  - `recurrenceStart` (string)
    Example: 2018-07-09

  - `recurrenceEnd` (string)
    Example: 2018-07-09

  - `recurrenceFrequency` (integer)
    Example: 1

  - `recurrenceDays` (array)
    Example: ["MONDAY","WEDNESDAY","FRIDAY"]

  - `recurrenceWeek` (string)
    Enum: "FIRST", "SECOND", "THIRD", "FOURTH", "LAST"

  - `recurrenceDay` (string)
    Enum: "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"

  - `color` (string)
    Hexadecimal color code (6 characters, without # prefix)
    Example: FF5733

  - `duration` (integer)
    This is a field that returns the duration of the appointment in minutes.
    Example: 30

  - `provider` (object)
    A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed.

  - `provider.id` (integer, required)
    The unique identifier for the linked model.
    Example: 12345

  - `location` (object, required)
    A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed.

  - `location.id` (integer, required)
    The unique identifier for the linked model.
    Example: 12345

  - `operatory` (object)
    A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed.

  - `operatory.id` (integer, required)
    The unique identifier for the linked model.
    Example: 12345

## Response 200:

  - `200` (unknown)
    Event updated successfully

## Response 200 fields (application/json):

  - `data` (object)
    This Endpoint is being rate limited. More information can be found here: https://portal.hs1api.com/guide
    Example: {}

  - `data.title` (string, required)

  - `data.description` (string)
    Example: This is a detailed description of the event.

  - `data.start` (string, required)
    Example: 2018-07-09T19:00:00.000Z

  - `data.end` (string)
    Example: 2018-07-09T20:00:00.000Z

  - `data.allDay` (boolean)
    Example: true

  - `data.recurrenceType` (string)
    Enum: "WEEKLY", "MONTHLY"

  - `data.recurrenceStart` (string)
    Example: 2018-07-09

  - `data.recurrenceEnd` (string)
    Example: 2018-07-09

  - `data.recurrenceFrequency` (integer)
    Example: 1

  - `data.recurrenceDays` (array)
    Example: ["MONDAY","WEDNESDAY","FRIDAY"]

  - `data.recurrenceWeek` (string)
    Enum: "FIRST", "SECOND", "THIRD", "FOURTH", "LAST"

  - `data.recurrenceDay` (string)
    Enum: "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY"

  - `data.color` (string)
    Hexadecimal color code (6 characters, without # prefix)
    Example: FF5733

  - `data.id` (integer)
    Example: 32424423

  - `data.duration` (integer)
    This is a field that returns the duration of the appointment in minutes.
    Example: 30

  - `data.lastModified` (string)
    Example: 2018-07-09T19:00:00.000Z

  - `data.groupId` (string)

  - `data.provider` (object)
    A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed.

  - `data.provider.id` (integer, required)
    The unique identifier for the linked model.
    Example: 12345

  - `data.provider.type` (string)
    The type of the linked model. This field is read-only.
    Example: ExampleModelType

  - `data.provider.url` (string, required)
    The URL at which the linked model can be accessed. This field is read-only.
    Example: https://api.example.com/models/12345

  - `data.location` (object, required)
    A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed.

  - `data.location.id` (integer, required)
    The unique identifier for the linked model.
    Example: 12345

  - `data.location.type` (string)
    The type of the linked model. This field is read-only.
    Example: ExampleModelType

  - `data.location.url` (string, required)
    The URL at which the linked model can be accessed. This field is read-only.
    Example: https://api.example.com/models/12345

  - `data.operatory` (object)
    A reference to a linked model. Includes the id, the type, and URL at which the model can be accessed.

  - `data.operatory.id` (integer, required)
    The unique identifier for the linked model.
    Example: 12345

  - `data.operatory.type` (string)
    The type of the linked model. This field is read-only.
    Example: ExampleModelType

  - `data.operatory.url` (string, required)
    The URL at which the linked model can be accessed. This field is read-only.
    Example: https://api.example.com/models/12345

  - `warnings` (array)

  - `warnings.code` (string)

  - `warnings.title` (string)

  - `warnings.description` (string)

  - `warnings.source` (string)

  - `errors` (array)

## Response 400:

  - `400` (unknown)
    The request was invalid or cannot be processed

## Response 401:

  - `401` (unknown)
    Authentication is required and has failed or has not been provided

## Response 403:

  - `403` (unknown)
    The request is understood, but it has been refused or access is not allowed

## Response 404:

  - `404` (unknown)
    The requested resource is either missing or does not exist

## Response 408:

  - `408` (unknown)
    The server timed out while processing the request

## Response 429:

  - `429` (unknown)
    Rate limit exceeded

## Response 500:

  - `500` (unknown)
    An unexpected error occurred

## Response 200 examples:

  - `default` (unknown)