# Update calendar event

Update a Brigg-owned calendar event. Set send_update to send updated invitations to attendees. This does not change an event in a connected Google or Microsoft calendar.

POST https://api.brigg.app/v1/operations/meetings.UpdateCalendarEvent

## Access & visibility

Allow `meetings.UpdateCalendarEvent` on your API key. Resource write permissions: `core:CalendarEvent`.

**Workspace access by default.** Private member data requires [approved member delegation](https://developer.brigg.app/authentication#member-delegation) through `Brigg-Act-As`; the key supplies permissions while private ownership and project boundaries remain enforced.

[Set up authentication](https://developer.brigg.app/authentication) · [Choose permissions](https://developer.brigg.app/permissions)

## Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | The core:CalendarEvent entry id. At least 1 character. |
| `patch` | [object](#request-patch) | Yes | Requested changes to the calendar event. |
| `send_update` | boolean | No | Mail the updated invitation to every attendee. |
| `message` | string | No | Message included with the calendar invitation update or cancellation. |

### request.patch

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `title` | string | No | Display title. At least 1 character. |
| `start` | string | No | Start timestamp with an explicit time zone, for example 2026-11-10T10:00:00+01:00. Brigg normalizes it to UTC. Do not send a date without a time zone. |
| `end` | string | No | End timestamp with an explicit time zone, strictly later than start. Returned calendar times use UTC. |
| `location` | string | No | Physical address or meeting location supplied to invitees. |
| `description` | string | No | Descriptive text. |
| `agenda` | string | No | Discussion topics planned for the meeting. |
| `notes` | string | No | Notes supplied for the calendar event. |
| `attendees` | array of string | No | Workspace member account IDs from [List colleagues](https://developer.brigg.app/reference/workspace/ListColleagues), not Person record IDs or email addresses. Members without an email address are returned in send.skipped. |
| `visibility` | array of string | No | Reserved compatibility field; it currently has no effect. Omit it. It cannot make the calendar event private or grant access to attendees. At least 1 item. |

## Update the saved event and its invitations

Use the Brigg event `id` from [List calendar events](https://developer.brigg.app/reference/meetings/ListCalendarEvents). Send only changed fields in `patch`. `send_update` defaults to false. Set it to true to email the event's attendees. The response's `significant` flag indicates an invitation-relevant change; `sequence` advances for such changes.

The event update can succeed even when email is held: inspect `send.rate_limited` and `send.skipped`. A new delivery attempt is a new action with a new idempotency key. Retrying a lost response to the same action reuses its original key.

## Response

Returns **200 OK** with a JSON body.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | Yes | Unique identifier. Use the value returned by a create or list operation. |
| `uid` | string | Yes | Calendar invitation UID, distinct from the Brigg record ID. |
| `sequence` | number | Yes | Calendar invitation revision number. |
| `significant` | boolean | Yes | Whether time or place changed. |
| `send` | [object](#response-send) | No | Present when a mail-out was asked for. |

### response.send

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `message_ids` | map of string | Yes | Recipient email address to delivery message ID. |
| `skipped` | array of string | Yes | Attendee account ids with no email address. |
| `rate_limited` | boolean | No | The org's invite quota was hit — the event write landed, no mail went out. |

## Errors & retries

Set `BRIGG_REQUEST_ID` once for each logical action. The samples send it as `Idempotency-Key`. Reuse the same value and body on retries, including after a timeout; a missing response does not prove the action failed.

For rate limits, follow the server’s retry guidance and back off. See [HTTP errors](https://developer.brigg.app/http#errors) and [safe retries and limits](https://developer.brigg.app/reliability).

| HTTP status | Code | What to do |
| --- | --- | --- |
| 400 | `invalid_json` | Send a JSON object with Content-Type: application/json. |
| 400 | `invalid_input` | Check the request fields and types. Supply a stable Idempotency-Key containing 1–200 characters. |
| 401 | `invalid_key` | The workspace API key is missing, invalid or revoked. |
| 403 | `forbidden` | Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member. |
| 404 | `not_found` | The requested operation or resource is not available to this credential. |
| 429 | `rate_limited` | Wait for Retry-After before retrying. Reuse the original Idempotency-Key. |

## Next steps

- [Get calendar event](https://developer.brigg.app/reference/meetings/GetCalendarEvent)
- [List calendar events](https://developer.brigg.app/reference/meetings/ListCalendarEvents)
- [List colleagues](https://developer.brigg.app/reference/workspace/ListColleagues)

[Download OpenAPI](https://developer.brigg.app/openapi.json) · [Versioning & retirement](https://developer.brigg.app/versioning)

## Examples

### Example request

Fictional values. Replace IDs and business details with values from your workspace.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/meetings.UpdateCalendarEvent' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "id": "e_example",
  "patch": {}
}'
```

#### TypeScript


```typescript
const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/meetings.UpdateCalendarEvent", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "id": "e_example",
    "patch": {}
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```python
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "id": "e_example",
  "patch": {}
}
request = Request(
    "https://api.brigg.app/v1/operations/meetings.UpdateCalendarEvent",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise
```

#### Response example


```json
{
  "id": "e_example",
  "uid": "kickoff@example.com",
  "sequence": 1,
  "significant": false
}
```

## JSON schemas


```json-schema-request
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "description": "The core:CalendarEvent entry id."
    },
    "patch": {
      "type": "object",
      "properties": {
        "title": {
          "type": "string",
          "minLength": 1,
          "description": "Display title."
        },
        "start": {
          "type": "string",
          "description": "Start timestamp with an explicit time zone, for example 2026-11-10T10:00:00+01:00. Brigg normalizes it to UTC. Do not send a date without a time zone."
        },
        "end": {
          "type": "string",
          "description": "End timestamp with an explicit time zone, strictly later than start. Returned calendar times use UTC."
        },
        "location": {
          "type": "string",
          "description": "Physical address or meeting location supplied to invitees."
        },
        "description": {
          "type": "string",
          "description": "Descriptive text."
        },
        "agenda": {
          "type": "string",
          "description": "Discussion topics planned for the meeting."
        },
        "notes": {
          "type": "string",
          "description": "Notes supplied for the calendar event."
        },
        "attendees": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Workspace member account IDs from [List colleagues](https://developer.brigg.app/reference/workspace/ListColleagues), not Person record IDs or email addresses. Members without an email address are returned in send.skipped."
        },
        "visibility": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "minItems": 1,
          "description": "Reserved compatibility field; it currently has no effect. Omit it. It cannot make the calendar event private or grant access to attendees."
        }
      },
      "additionalProperties": false,
      "description": "Requested changes to the calendar event."
    },
    "send_update": {
      "type": "boolean",
      "description": "Mail the updated invitation to every attendee."
    },
    "message": {
      "type": "string",
      "description": "Message included with the calendar invitation update or cancellation."
    }
  },
  "required": [
    "id",
    "patch"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "id": "e_example",
      "patch": {}
    }
  ]
}
```


```json-schema-response
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier. Use the value returned by a create or list operation."
    },
    "uid": {
      "type": "string",
      "description": "Calendar invitation UID, distinct from the Brigg record ID."
    },
    "sequence": {
      "type": "number",
      "description": "Calendar invitation revision number."
    },
    "significant": {
      "type": "boolean",
      "description": "Whether time or place changed."
    },
    "send": {
      "type": "object",
      "description": "Present when a mail-out was asked for.",
      "properties": {
        "message_ids": {
          "description": "Recipient email address to delivery message ID.",
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        },
        "skipped": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Attendee account ids with no email address."
        },
        "rate_limited": {
          "type": "boolean",
          "description": "The org's invite quota was hit — the event write landed, no mail went out."
        }
      },
      "required": [
        "message_ids",
        "skipped"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "id",
    "uid",
    "sequence",
    "significant"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "id": "e_example",
      "uid": "kickoff@example.com",
      "sequence": 1,
      "significant": false
    }
  ]
}
```