Link a Contact to a Deal

Add Contact To Deal

curl --request POST \
  --url https://api.example.com/deals/{deal_id}/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_id": "<string>",
  "role": "<string>",
  "is_champion": false
}
'

import requests

url = "https://api.example.com/deals/{deal_id}/contacts"

payload = {
    "contact_id": "<string>",
    "role": "<string>",
    "is_champion": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({contact_id: '<string>', role: '<string>', is_champion: false})
};

fetch('https://api.example.com/deals/{deal_id}/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.example.com/deals/{deal_id}/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([
    'contact_id' => '<string>',
    'role' => '<string>',
    'is_champion' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.example.com/deals/{deal_id}/contacts"

	payload := strings.NewReader("{\n  \"contact_id\": \"<string>\",\n  \"role\": \"<string>\",\n  \"is_champion\": false\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.example.com/deals/{deal_id}/contacts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contact_id\": \"<string>\",\n  \"role\": \"<string>\",\n  \"is_champion\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/deals/{deal_id}/contacts")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"contact_id\": \"<string>\",\n  \"role\": \"<string>\",\n  \"is_champion\": false\n}"

response = http.request(request)
puts response.read_body

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

POST

deals

{deal_id}

contacts

Add Contact To Deal

curl --request POST \
  --url https://api.example.com/deals/{deal_id}/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_id": "<string>",
  "role": "<string>",
  "is_champion": false
}
'

import requests

url = "https://api.example.com/deals/{deal_id}/contacts"

payload = {
    "contact_id": "<string>",
    "role": "<string>",
    "is_champion": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({contact_id: '<string>', role: '<string>', is_champion: false})
};

fetch('https://api.example.com/deals/{deal_id}/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.example.com/deals/{deal_id}/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([
    'contact_id' => '<string>',
    'role' => '<string>',
    'is_champion' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.example.com/deals/{deal_id}/contacts"

	payload := strings.NewReader("{\n  \"contact_id\": \"<string>\",\n  \"role\": \"<string>\",\n  \"is_champion\": false\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.example.com/deals/{deal_id}/contacts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contact_id\": \"<string>\",\n  \"role\": \"<string>\",\n  \"is_champion\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/deals/{deal_id}/contacts")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"contact_id\": \"<string>\",\n  \"role\": \"<string>\",\n  \"is_champion\": false\n}"

response = http.request(request)
puts response.read_body

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Auth

Requires a CRM manage scope and an active organization on the token. Any *:manage scope qualifies — in practice contacts:manage, deals:manage, companies:manage, or activities:manage.

Response

201 with the created deal_contacts row: {deal_id, contact_id, role, is_champion, id, org_id, created_at, added_at}.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

deal_id

string

required

The deal's id.

Body

application/json

contact_id

string

required

Contact id to link to the deal.

role

string | null

Contact's role on this deal (e.g. decision maker, champion).

is_champion

boolean

default:false

Mark this contact as the deal's champion.

Response

Successful Response

Contacts

Deals

Accounts

Activities

Tags

Files

Folders

Notifications

Reports

PATs

Integrations

AI

Analytics Assistant

Feedback

Customer Intelligence

Outreach

AnyCard

AnyCard Events

AnyCard Share Links

Public Media

Account Readiness

Service Health

Link a Contact to a Deal

Auth

Response

Authorizations

Path Parameters

Body

Response

​Auth

​Response

Authorizations

Path Parameters

Body

Response

Auth

Response