Update Vendor
Update a Vendor
Path Parameters
- id string required
Possible values: Value must match regular expression
^[0-9]+$
The id of the relevant record
- application/json
Request Body
- name string
Possible values:
<= 255 characters
The name of the Vendor. Must be unique.
- city string
Possible values:
<= 255 characters
The city of the Vendor.
- contact_email string
Possible values:
<= 255 characters
The email address of the contact person for the Vendor.
- contact_name string
Possible values:
<= 255 characters
The name of the contact person for the Vendor.
- contact_phone string
Possible values:
<= 255 characters
The phone number of the contact person for the Vendor.
- country string
Possible values:
<= 255 characters
The country of the Vendor.
- external_id string
Possible values:
<= 255 characters
An external ID for the Vendor. Must be unique.
- phone string
Possible values:
<= 255 characters
The phone number of the Vendor.
- postal_code string
Possible values:
<= 255 characters
The postal code or ZIP code of the Vendor.
- region string
Possible values:
<= 255 characters
The region, state, province, or territory of the Vendor.
- street_address string
Possible values:
<= 255 characters
The street address of the Vendor.
- street_address_line_2 string
Possible values:
<= 255 characters
The second line of the street address of the Vendor.
- website string
Possible values:
<= 255 characters
The website of the Vendor.
- fuel boolean
Indicates whether the Vendor provides fuel. Will be able to be listed on
Fuel Entries
. - service boolean
Indicates whether the Vendor provides service. This Vendor will be able to be listed on
Service Entries
andWork Orders
. - parts boolean
Indicates whether the Vendor provides parts. This Vendor will be able to be listed on
Parts
andPurchase Orders
. - vehicle boolean
Indicates whether the Vendor provides vehicles. This Vendor will be able to be listed on
Acquisitions
andVehicles
. - custom_fields object
*Full details on working with Custom Fields here.
- 200
- 401
- 403
- 404
- 422
- 500
OK
Response Headers
- application/json
- Schema
- Example (from schema)
Schema
- id integer
Possible values:
>= 1
- created_at date-time
The date and time at which this record was created.
- updated_at date-time
The date and time at which this record was most recently updated.
- name string
The name of the Vendor.
- phone string
The phone number of the Vendor.
- street_address string
The street address of the Vendor.
- street_address_line_2 string
The second line of the street address of the Vendor.
- city string
The city of the Vendor.
- region string
The region, state, province, or territory of the Vendor.
- postal_code string
The postal code or ZIP code of the Vendor.
- country string
The country of the Vendor.
- website string
The website of the Vendor.
- notes string
Additional notes about the Vendor.
- fuel boolean
Indicates whether the Vendor provides fuel.
- service boolean
Indicates whether the Vendor provides service.
- parts boolean
Indicates whether the Vendor provides parts.
- vehicle boolean
Indicates whether the Vendor provides vehicles.
- contact_name string
The name of the contact person for the Vendor.
- contact_email string
The email address of the contact person for the Vendor.
- contact_phone string
The phone number of the contact person for the Vendor.
- latitude float
The latitude of the Vendor's location.
- longitude float
The longitude of the Vendor's location.
- external_id string
The external identifier of the Vendor.
- archived_at string
The date and time when the Vendor was archived, if applicable.
labels object[]
id integerPossible values:
>= 1
name string- custom_fields object
*Full details on working with Custom Fields here.
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"name": "string",
"phone": "string",
"street_address": "string",
"street_address_line_2": "string",
"city": "string",
"region": "string",
"postal_code": "string",
"country": "string",
"website": "string",
"notes": "string",
"fuel": true,
"service": true,
"parts": true,
"vehicle": true,
"contact_name": "string",
"contact_email": "string",
"contact_phone": "string",
"latitude": 0,
"longitude": 0,
"external_id": "string",
"archived_at": "string",
"labels": [
{
"id": 0,
"name": "string"
}
],
"custom_fields": {}
}
Request could not be authenticated
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Insufficient permission to perform this operation
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
The requested resource could not be located
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Unprocessable Entity
- application/json
- Schema
- Example (from schema)
- Example
Schema
errors object
typeitems string
{
"errors": {}
}
{
"errors": {
"field1": [
"error1",
"error2"
],
"field2": [
"error3"
]
}
}
Something unexpected happened
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}