Updates a vendor

put

https://api.hcssapps.com/heavyjob/api/v1/vendors/{id}

This call updates an existing vendor by its id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

The id of the existing vendor

Body Params

The vendor details to be updated

A POCO that represents a vendor to be created or updated by the API.

name

string

required

length ≥ 1

The name of the vendor.

description

string | null

The description of the vendor.

address1

string | null

The street address (e.g., 123 Main St).

address2

string | null

The secondary address info (suite, apartment, PO box numbers etc.).

city

string | null

The city.

state

string | null

The state abbreviation.

zip

string | null

The zip code.

country

string | null

The country.

phoneNumber

string | null

The phone number. Can include numbers, symbols and whitespace.

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

400

Bad Request. See https://developer.hcssapps.com/getting-started/troubleshoot-bad-request for more information.

401

Unauthorized. See https://developer.hcssapps.com/getting-started/troubleshoot-unauthorized for more information.

403

Forbidden. See https://developer.hcssapps.com/getting-started/troubleshoot-forbidden for more information.

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK