Skip to main content
POST
/
unified
/
crm
/
contacts
Create Contact
curl --request POST \
  --url https://api.stackone.com/unified/crm/contacts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '
{
  "first_name": "Steve",
  "last_name": "Wozniak",
  "company_name": "Apple Inc.",
  "emails": [
    "steve@apple.com"
  ],
  "phone_numbers": [
    "123-456-7890"
  ],
  "deal_ids": [
    "deal-001",
    "deal-002"
  ],
  "account_ids": [
    "account-123",
    "account-456"
  ],
  "custom_fields": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "Training Completion Status",
      "value": "Completed",
      "value_id": "value_456",
      "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
    }
  ],
  "passthrough": {
    "other_known_names": "John Doe"
  }
}
'
import requests

url = "https://api.stackone.com/unified/crm/contacts"

payload = {
    "first_name": "Steve",
    "last_name": "Wozniak",
    "company_name": "Apple Inc.",
    "emails": ["steve@apple.com"],
    "phone_numbers": ["123-456-7890"],
    "deal_ids": ["deal-001", "deal-002"],
    "account_ids": ["account-123", "account-456"],
    "custom_fields": [
        {
            "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            "name": "Training Completion Status",
            "value": "Completed",
            "value_id": "value_456",
            "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
        }
    ],
    "passthrough": { "other_known_names": "John Doe" }
}
headers = {
    "x-account-id": "<x-account-id>",
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {
    'x-account-id': '<x-account-id>',
    Authorization: 'Basic <encoded-value>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    first_name: 'Steve',
    last_name: 'Wozniak',
    company_name: 'Apple Inc.',
    emails: ['steve@apple.com'],
    phone_numbers: ['123-456-7890'],
    deal_ids: ['deal-001', 'deal-002'],
    account_ids: ['account-123', 'account-456'],
    custom_fields: [
      {
        id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
        remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
        name: 'Training Completion Status',
        value: 'Completed',
        value_id: 'value_456',
        remote_value_id: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48'
      }
    ],
    passthrough: {other_known_names: 'John Doe'}
  })
};

fetch('https://api.stackone.com/unified/crm/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.stackone.com/unified/crm/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([
    'first_name' => 'Steve',
    'last_name' => 'Wozniak',
    'company_name' => 'Apple Inc.',
    'emails' => [
        'steve@apple.com'
    ],
    'phone_numbers' => [
        '123-456-7890'
    ],
    'deal_ids' => [
        'deal-001',
        'deal-002'
    ],
    'account_ids' => [
        'account-123',
        'account-456'
    ],
    'custom_fields' => [
        [
                'id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
                'remote_id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
                'name' => 'Training Completion Status',
                'value' => 'Completed',
                'value_id' => 'value_456',
                'remote_value_id' => 'e3cb75bf-aa84-466e-a6c1-b8322b257a48'
        ]
    ],
    'passthrough' => [
        'other_known_names' => 'John Doe'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json",
    "x-account-id: <x-account-id>"
  ],
]);

$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.stackone.com/unified/crm/contacts"

	payload := strings.NewReader("{\n  \"first_name\": \"Steve\",\n  \"last_name\": \"Wozniak\",\n  \"company_name\": \"Apple Inc.\",\n  \"emails\": [\n    \"steve@apple.com\"\n  ],\n  \"phone_numbers\": [\n    \"123-456-7890\"\n  ],\n  \"deal_ids\": [\n    \"deal-001\",\n    \"deal-002\"\n  ],\n  \"account_ids\": [\n    \"account-123\",\n    \"account-456\"\n  ],\n  \"custom_fields\": [\n    {\n      \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n      \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n      \"name\": \"Training Completion Status\",\n      \"value\": \"Completed\",\n      \"value_id\": \"value_456\",\n      \"remote_value_id\": \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\"\n    }\n  ],\n  \"passthrough\": {\n    \"other_known_names\": \"John Doe\"\n  }\n}")

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

	req.Header.Add("x-account-id", "<x-account-id>")
	req.Header.Add("Authorization", "Basic <encoded-value>")
	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.stackone.com/unified/crm/contacts")
  .header("x-account-id", "<x-account-id>")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"first_name\": \"Steve\",\n  \"last_name\": \"Wozniak\",\n  \"company_name\": \"Apple Inc.\",\n  \"emails\": [\n    \"steve@apple.com\"\n  ],\n  \"phone_numbers\": [\n    \"123-456-7890\"\n  ],\n  \"deal_ids\": [\n    \"deal-001\",\n    \"deal-002\"\n  ],\n  \"account_ids\": [\n    \"account-123\",\n    \"account-456\"\n  ],\n  \"custom_fields\": [\n    {\n      \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n      \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n      \"name\": \"Training Completion Status\",\n      \"value\": \"Completed\",\n      \"value_id\": \"value_456\",\n      \"remote_value_id\": \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\"\n    }\n  ],\n  \"passthrough\": {\n    \"other_known_names\": \"John Doe\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.stackone.com/unified/crm/contacts")

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

request = Net::HTTP::Post.new(url)
request["x-account-id"] = '<x-account-id>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"first_name\": \"Steve\",\n  \"last_name\": \"Wozniak\",\n  \"company_name\": \"Apple Inc.\",\n  \"emails\": [\n    \"steve@apple.com\"\n  ],\n  \"phone_numbers\": [\n    \"123-456-7890\"\n  ],\n  \"deal_ids\": [\n    \"deal-001\",\n    \"deal-002\"\n  ],\n  \"account_ids\": [\n    \"account-123\",\n    \"account-456\"\n  ],\n  \"custom_fields\": [\n    {\n      \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n      \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n      \"name\": \"Training Completion Status\",\n      \"value\": \"Completed\",\n      \"value_id\": \"value_456\",\n      \"remote_value_id\": \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\"\n    }\n  ],\n  \"passthrough\": {\n    \"other_known_names\": \"John Doe\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "first_name": "Steve",
    "last_name": "Wozniak",
    "company_name": "Apple Inc.",
    "emails": [
      "steve@apple.com"
    ],
    "phone_numbers": [
      "123-456-7890"
    ],
    "deal_ids": [
      "deal-001",
      "deal-002"
    ],
    "remote_deal_ids": [
      "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "e3cb75bf-aa84-466e-a6c1-b8322b257a49"
    ],
    "account_ids": [
      "account-123",
      "account-456"
    ],
    "remote_account_ids": [
      "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "e3cb75bf-aa84-466e-a6c1-b8322b257a49"
    ],
    "custom_fields": [
      {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "name": "Training Completion Status",
        "value": "Completed",
        "value_id": "value_456",
        "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
      }
    ],
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}
{
  "statusCode": 400,
  "message": "Bad Request",
  "timestamp": "2023-05-30T00:00:00.000Z",
  "data": {
    "statusCode": 400,
    "message": "Bad Request",
    "headers": {
      "content-type": "application/json",
      "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
    }
  },
  "provider_errors": [
    {
      "status": 400,
      "url": "https://api.provider.com/v1/resource",
      "raw": {
        "message": "Invalid input parameters"
      },
      "headers": {
        "content-type": "application/json",
        "x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
      }
    }
  ]
}
{
  "statusCode": 401,
  "message": "Unauthorized",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 403,
  "message": "Forbidden resource",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 404,
  "message": "Not Found",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 408,
  "message": "Request timed out",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 409,
  "message": "Conflict",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 412,
  "message": "Precondition failed",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 422,
  "message": "Unprocessable Entity",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 429,
  "message": "Too many requests",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 500,
  "message": "Internal server error",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 501,
  "message": "Not Implemented",
  "timestamp": "2023-05-30T00:00:00.000Z"
}
{
  "statusCode": 502,
  "message": "Bad Gateway",
  "timestamp": "2023-05-30T00:00:00.000Z"
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

​
x-account-id
string
required

The account identifier

​
Prefer
string

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Example:

"heartbeat"

Body

application/json
​
first_name
string | null

The contact first name

Example:

"Steve"

​
last_name
string | null

The contact last name

Example:

"Wozniak"

​
company_name
string | null

The contact company name

Example:

"Apple Inc."

​
emails
string[] | null

List of contact email addresses

Example:
["steve@apple.com"]
​
phone_numbers
string[] | null

List of contact phone numbers

Example:
["123-456-7890"]
​
deal_ids
string[] | null

List of associated deal IDs

Example:
["deal-001", "deal-002"]
​
account_ids
string[] | null

List of associated account IDs

Example:
["account-123", "account-456"]
​
custom_fields
object[] | null

Contact custom fields

​
passthrough
object | null

Value to pass through to the provider

Example:
{ "other_known_names": "John Doe" }

Response

The contact was successfully created.

​
data
object
required
​
raw
object[] | null