Create Vendor | Coperniq API

Create a new vendor.

Required fields:

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

Optional fields:

website: Vendor website URL (max 2048 chars)
description: Vendor description
imageUrl: Vendor image URL
ownerId: Owner user ID
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

Create a new vendor. Required fields: - `title`: Vendor name - `vendorType`: One of `CONSULTANT`, `FINANCING`, `LOGISTICS`, `MANUFACTURER`, `SUBCONTRACTOR`, `SUPPLIER` Optional fields: - `website`: Vendor website URL (max 2048 chars) - `description`: Vendor description - `imageUrl`: Vendor image URL - `ownerId`: Owner user ID - `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

Authentication

x-api-keystring

API Key authentication via header

Query parameters

allow_new_optionsbooleanOptionalDefaults to false

Whether to allow creation of new dropdown options during record creation

Request

This endpoint expects an object.

titlestringRequired1-500 characters

Vendor name

vendorTypeenumRequired

The type of vendor

websitestring or nullOptional<=2048 characters

Vendor website URL

descriptionstring or nullOptional

Vendor description

imageUrlstring or nullOptional

Vendor image URL

ownerIdinteger or nullOptional

Owner user ID

isActivebooleanOptionalDefaults to true

Whether the vendor is active

contactslist of integers or nullOptional

Contact IDs to associate with this vendor

projectIdslist of integers or nullOptional

Project IDs to link this vendor to

custommap from strings to anyOptional

Custom fields

Response

Matching vendor found (upsert)

idinteger

Unique identifier

createdAtstringformat: "date-time"

Creation timestamp

updatedAtstringformat: "date-time"

Last update timestamp

titlestring

Record title/name

descriptionstring or null

Record description

addresslist of strings

Record location/address

isActiveboolean

Whether the record is active

primaryEmailstring or nullformat: "email"

Primary contact email

primaryPhonestring or null

Primary contact phone

numberinteger

Record number (e.g., 1234)

custommap from strings to any

Custom fields

vendorTypeenum or null

The type of vendor

websitestring or null

Vendor website URL

projectIdslist of integers

IDs of projects this vendor is linked to

Errors

400

Bad Request Error

401

Unauthorized Error

1	const url = 'https://api.coperniq.io/v1/vendors';
2	const options = {
3	method: 'POST',
4	headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
5	body: '{"title":"GreenTech Consulting","vendorType":"CONSULTANT"}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

1	{
2	"id": 1024,
3	"createdAt": "2024-01-15T09:30:00Z",
4	"updatedAt": "2024-01-15T09:30:00Z",
5	"title": "GreenTech Consulting",
6	"description": "Specialized consulting services in sustainable energy solutions.",
7	"address": [
8	"1234 Elm Street, Springfield, IL 62704"
9	],
10	"isActive": true,
11	"primaryEmail": "contact@greentechconsulting.com",
12	"primaryPhone": "+1-217-555-0198",
13	"number": 4578,
14	"custom": {},
15	"vendorType": "CONSULTANT",
16	"website": "https://www.greentechconsulting.com",
17	"projectIds": [
18	501
19	]
20	}