Skip to main content
POST
/
v4
/
core
/
companies
/
{companyId}
/
contacts
Create a contact
curl --request POST \
  --url https://api.integrations.commenda.io/v4/core/companies/{companyId}/contacts \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '
{
  "data": {
    "platform_id": "string",
    "name": "string",
    "contact_name": "string",
    "email": "string",
    "phone": "string",
    "tax_number": "string",
    "type": "CUSTOMER",
    "status": "ACTIVE",
    "currency_id": "AED",
    "registration_number": "string",
    "website": "string",
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "addresses": [
      {
        "platform_id": "string",
        "parent_id": "string",
        "parent_type": "ACCOUNT",
        "type": "SHIPPING",
        "street": "string",
        "street2": "string",
        "locality": "string",
        "city": "string",
        "state": "string",
        "postal_code": "string",
        "country": "string"
      }
    ],
    "phone_numbers": [
      {
        "platform_id": "string",
        "parent_id": "string",
        "parent_type": "ACCOUNT",
        "number": "string",
        "type": "MOBILE"
      }
    ],
    "external_links": [
      {
        "platform_id": "string",
        "parent_id": "string",
        "parent_type": "ACCOUNT",
        "link": "string",
        "type": "WEBSITE"
      }
    ]
  }
}
'
import requests

url = "https://api.integrations.commenda.io/v4/core/companies/{companyId}/contacts"

payload = { "data": {
        "platform_id": "string",
        "name": "string",
        "contact_name": "string",
        "email": "string",
        "phone": "string",
        "tax_number": "string",
        "type": "CUSTOMER",
        "status": "ACTIVE",
        "currency_id": "AED",
        "registration_number": "string",
        "website": "string",
        "created_at": "2024-01-01T00:00:00Z",
        "updated_at": "2024-01-01T00:00:00Z",
        "addresses": [
            {
                "platform_id": "string",
                "parent_id": "string",
                "parent_type": "ACCOUNT",
                "type": "SHIPPING",
                "street": "string",
                "street2": "string",
                "locality": "string",
                "city": "string",
                "state": "string",
                "postal_code": "string",
                "country": "string"
            }
        ],
        "phone_numbers": [
            {
                "platform_id": "string",
                "parent_id": "string",
                "parent_type": "ACCOUNT",
                "number": "string",
                "type": "MOBILE"
            }
        ],
        "external_links": [
            {
                "platform_id": "string",
                "parent_id": "string",
                "parent_type": "ACCOUNT",
                "link": "string",
                "type": "WEBSITE"
            }
        ]
    } }
headers = {
    "api_key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {api_key: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    data: {
      platform_id: 'string',
      name: 'string',
      contact_name: 'string',
      email: 'string',
      phone: 'string',
      tax_number: 'string',
      type: 'CUSTOMER',
      status: 'ACTIVE',
      currency_id: 'AED',
      registration_number: 'string',
      website: 'string',
      created_at: '2024-01-01T00:00:00Z',
      updated_at: '2024-01-01T00:00:00Z',
      addresses: [
        {
          platform_id: 'string',
          parent_id: 'string',
          parent_type: 'ACCOUNT',
          type: 'SHIPPING',
          street: 'string',
          street2: 'string',
          locality: 'string',
          city: 'string',
          state: 'string',
          postal_code: 'string',
          country: 'string'
        }
      ],
      phone_numbers: [
        {
          platform_id: 'string',
          parent_id: 'string',
          parent_type: 'ACCOUNT',
          number: 'string',
          type: 'MOBILE'
        }
      ],
      external_links: [
        {
          platform_id: 'string',
          parent_id: 'string',
          parent_type: 'ACCOUNT',
          link: 'string',
          type: 'WEBSITE'
        }
      ]
    }
  })
};

fetch('https://api.integrations.commenda.io/v4/core/companies/{companyId}/contacts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.integrations.commenda.io/v4/core/companies/{companyId}/contacts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        'platform_id' => 'string',
        'name' => 'string',
        'contact_name' => 'string',
        'email' => 'string',
        'phone' => 'string',
        'tax_number' => 'string',
        'type' => 'CUSTOMER',
        'status' => 'ACTIVE',
        'currency_id' => 'AED',
        'registration_number' => 'string',
        'website' => 'string',
        'created_at' => '2024-01-01T00:00:00Z',
        'updated_at' => '2024-01-01T00:00:00Z',
        'addresses' => [
                [
                                'platform_id' => 'string',
                                'parent_id' => 'string',
                                'parent_type' => 'ACCOUNT',
                                'type' => 'SHIPPING',
                                'street' => 'string',
                                'street2' => 'string',
                                'locality' => 'string',
                                'city' => 'string',
                                'state' => 'string',
                                'postal_code' => 'string',
                                'country' => 'string'
                ]
        ],
        'phone_numbers' => [
                [
                                'platform_id' => 'string',
                                'parent_id' => 'string',
                                'parent_type' => 'ACCOUNT',
                                'number' => 'string',
                                'type' => 'MOBILE'
                ]
        ],
        'external_links' => [
                [
                                'platform_id' => 'string',
                                'parent_id' => 'string',
                                'parent_type' => 'ACCOUNT',
                                'link' => 'string',
                                'type' => 'WEBSITE'
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api_key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.integrations.commenda.io/v4/core/companies/{companyId}/contacts"

	payload := strings.NewReader("{\n  \"data\": {\n    \"platform_id\": \"string\",\n    \"name\": \"string\",\n    \"contact_name\": \"string\",\n    \"email\": \"string\",\n    \"phone\": \"string\",\n    \"tax_number\": \"string\",\n    \"type\": \"CUSTOMER\",\n    \"status\": \"ACTIVE\",\n    \"currency_id\": \"AED\",\n    \"registration_number\": \"string\",\n    \"website\": \"string\",\n    \"created_at\": \"2024-01-01T00:00:00Z\",\n    \"updated_at\": \"2024-01-01T00:00:00Z\",\n    \"addresses\": [\n      {\n        \"platform_id\": \"string\",\n        \"parent_id\": \"string\",\n        \"parent_type\": \"ACCOUNT\",\n        \"type\": \"SHIPPING\",\n        \"street\": \"string\",\n        \"street2\": \"string\",\n        \"locality\": \"string\",\n        \"city\": \"string\",\n        \"state\": \"string\",\n        \"postal_code\": \"string\",\n        \"country\": \"string\"\n      }\n    ],\n    \"phone_numbers\": [\n      {\n        \"platform_id\": \"string\",\n        \"parent_id\": \"string\",\n        \"parent_type\": \"ACCOUNT\",\n        \"number\": \"string\",\n        \"type\": \"MOBILE\"\n      }\n    ],\n    \"external_links\": [\n      {\n        \"platform_id\": \"string\",\n        \"parent_id\": \"string\",\n        \"parent_type\": \"ACCOUNT\",\n        \"link\": \"string\",\n        \"type\": \"WEBSITE\"\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api_key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.integrations.commenda.io/v4/core/companies/{companyId}/contacts")
  .header("api_key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"platform_id\": \"string\",\n    \"name\": \"string\",\n    \"contact_name\": \"string\",\n    \"email\": \"string\",\n    \"phone\": \"string\",\n    \"tax_number\": \"string\",\n    \"type\": \"CUSTOMER\",\n    \"status\": \"ACTIVE\",\n    \"currency_id\": \"AED\",\n    \"registration_number\": \"string\",\n    \"website\": \"string\",\n    \"created_at\": \"2024-01-01T00:00:00Z\",\n    \"updated_at\": \"2024-01-01T00:00:00Z\",\n    \"addresses\": [\n      {\n        \"platform_id\": \"string\",\n        \"parent_id\": \"string\",\n        \"parent_type\": \"ACCOUNT\",\n        \"type\": \"SHIPPING\",\n        \"street\": \"string\",\n        \"street2\": \"string\",\n        \"locality\": \"string\",\n        \"city\": \"string\",\n        \"state\": \"string\",\n        \"postal_code\": \"string\",\n        \"country\": \"string\"\n      }\n    ],\n    \"phone_numbers\": [\n      {\n        \"platform_id\": \"string\",\n        \"parent_id\": \"string\",\n        \"parent_type\": \"ACCOUNT\",\n        \"number\": \"string\",\n        \"type\": \"MOBILE\"\n      }\n    ],\n    \"external_links\": [\n      {\n        \"platform_id\": \"string\",\n        \"parent_id\": \"string\",\n        \"parent_type\": \"ACCOUNT\",\n        \"link\": \"string\",\n        \"type\": \"WEBSITE\"\n      }\n    ]\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.integrations.commenda.io/v4/core/companies/{companyId}/contacts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"platform_id\": \"string\",\n    \"name\": \"string\",\n    \"contact_name\": \"string\",\n    \"email\": \"string\",\n    \"phone\": \"string\",\n    \"tax_number\": \"string\",\n    \"type\": \"CUSTOMER\",\n    \"status\": \"ACTIVE\",\n    \"currency_id\": \"AED\",\n    \"registration_number\": \"string\",\n    \"website\": \"string\",\n    \"created_at\": \"2024-01-01T00:00:00Z\",\n    \"updated_at\": \"2024-01-01T00:00:00Z\",\n    \"addresses\": [\n      {\n        \"platform_id\": \"string\",\n        \"parent_id\": \"string\",\n        \"parent_type\": \"ACCOUNT\",\n        \"type\": \"SHIPPING\",\n        \"street\": \"string\",\n        \"street2\": \"string\",\n        \"locality\": \"string\",\n        \"city\": \"string\",\n        \"state\": \"string\",\n        \"postal_code\": \"string\",\n        \"country\": \"string\"\n      }\n    ],\n    \"phone_numbers\": [\n      {\n        \"platform_id\": \"string\",\n        \"parent_id\": \"string\",\n        \"parent_type\": \"ACCOUNT\",\n        \"number\": \"string\",\n        \"type\": \"MOBILE\"\n      }\n    ],\n    \"external_links\": [\n      {\n        \"platform_id\": \"string\",\n        \"parent_id\": \"string\",\n        \"parent_type\": \"ACCOUNT\",\n        \"link\": \"string\",\n        \"type\": \"WEBSITE\"\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "sync_id": "<string>",
    "data": {
      "rootfi_id": 123,
      "rootfi_created_at": "2023-11-07T05:31:56Z",
      "rootfi_updated_at": "2023-11-07T05:31:56Z",
      "platform_id": "<string>",
      "name": "<string>",
      "contact_name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "tax_number": "<string>",
      "registration_number": "<string>",
      "website": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "addresses": [
        {
          "rootfi_id": 123,
          "rootfi_created_at": "2023-11-07T05:31:56Z",
          "rootfi_updated_at": "2023-11-07T05:31:56Z",
          "platform_id": "<string>",
          "parent_id": "<string>",
          "street": "<string>",
          "street2": "<string>",
          "locality": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postal_code": "<string>",
          "country": "<string>"
        }
      ],
      "phone_numbers": [
        {
          "rootfi_id": 123,
          "rootfi_created_at": "2023-11-07T05:31:56Z",
          "rootfi_updated_at": "2023-11-07T05:31:56Z",
          "platform_id": "<string>",
          "parent_id": "<string>",
          "number": "<string>"
        }
      ],
      "external_links": [
        {
          "rootfi_id": 123,
          "rootfi_created_at": "2023-11-07T05:31:56Z",
          "rootfi_updated_at": "2023-11-07T05:31:56Z",
          "platform_id": "<string>",
          "parent_id": "<string>",
          "link": "<string>"
        }
      ]
    }
  },
  "request_id": "<string>"
}

Authorizations

​
api_key
string
header
required

Your Commenda Integrations API key, sent in the api_key header.

Path Parameters

​
companyId
integer
required

Commenda company id.

Query Parameters

​
run_async
boolean

Process the write asynchronously. Required when data is an array (batch write).

Body

application/json
​
data
object
required

Response

201 - application/json

The created contacts record (sync) or a sync id (async).

​
data
object
required
​
request_id
string
required