vendors

Create a vendor contact

Create a new vendor contact for a vendor in your organisation.

The vendor must be monitored. If your account keeps vendors without monitoring them, the vendor can also be one that you keep without monitoring.

Required API key permissions: VendorRisk + ReadWrite (select when creating API key in Account Settings)

post/vendor/contact/add

Request

Base URL
https://cyber-risk.upguard.com/api/public
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/docs/vendor/contact/add/post.ts
A function with typed inputs. Its response is checked against the schema.

email_addressstring

The email address of the contact.

namestring required

The full name of the contact.

notesstring

Notes associated with the contact.

phone_mobilestring

The mobile phone number of the contact.

titlestring

The job title of the contact.

vendor_idinteger required

The ID of the vendor this contact belongs to.

{
  "email_address": "user@example.com",
  "name": "Jane Doe"
}

Returns the ID of the created vendor contact.

idinteger

The ID of the created contact.

{
  "id": 123
}