Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Vendors

Create new vendor

post/vendors

Query parameters

skipWebhookboolean

Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Headers

x-organization-idinteger

Required if using a multi organizations token

Request body

namestring required
descriptionstring nullable
extraFieldsobject

Custom Fields on the entity. The object keys are the exact Custom Field labels, including spaces or special characters. (ie: "Qualifications")

emailsstring[]

List of email address

phoneNumbersstring[]

List of phone number

Example request

{
  "name": "Acme Corp",
  "description": "Provider of Acme service",
  "extraFields": {
    "Qualifications": "ISO 000"
  },
  "emails": [
    "vendor@example.com"
  ],
  "phoneNumbers": [
    "415-555-0100"
  ]
}

Response

Successfully created vendor

idinteger required

Global ID of the vendor

Example response

{
  "id": 963
}