Update contact channel — Brigg developers

Access & visibility

Allow support.UpdateContactChannel on your API key. Resource read permissions: core:ContactChannel. Resource write permissions: core:ContactChannel.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

idstringRequired

ID of a visible core:ContactChannel record. Use the relevant list operation to discover records. Use the record's top-level id, not a business field or account ID.

dataContactChannelOptional

The fields to set.

ContactChannel

Contact identity3 fields

kindstringOptional

Channel identity type: email, phone, web_cookie, sms or other.

Allowed: "email", "phone", "web_cookie", "sms", "other".

addressstringOptional

Channel address: a normalized email address, international phone number or channel-specific identifier. This is not a postal address.

person_refstringOptional

ID of a core:Person record. Find it with customers.ListPeople and use the top-level id. This is not an account ID or a display name.

unsetarray of stringOptional

Keys of data to remove.

Each item: "kind", "address", "person_ref", "verified_at".

expectedobjectOptional

Prior business-field values that must still match before the write. Use fields from this record’s data object, without the data. prefix. Use {"$absent":true} as a value to require an absent field. A mismatch returns 409 conflict. See the conditional example for this resource.

Nested fields

kindstring or objectOptional

Commit only if the previous kind value matches; use $absent to require that this field is missing.

Nested fields

$absent = true

$absenttrueRequired

Require the field to be missing, rather than present with a null value.

Always true.

addressstring or objectOptional

Commit only if the previous address value matches; use $absent to require that this field is missing.

Nested fields

$absent = true

$absenttrueRequired

Require the field to be missing, rather than present with a null value.

Always true.

person_refstring or objectOptional

Commit only if the previous person_ref value matches; use $absent to require that this field is missing.

Nested fields

$absent = true

$absenttrueRequired

Require the field to be missing, rather than present with a null value.

Always true.

verified_atnumber or objectOptional

Commit only if the previous verified_at value matches; use $absent to require that this field is missing.

Nested fields

$absent = true

$absenttrueRequired

Require the field to be missing, rather than present with a null value.

Always true.

Update without losing changes

Send only the business fields you want to change in data; omitted fields stay unchanged. Use unset to remove an optional field. Setting a field to null is a different action and is allowed only when its schema permits null.

Use expected for a conditional update: supply the values you last read for the fields whose concurrent changes would matter. {"$absent": true} expects a missing field. A conflict means you must read the record again and decide how to reconcile the change. Keep the same idempotency key when retrying the original action; use a new key for a revised action.

Response

Returns 200 OK with a JSON body.

Record metadata sits outside data. Timestamps created_at and updated_at are Unix milliseconds. Optional business fields may be absent; absence does not mean false or zero. A field accepts null only when its type includes null.

A contact channel links a communication identity to a Person record; it does not create an inbox or send a message. Use a Person record ID, not a workspace account ID. Supply an email address or international phone number in the channel's canonical form.

Creating or linking a channel is not proof that the person controls that address. verified_at is maintained by the verification workflow and is not writable through these record operations.

itemContactChannelRecordRequired

The requested record, including its metadata and data fields.

ContactChannelRecord

idstringRequired

Stable core:ContactChannel record ID. Keep this top-level value when reading or referring to this record. Available actions are linked under Next steps; an ID does not imply the resource can be edited.

created_atnumberRequired

Time the record was created, in Unix milliseconds.

updated_atnumberRequired

Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads.

created_bystring or nullRequired

Account that originally created the record, or null for a workspace/system-originated record. This is provenance, not its current owner or a Person record ID.

privatebooleanRequired

True for a member-owned private record. An API key needs approved delegation to that owner; false alone does not bypass resource grants or other access rules.

dataContactChannelRequired

The record's fields.

ContactChannel

Contact identity3 fields

kindstringRequired

Channel identity type: email, phone, web_cookie, sms or other.

Allowed: "email", "phone", "web_cookie", "sms", "other".

addressstringRequired

Channel address: a normalized email address, international phone number or channel-specific identifier. This is not a postal address.

person_refstringRequired

ID of a core:Person record. Find it with customers.ListPeople and use the top-level id. This is not an account ID or a display name.

Verification1 fields

verified_atnumberOptional

Time control of this channel address was verified, in Unix milliseconds. May be absent when verification has not been recorded.

Errors & retries

Set BRIGG_REQUEST_ID once for each logical action. The samples send it as Idempotency-Key. Reuse the same value and body on retries, including after a timeout; a missing response does not prove the action failed.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

HTTP status	Code	What to do
400	`invalid_json`	Send a JSON object with Content-Type: application/json.
400	`invalid_input`	Check the request fields and types. Supply a stable Idempotency-Key containing 1–200 characters.
401	`invalid_key`	The workspace API key is missing, invalid or revoked.
403	`forbidden`	Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member.
404	`not_found`	The requested operation or resource is not available to this credential.
429	`rate_limited`	Wait for Retry-After before retrying. Reuse the original Idempotency-Key.
409	`conflict`	A supplied expected value no longer matches. Read the record again before deciding whether to retry.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of a visible `core:ContactChannel` record. Use the relevant list operation to discover records. Use the record's top-level `id`, not a business field or account ID."
    },
    "data": {
      "type": "object",
      "properties": {
        "kind": {
          "type": "string",
          "enum": [
            "email",
            "phone",
            "web_cookie",
            "sms",
            "other"
          ],
          "description": "Channel identity type: email, phone, web_cookie, sms or other."
        },
        "address": {
          "type": "string",
          "description": "Channel address: a normalized email address, international phone number or channel-specific identifier. This is not a postal address."
        },
        "person_ref": {
          "type": "string",
          "description": "ID of a `core:Person` record. Find it with [customers.ListPeople](/reference/customers/ListPeople) and use the top-level `id`. This is not an account ID or a display name."
        }
      },
      "required": [],
      "additionalProperties": false,
      "description": "The fields to set.",
      "title": "ContactChannel"
    },
    "unset": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "kind",
          "address",
          "person_ref",
          "verified_at"
        ]
      },
      "description": "Keys of `data` to remove."
    },
    "expected": {
      "type": "object",
      "description": "Prior business-field values that must still match before the write. Use fields from this record’s data object, without the data. prefix. Use {\"$absent\":true} as a value to require an absent field. A mismatch returns 409 conflict. See the conditional example for this resource.",
      "additionalProperties": false,
      "properties": {
        "kind": {
          "description": "Commit only if the previous kind value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "email",
                "phone",
                "web_cookie",
                "sms",
                "other"
              ],
              "description": "Channel identity type: email, phone, web_cookie, sms or other."
            },
            {
              "type": "object",
              "properties": {
                "$absent": {
                  "type": "boolean",
                  "const": true,
                  "description": "Require the field to be missing, rather than present with a null value."
                }
              },
              "required": [
                "$absent"
              ],
              "additionalProperties": false
            }
          ]
        },
        "address": {
          "description": "Commit only if the previous address value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Channel address: a normalized email address, international phone number or channel-specific identifier. This is not a postal address."
            },
            {
              "type": "object",
              "properties": {
                "$absent": {
                  "type": "boolean",
                  "const": true,
                  "description": "Require the field to be missing, rather than present with a null value."
                }
              },
              "required": [
                "$absent"
              ],
              "additionalProperties": false
            }
          ]
        },
        "person_ref": {
          "description": "Commit only if the previous person_ref value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "ID of a `core:Person` record. Find it with [customers.ListPeople](/reference/customers/ListPeople) and use the top-level `id`. This is not an account ID or a display name."
            },
            {
              "type": "object",
              "properties": {
                "$absent": {
                  "type": "boolean",
                  "const": true,
                  "description": "Require the field to be missing, rather than present with a null value."
                }
              },
              "required": [
                "$absent"
              ],
              "additionalProperties": false
            }
          ]
        },
        "verified_at": {
          "description": "Commit only if the previous verified_at value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "number",
              "description": "Time control of this channel address was verified, in Unix milliseconds. May be absent when verification has not been recorded."
            },
            {
              "type": "object",
              "properties": {
                "$absent": {
                  "type": "boolean",
                  "const": true,
                  "description": "Require the field to be missing, rather than present with a null value."
                }
              },
              "required": [
                "$absent"
              ],
              "additionalProperties": false
            }
          ]
        }
      }
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "id": "e_contactchannel_example",
      "data": {
        "person_ref": "e_person_alex"
      }
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "item": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Stable core:ContactChannel record ID. Keep this top-level value when reading or referring to this record. Available actions are linked under Next steps; an ID does not imply the resource can be edited."
        },
        "created_at": {
          "type": "number",
          "description": "Time the record was created, in Unix milliseconds."
        },
        "updated_at": {
          "type": "number",
          "description": "Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads."
        },
        "created_by": {
          "type": [
            "string",
            "null"
          ],
          "description": "Account that originally created the record, or null for a workspace/system-originated record. This is provenance, not its current owner or a Person record ID."
        },
        "private": {
          "type": "boolean",
          "description": "True for a member-owned private record. An API key needs approved delegation to that owner; false alone does not bypass resource grants or other access rules."
        },
        "data": {
          "type": "object",
          "properties": {
            "kind": {
              "type": "string",
              "enum": [
                "email",
                "phone",
                "web_cookie",
                "sms",
                "other"
              ],
              "description": "Channel identity type: email, phone, web_cookie, sms or other."
            },
            "address": {
              "type": "string",
              "description": "Channel address: a normalized email address, international phone number or channel-specific identifier. This is not a postal address."
            },
            "person_ref": {
              "type": "string",
              "description": "ID of a `core:Person` record. Find it with [customers.ListPeople](/reference/customers/ListPeople) and use the top-level `id`. This is not an account ID or a display name."
            },
            "verified_at": {
              "type": "number",
              "description": "Time control of this channel address was verified, in Unix milliseconds. May be absent when verification has not been recorded."
            }
          },
          "required": [
            "kind",
            "address",
            "person_ref"
          ],
          "additionalProperties": false,
          "description": "The record's fields.",
          "title": "ContactChannel"
        }
      },
      "required": [
        "id",
        "created_at",
        "updated_at",
        "created_by",
        "private",
        "data"
      ],
      "additionalProperties": false,
      "description": "The requested record, including its metadata and data fields.",
      "title": "ContactChannelRecord"
    }
  },
  "required": [
    "item"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "item": {
        "id": "e_contactchannel_example",
        "created_at": 1791276900000,
        "updated_at": 1791280800000,
        "created_by": "a_jamie",
        "private": false,
        "data": {
          "kind": "email",
          "address": "alex@example.org",
          "person_ref": "e_person_alex"
        }
      }
    }
  ]
}

Try the request

Use your API key in a server environment.

Example scenarioAct as a memberRequires administrator-approved delegation.

Fictional values. Replace IDs and business details with values from your workspace.

Request

cURL

curl 'https://api.brigg.app/v1/operations/support.UpdateContactChannel' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "id": "e_contactchannel_example",
  "data": {
    "person_ref": "e_person_alex"
  }
}'

TypeScript

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/support.UpdateContactChannel", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "id": "e_contactchannel_example",
    "data": {
      "person_ref": "e_person_alex"
    }
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "id": "e_contactchannel_example",
  "data": {
    "person_ref": "e_person_alex"
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/support.UpdateContactChannel",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/support.UpdateContactChannel' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "id": "e_contactchannel_example",
  "data": {
    "person_ref": "e_person_alex"
  }
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/support.UpdateContactChannel", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "id": "e_contactchannel_example",
    "data": {
      "person_ref": "e_person_alex"
    }
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "id": "e_contactchannel_example",
  "data": {
    "person_ref": "e_person_alex"
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/support.UpdateContactChannel",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "item": {
    "id": "e_contactchannel_example",
    "created_at": 1791276900000,
    "updated_at": 1791280800000,
    "created_by": "a_jamie",
    "private": false,
    "data": {
      "kind": "email",
      "address": "alex@example.org",
      "person_ref": "e_person_alex"
    }
  }
}

Illustrative values, not a live response.

Use a value you actually read. A concurrent change refuses the write with 409 conflict.

Request

cURL

curl 'https://api.brigg.app/v1/operations/support.UpdateContactChannel' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "id": "e_contactchannel_example",
  "data": {
    "person_ref": "e_person_alex"
  },
  "expected": {
    "kind": "email"
  }
}'

TypeScript

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/support.UpdateContactChannel", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "id": "e_contactchannel_example",
    "data": {
      "person_ref": "e_person_alex"
    },
    "expected": {
      "kind": "email"
    }
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "id": "e_contactchannel_example",
  "data": {
    "person_ref": "e_person_alex"
  },
  "expected": {
    "kind": "email"
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/support.UpdateContactChannel",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/support.UpdateContactChannel' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "id": "e_contactchannel_example",
  "data": {
    "person_ref": "e_person_alex"
  },
  "expected": {
    "kind": "email"
  }
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/support.UpdateContactChannel", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "id": "e_contactchannel_example",
    "data": {
      "person_ref": "e_person_alex"
    },
    "expected": {
      "kind": "email"
    }
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "id": "e_contactchannel_example",
  "data": {
    "person_ref": "e_person_alex"
  },
  "expected": {
    "kind": "email"
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/support.UpdateContactChannel",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "item": {
    "id": "e_contactchannel_example",
    "created_at": 1791276900000,
    "updated_at": 1791280800000,
    "created_by": "a_jamie",
    "private": false,
    "data": {
      "kind": "email",
      "address": "alex@example.org",
      "person_ref": "e_person_alex"
    }
  }
}

Illustrative values, not a live response.