Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Vendors

Create new contact

post/vendors/{id}/contacts

Path parameters

idinteger required

ID of the vendor

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

Request body

namestring required
rolestring nullable

Role/Label of the contact.

emailstring nullable

Email address of contact.

phoneNumberstring nullable

Phone number of contact

extensionstring nullable

Phone number extension

Example request

{
  "role": "Team Lead",
  "email": "john@doe.com",
  "phoneNumber": "1234567890",
  "extension": "4682"
}

Response

Successfully created contact

idnumber required

Global ID of the contact

namestring required
rolestring nullable required

Role/Label of the contact.

emailstring nullable required

Email address of contact.

phoneNumberstring nullable required

Phone number of contact

extensionstring nullable required

Phone number extension

vendorIdnumber required

ID of vendor that contact will be associated to

Example response

{
  "id": 135,
  "role": "Team Lead",
  "email": "john@doe.com",
  "phoneNumber": "1234567890",
  "extension": "4682",
  "vendorId": 432
}