---
title: "Update an appointment"
url: "https://docs.unified.to/dms/appointment/Update_an_appointment"
description: "Update an appointment with Unified's Appointment API (PUT /dms/{connection_id}/appointment/{id}). Filter by fields and raw. Supported by 1 Appointment integration."
date: "2026-11-21T17:08:55.315Z"
updated: "2026-11-21T17:08:55.315Z"
---
# Update an appointment

Updated: November 21, 2026

 PUT/dms/{connection\_id}/appointment/{id}

Updates the DmsAppointment identified by `id`. Provide the unified DmsAppointment fields to change in the request body.

## Parameters

**fields**string array 

id

created\_at

updated\_at

number

status

contact\_id

vehicle\_id

vin

advisor\_user\_id

booked\_by\_user\_id

repairorder\_id

start\_at

end\_at

transport\_type

odometer

odometer\_unit

notes

services

metadata

raw

Fields to return

**raw**string 

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

**connection\_id**string  required 

ID of the connection

**id**string  required 

ID of the Appointment

## Payload

A service appointment (booking)

**id**string 

**created\_at**date-time 

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**updated\_at**date-time 

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**number**string 

Dealer-visible appointment number

**status** enum

Valid values:

 "SCHEDULED" 

 "CONFIRMED" 

 "CONVERTED" 

 "CANCELLED" 

 "NO\_SHOW" 

 "OTHER" 

**contact\_id**string 

Customer, as a CRM Contact

**vehicle\_id**string 

The DmsVehicle ID

**vin**string 

**advisor\_user\_id**string 

Service advisor, as an HR Employee (reference to HrisEmployee)

**booked\_by\_user\_id**string 

Employee who booked the appointment, as an HR Employee (reference to HrisEmployee)

**repairorder\_id**string 

The DmsRepairorder created from this appointment

**start\_at**date-time 

Appointment (due-in) time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**end\_at**date-time 

Promised ready (due-out) time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**transport\_type** enum

Valid values:

 "WAITER" 

 "DROP\_OFF" 

 "SHUTTLE" 

 "LOANER" 

 "RENTAL" 

 "PICKUP\_DELIVERY" 

 "TAXI" 

 "OTHER" 

**odometer**number 

Odometer reported at booking

**odometer\_unit** enum

Valid values:

 "MILES" 

 "KILOMETERS" 

 "HOURS" 

 "OTHER" 

**notes**string 

**services** array 

Requested services

**metadata** array 

**raw** 

Raw data from integration

## Returns

[DmsAppointment](https://docs.unified.to/dms/appointment/model.md)

| Response field                     | Type                      | Required | Description                                                                                                                                                                                                   |
| ---------------------------------- | ------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id                                 | string                    | No       |                                                                                                                                                                                                               |
| created\_at                        | string (date-time)        | No       | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)                                                                                                                                                                      |
| updated\_at                        | string (date-time)        | No       | (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)                                                                                                                                                                      |
| number                             | string                    | No       | Dealer-visible appointment number                                                                                                                                                                             |
| status                             | enum                      | No       | Values: SCHEDULED, CONFIRMED, CONVERTED, CANCELLED, NO\_SHOW, OTHER                                                                                                                                           |
| contact\_id                        | string                    | No       | Customer, as a CRM Contact                                                                                                                                                                                    |
| vehicle\_id                        | string                    | No       | The DmsVehicle ID                                                                                                                                                                                             |
| vin                                | string                    | No       |                                                                                                                                                                                                               |
| advisor\_user\_id                  | string                    | No       | Service advisor, as an HR Employee (reference to HrisEmployee)                                                                                                                                                |
| booked\_by\_user\_id               | string                    | No       | Employee who booked the appointment, as an HR Employee (reference to HrisEmployee)                                                                                                                            |
| repairorder\_id                    | string                    | No       | The DmsRepairorder created from this appointment                                                                                                                                                              |
| start\_at                          | string (date-time)        | No       | Appointment (due-in) time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)                                                                                                                                            |
| end\_at                            | string (date-time)        | No       | Promised ready (due-out) time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)                                                                                                                                        |
| transport\_type                    | enum                      | No       | Values: WAITER, DROP\_OFF, SHUTTLE, LOANER, RENTAL, PICKUP\_DELIVERY, TAXI, OTHER                                                                                                                             |
| odometer                           | number                    | No       | Odometer reported at booking                                                                                                                                                                                  |
| odometer\_unit                     | enum                      | No       | Values: MILES, KILOMETERS, HOURS, OTHER                                                                                                                                                                       |
| notes                              | string                    | No       |                                                                                                                                                                                                               |
| services                           | DmsAppointmentService\[\] | No       | Requested services                                                                                                                                                                                            |
| services\[\].id                    | string                    | No       | Line identifier                                                                                                                                                                                               |
| services\[\].opcode\_id            | string                    | No       | The DmsOpcode ID                                                                                                                                                                                              |
| services\[\].name                  | string                    | No       | Service or operation description                                                                                                                                                                              |
| services\[\].complaint             | string                    | No       | Customer's own words                                                                                                                                                                                          |
| services\[\].pay\_type             | enum                      | No       | Values: CUSTOMER, WARRANTY, INTERNAL, SERVICE\_CONTRACT, OTHER                                                                                                                                                |
| services\[\].estimated\_hours      | number                    | No       |                                                                                                                                                                                                               |
| services\[\].estimate\_amount      | number                    | No       | Estimated price                                                                                                                                                                                               |
| services\[\].technician\_user\_ids | string\[\]                | No       | Pre-assigned technicians, as HR Employees (reference to HrisEmployee)                                                                                                                                         |
| metadata                           | DmsMetadata\[\]           | No       |                                                                                                                                                                                                               |
| metadata\[\].id                    | string                    | No       | The ID of the custom field definition (from the metadata/metadata endpoint).                                                                                                                                  |
| metadata\[\].slug                  | string                    | No       | The integration's API name (key) of an existing custom field.                                                                                                                                                 |
| metadata\[\].value                 | object                    | No       | The field's value, typed by format.                                                                                                                                                                           |
| metadata\[\].namespace             | string                    | No       |                                                                                                                                                                                                               |
| metadata\[\].format                | enum                      | No       | The data type of the custom field, which determines how value is formatted. Values: TEXT, NUMBER, DATE, BOOLEAN, FILE, TEXTAREA, SINGLE\_SELECT, MULTIPLE\_SELECT, MEASUREMENT, PRICE, YES\_NO, CURRENCY, URL |
| metadata\[\].extra\_data           | object                    | No       |                                                                                                                                                                                                               |

## Errors

 Errors return the HTTP status code and a JSON body with `statusCode`, `error` (the short label) and `message` (a human-readable detail). 

```json
{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
```

| Status | Error                 | Meaning                                           |
| ------ | --------------------- | ------------------------------------------------- |
| 400    | Bad Request           | The request was malformed or failed validation.   |
| 401    | Unauthorized          | The connection is likely broken; re-authorize it. |
| 403    | Forbidden             | The connection is missing permissions or scopes.  |
| 404    | Not Found             | The requested resource does not exist.            |
| 429    | Too Many Requests     | Rate limit exceeded (see the two sources below).  |
| 500    | Internal Server Error | An unexpected error occurred.                     |
| 501    | Not Implemented       | Not supported by this integration.                |

 Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message. 

### 429 Too Many Requests

A 429 has two possible sources:

* The integration's own rate limit, passed through.
* Unified's workspace limit: a rolling 60 seconds, set by plan, with the message `Too many requests to unified.to API; max requests per minute: N`.

## Code Samples

### Node.js SDK

```javascript
import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const connectionId = '5de520f96e439b002043d8dc';

const id = '1234';

const results = await sdk.dms.updateDmsAppointment({ connectionId, id, dmsAppointment: { }, 
    fields: '',
    raw: '',
 });
```

### Node.js (axios)

```javascript
const options = {
  method: 'PUT',
  url: 'https://api.unified.to/dms/5de520f96e439b002043d8dc/appointment/5de520f96e439b002043d8d8',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,
  params: {
    fields: '',
    raw: '',
  }
};

const results = await axios.request(options);
```

### Java

```java
AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("PUT", "https://api.unified.to/dms/5de520f96e439b002043d8dc/appointment/5de520f96e439b002043d8d8?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();
```

### Go

```go
import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/dms/5de520f96e439b002043d8dc/appointment/5de520f96e439b002043d8d8?fields=&raw=

req, _ := http.NewRequest("PUT", url, nil)

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
```

### Python

```python
import requests

url = "https://api.unified.to/dms/5de520f96e439b002043d8dc/appointment/5de520f96e439b002043d8d8?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.put(url, headers=headers)
```

### PHP

```php
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/dms/5de520f96e439b002043d8dc/appointment/5de520f96e439b002043d8d8?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);
```

### Ruby

```ruby
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/dms/5de520f96e439b002043d8dc/appointment/5de520f96e439b002043d8d8?fields=&raw=")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

response = http.request(request)
puts response.read_body
```

### cURL

```bash
curl --request PUT \
  --url 'https://api.unified.to/dms/5de520f96e439b002043d8dc/appointment/5de520f96e439b002043d8d8?fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'
```
