Creates a new office, scoped by the company/business unit of the current user

post

https://api.hcssapps.com/contacts/api/v1/offices

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The office

vendorId

uuid

required

The vendor's unique id.

address

object

phoneNumber

string | null

The vendor location's phonenumber.

faxNumber

string | null

The vendor location's faxnumber.

webAddress

string | null

The vendor location's website address.

regionId

uuid | null

The unique identifier of the region the vendor location operates in.

nickname

string | null

The nickname for a vendor location.

isQualified

boolean | null

A flag if a vendor location is qualified.

isBlacklisted

boolean | null

A flag if a vendor location is blacklisted.

communicationMethod

string

enum

Allowed:

Headers

BusinessUnitId

string

The business unit's guid

content-type

string

enum

Defaults to application/json-patch+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

201Created