vendors

Create Vendor

Create a new vendor.

Required fields:

  • name: Vendor name
  • vendorType: One of CONSULTANT, FINANCING, LOGISTICS, MANUFACTURER, SUBCONTRACTOR, SUPPLIER

Optional fields:

  • address: Array containing a single string for the full vendor location/address
  • website: Vendor website URL (max 2048 chars)
  • description: Vendor description
  • isActive: Whether the vendor is active (default: true)
  • contacts: Array of contact IDs to associate
  • projectIds: Array of project IDs to link this vendor to
  • custom: Custom fields object
post/vendors

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/vendors
  • Auth: API key in header x-api-key

Query parameters

allow_new_optionsboolean

Whether to allow creation of new dropdown options during record creation

Request body

namestring required

Vendor name

vendorType'CONSULTANT' | 'FINANCING' | 'LOGISTICS' | 'MANUFACTURER' | 'SUBCONTRACTOR' | 'SUPPLIER' required

The type of vendor

addressstring[]

An array containing a single string, which represents the full vendor location/address.

websitestring nullable

Vendor website URL

descriptionstring nullable

Vendor description

isActiveboolean

Whether the vendor is active

contactsinteger[] nullable

Contact IDs to associate with this vendor

projectIdsinteger[] nullable

Project IDs to link this vendor to

customobject

Custom fields

Response

Matching vendor found (upsert)

idinteger

Unique identifier

createdAtstring date-time

Creation timestamp

updatedAtstring date-time

Last update timestamp

namestring

Vendor name

descriptionstring nullable

Vendor description

addressstring[]

Vendor location/address

isActiveboolean

Whether the vendor is active

primaryEmailstring email nullable

Primary contact email

primaryPhonestring nullable

Primary contact phone

numberinteger

Vendor number (e.g., 1234)

vendorType'CONSULTANT' | 'FINANCING' | 'LOGISTICS' | 'MANUFACTURER' | 'SUBCONTRACTOR' | 'SUPPLIER'

The type of vendor

websitestring nullable

Vendor website URL

projectIdsinteger[]

IDs of projects this vendor is linked to

customobject

Custom fields

Changes

No recorded changes to this operation across all 1 revision of this API.