> ## Documentation Index
> Fetch the complete documentation index at: https://omni.fireflo.au/llms.txt
> Use this file to discover all available pages before exploring further.

# PATCH /v1/calendar/appointments/{appointment_id}

> Change an appointment's notes, place, meeting link or mode.

Changes an appointment's details. Send only what changes. To move it to another time or teammate, [reschedule it](/api-reference/calendar/reschedule). A change other than to `notes` is added to its history and sends `appointment.updated`.

<Note>Needs the `calendar:write` scope.</Note>

## Path parameters

| Field | Type | Required | Notes |
| :- | :- | :- | :- |
| `appointment_id` | string | Yes | The appointment's id. |

## Body

| Field | Type | Required | Notes |
| :- | :- | :- | :- |
| `notes` | string | No | The team's notes. Up to 5,000 characters. |
| `location` | string | No | Where it happens in person. Up to 255 characters. |
| `meeting_link` | string | No | The link for online. Up to 500 characters. |
| `mode` | string | No | `online` or `physical`. |

## Request

<CodeGroup>
  ```bash cURL theme={null}
  curl -X PATCH "https://api.fireflo.au/v1/calendar/appointments/5b0e7d3c-9a2f-4c61-8e47-1f3a6c9d2b84" \
    -H "Authorization: Bearer $OMNI_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{
    "mode": "physical",
    "location": "Kaveri Homes, 2nd floor, Kalpataru Plaza, Andheri East, Mumbai"
  }'
  ```

  ```python Python theme={null}
  import os

  import requests

  response = requests.patch(
      "https://api.fireflo.au/v1/calendar/appointments/5b0e7d3c-9a2f-4c61-8e47-1f3a6c9d2b84",
      headers={"Authorization": f"Bearer {os.environ['OMNI_API_KEY']}"},
      json={
          "mode": "physical",
          "location": "Kaveri Homes, 2nd floor, Kalpataru Plaza, Andheri East, Mumbai"
      },
  )
  print(response.status_code, response.json())
  ```

  ```javascript Node theme={null}
  const response = await fetch("https://api.fireflo.au/v1/calendar/appointments/5b0e7d3c-9a2f-4c61-8e47-1f3a6c9d2b84", {
    method: "PATCH",
    headers: {
      Authorization: `Bearer ${process.env.OMNI_API_KEY}`,
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      "mode": "physical",
      "location": "Kaveri Homes, 2nd floor, Kalpataru Plaza, Andheri East, Mumbai"
    }),
  });
  console.log(response.status, await response.json());
  ```
</CodeGroup>

## Response

`200 OK` — the appointment as it is now.

```json theme={null}
{
  "id": "5b0e7d3c-9a2f-4c61-8e47-1f3a6c9d2b84",
  "title": "Home loan consultation",
  "status": "confirmed",
  "booking_type": {
    "id": 3,
    "name": "Home loan consultation"
  },
  "contact": {
    "id": "3f6b2a1e-8c4d-4e2a-9b7f-5d1c0e8a9f42",
    "name": "Ravi Kumar",
    "phone": "+919876500101"
  },
  "staff": {
    "name": "Priya Sharma",
    "email": "priya@acme.in"
  },
  "starts_at": "2026-10-08T10:30:00+05:30",
  "ends_at": "2026-10-08T11:00:00+05:30",
  "mode": "physical",
  "location": "Kaveri Homes, 2nd floor, Kalpataru Plaza, Andheri East, Mumbai",
  "meeting_link": "https://meet.google.com/kfr-ptqw-xya",
  "notes": "Salaried, looking at a ₹45 lakh loan. Bring Form 16.",
  "source": "api",
  "deal": null,
  "created_at": "2026-10-06T04:12:04.512903+00:00",
  "updated_at": "2026-10-06T06:02:37.771209+00:00"
}
```

## Errors

Every refusal is `{"error": {"code", "message", "field"}}`; `field` is there when one input is at fault.

| Status | Error code | When |
| :- | :- | :- |
| 404 | `not_found` | No appointment of this account's has that id. |
| 400 | `invalid_request` | A field isn't text, is too long, or `mode` isn't `online` or `physical` (`field` names it). |
| 404 | `module_off` | The account's plan doesn't include Calendar. |
| 403 | `scope_missing` | The key doesn't have the `calendar:write` scope. |

Any request can also be refused for its key, its account or its rate (`key_required`, `invalid_key`, `account_suspended`, `plan_excludes_api`, `address_not_allowed`, `rate_limited`); see [the overview](/api-reference/overview).


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