Update an appointment
PUT/dms/{connection_id}/appointment/{id}
Updates the DmsAppointment identified by id. Provide the unified DmsAppointment fields to change in the request body.
Parameters
fieldsstring array
Fields to return
rawstring
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_idstring required
ID of the connection
idstring required
ID of the Appointment
Payload
A service appointment (booking)
idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
numberstring
Dealer-visible appointment number
contact_idstring
Customer, as a CRM Contact
vehicle_idstring
The DmsVehicle ID
vinstring
advisor_user_idstring
Service advisor, as an HR Employee (reference to HrisEmployee)
booked_by_user_idstring
Employee who booked the appointment, as an HR Employee (reference to HrisEmployee)
repairorder_idstring
The DmsRepairorder created from this appointment
start_atdate-time
Appointment (due-in) time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atdate-time
Promised ready (due-out) time (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
odometernumber
Odometer reported at booking
odometer_unit enum
Valid values:
"MILES"
"KILOMETERS"
"HOURS"
"OTHER"
notesstring
Returns
| 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).
{
"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.
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); Are we missing anything? Let us know
Was this page helpful?