---
title: "​​AddHold Request - Haulway or OEM will have the capability to add hold on VIN at Origin or Destination (\"O\" or \"D\")"
method: POST
path: "/v1/vehicles/addHold"
tags: ["Requests"]
---

# ​​AddHold Request - Haulway or OEM will have the capability to add hold on VIN at Origin or Destination ("O" or "D")

`POST /v1/vehicles/addHold`

## Request

- Base URL: `https://api.bnsf.com:6443`
- URL: `https://api.bnsf.com:6443/v1/vehicles/addHold`
- Auth: none declared
- TypeScript: <https://skmtc.dev/bnsf/apis/bnsf-automotive-hub-operations-api/docs/v1/vehicles/addHold/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- AutomotiveVehicleHoldAdd
  - `automotiveVehicleHoldChangeRequestedById` string, required: Identifier of the entity that has requested a hold status change for automotive vehicles (by VIN). Values originate from other sources and may include SCAC, Manufacturer ID, etc.
  - `automotiveHoldOriginDestinationCode` string, required: Code that defines if the associated Automotive hold information relates to an origin or destination location.
  - `vinList` string[], required: Comma separated list of VIN (Vehicle Identification Numbers).

## Response `200`

**OK**

The request has succeeded.

- object
  - `vinHoldResponseMessageText` string

## Other responses

- `400`: **Bad Request** The request could not be understood by the server due to incorrect syntax. Do not repeat the request without modifications.
- `403`: Unauthorized request. Here are the most common causes: * You are getting 403 Access Denied. * It takes a few days for us to get you set up after you register. When set up is complete, you will receive an email letting you know. If you have not received the email, please wait up to five business days. Let us know via API Support if you still have not received the email after five business days. * You can also get this error if your certificate is not configured properly on your side. Please review the Mutual Authentication in the Getting Started section of our documentation. * You are getting 403 "message": "Insufficient privileges" when accessing a restricted service for which you do not have permission. You can use our Registration form to request access. Be sure to explain the situation in the "Please explain how you intend to use the API" field.
- `404`: **Not Found** The server cannot find the requested resource (URI). That is, the address of the endpoint in your request does not exist. Please consult the documentation.
- `405`: **Method Not Allowed** The request HTTP method is known by the server but has been disabled and cannot be used for that resource. For example, you may be using GET when POST is required. Please consult the documentation.
- `429`: **Too Many Requests** The BNSF API Gateway enforces rate limits to maintain application security and performance. Current rate limits are set as follows: * 1 API Request Per Second, Per Partner, Per Service * 15 API Requests Per Minute, Per Partner, Per Service * 100 API Request Per Minute, Per Service When requests exceed these limits the API Gateway will return a **429 Too Many Requests** error response. Upon receiving such exceptions, you can resubmit failed requests in a rate-limited manner, complying with the API Gateway throttle limits.
- `500`: **Internal Server Error** The server encountered an unexpected condition which prevented it from fulfilling the request. This is always a problem on the server side. Our internal support systems will be made aware.
- `504`: **Gateway Timeout** The server is acting as a gateway and cannot get a response in time for a request. Wait about one minute then try again.

---

[API](https://skmtc.dev/bnsf/apis/bnsf-automotive-hub-operations-api.md) - [All operations](https://skmtc.dev/bnsf/apis/bnsf-automotive-hub-operations-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bnsf/apis/bnsf-automotive-hub-operations-api/revisions/99256a51c862?raw)