Skip to main content
PATCH
/
v1
/
contacts
/
{id}
/
custom-attributes
Patch custom attributes for a contact
curl --request PATCH \
  --url https://api.conduit.ai/v1/contacts/{id}/custom-attributes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attributes": [
    {
      "id": "attr_123",
      "value": "vip"
    },
    {
      "id": "attr_456",
      "value": null
    }
  ]
}
'
import requests

url = "https://api.conduit.ai/v1/contacts/{id}/custom-attributes"

payload = { "attributes": [
{
"id": "attr_123",
"value": "vip"
},
{
"id": "attr_456",
"value": None
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({attributes: [{id: 'attr_123', value: 'vip'}, {id: 'attr_456', value: null}]})
};

fetch('https://api.conduit.ai/v1/contacts/{id}/custom-attributes', 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.conduit.ai/v1/contacts/{id}/custom-attributes",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'attributes' => [
[
'id' => 'attr_123',
'value' => 'vip'
],
[
'id' => 'attr_456',
'value' => null
]
]
]),
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.conduit.ai/v1/contacts/{id}/custom-attributes"

payload := strings.NewReader("{\n \"attributes\": [\n {\n \"id\": \"attr_123\",\n \"value\": \"vip\"\n },\n {\n \"id\": \"attr_456\",\n \"value\": null\n }\n ]\n}")

req, _ := http.NewRequest("PATCH", 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.patch("https://api.conduit.ai/v1/contacts/{id}/custom-attributes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"attributes\": [\n {\n \"id\": \"attr_123\",\n \"value\": \"vip\"\n },\n {\n \"id\": \"attr_456\",\n \"value\": null\n }\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.conduit.ai/v1/contacts/{id}/custom-attributes")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"attributes\": [\n {\n \"id\": \"attr_123\",\n \"value\": \"vip\"\n },\n {\n \"id\": \"attr_456\",\n \"value\": null\n }\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "id": "attr_123",
      "workspace_id": "j57demo8f8x7c9v0n2q4r6t8y1u3i5o",
      "name": "VIP Status",
      "type": "Select",
      "options": [
        {
          "value": "standard",
          "color": "gray"
        },
        {
          "value": "vip",
          "color": "green"
        }
      ],
      "order": 1,
      "section_id": "section_123",
      "section_name": "Contact Info",
      "value": "vip"
    },
    {
      "id": "attr_456",
      "workspace_id": "j57demo8f8x7c9v0n2q4r6t8y1u3i5o",
      "name": "Move-in Date",
      "type": "Date",
      "options": null,
      "order": 2,
      "section_id": "section_123",
      "section_name": "Contact Info",
      "value": null
    }
  ]
}
{
"error": "Invalid workspace id"
}
{
"error": "Invalid workspace id"
}
{
"error": "Invalid workspace id"
}
{
"error": "Invalid workspace id"
}
{
"error": "Invalid workspace id"
}

Authorizations

Authorization
string
header
required

Conduit API token. Use Authorization: Bearer <token>. Read/write endpoints require a token with write access.

Path Parameters

id
string
required

Contact id.

Example:

"ph77c0dy0mgdpzmqz6tesry8w184002s"

Query Parameters

workspace_id
string

Optional workspace override. If omitted, Conduit resolves the contact's workspace automatically.

Example:

"j57demo8f8x7c9v0n2q4r6t8y1u3i5o"

Body

application/json

Request body for upserting custom attribute values on a contact. Date attributes accept YYYY-MM-DD strings.

attributes
object[]
required
Minimum array length: 1

Response

Updated contact custom attributes

Custom attributes for a contact.

data
object[]
required