Create Contact | Coperniq API

const url = 'https://api.coperniq.io/v1/contacts';
const options = {
  method: 'POST',
  headers: {'x-api-key': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"name":"string"}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "name": "string",
  "id": 1,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "phones": [
    "string"
  ],
  "emails": [
    "string"
  ],
  "title": "string",
  "description": "string",
  "createdByUser": {
    "id": 1
  },
  "accounts": [
    {
      "id": 1,
      "title": "string"
    }
  ],
  "projects": [
    {
      "id": 1,
      "title": "string"
    }
  ],
  "opportunities": [
    {
      "id": 1,
      "title": "string"
    }
  ],
  "vendors": [
    {
      "id": 1,
      "title": "string"
    }
  ]
}

Create a new contact.

Required fields:

name: Contact’s full name

Optional fields:

phones: Array of contact phone numbers
emails: Array of contact email addresses
title: Contact title
accountIds: Array of account IDs to associate
projectIds: Array of project IDs to associate

Create a new contact. Required fields: - `name`: Contact's full name Optional fields: - `phones`: Array of contact phone numbers - `emails`: Array of contact email addresses - `title`: Contact title - `accountIds`: Array of account IDs to associate - `projectIds`: Array of project IDs to associate

Authentication

x-api-keystring

API Key authentication via header

Request

This endpoint expects an object.

namestringRequired

Contact's full name

phoneslist of stringsOptional

List of contact phone numbers

emailslist of stringsOptional

List of contact email addresses

titlestringOptional

Contact title

accountIdslist of integersOptional

Account IDs to associate with the contact

projectIdslist of integersOptional

Project IDs to associate with the contact

Response

Contact created successfully

namestring

Contact's full name

idintegerOptional

Unique identifier

createdAtstringOptionalformat: "date-time"

Creation timestamp

updatedAtstringOptionalformat: "date-time"

Last update timestamp

phoneslist of stringsOptional

List of contact phone numbers

emailslist of stringsOptional

List of contact email addresses

titlestring or nullOptional

Contact title

descriptionstring or nullOptional

Contact description

createdByUserobjectOptional

accountslist of objectsOptional

List of linked accounts

projectslist of objectsOptional

List of linked projects

opportunitieslist of objectsOptional

List of linked opportunities

vendorslist of objectsOptional

List of linked vendors

Errors

400

Bad Request Error

401

Unauthorized Error