Update person — Brigg developers

Access & visibility

Allow customers.UpdatePerson on your API key. Resource read permissions: core:Person. Resource write permissions: core:Person.

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:Person record. Find it with customers.ListPeople. Use the record's top-level id, not a business field or account ID.

dataPersonOptional

The fields to set.

Person

Contact details6 fields

display_namestringOptional

Full name shown for the contact.

emailstringOptional

Email address.

emailsarray of stringOptional

Additional email addresses.

phonestringOptional

Phone number including its country calling code.

titlestringOptional

The contact's job title.

linkedin_urlstringOptional

URL of the contact's LinkedIn profile.

Context and relationships4 fields

descriptionstringOptional

Notes describing this contact's role or relationship to your business.

company_refstringOptional

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

tagsarray of stringOptional

Stable tag keys, not labels. Use List tag vocabularies to find the vocabulary for this resource type and field, then List tags for its key/label pairs.

bioobjectOptional

A short professional profile with a summary and key facts.

Nested fields

summarystringOptional

Short summary of the source information.

highlightsarray of stringOptional

Key points extracted from the source information.

unsetarray of stringOptional

Keys of data to remove.

Each item: "display_name", "email", "emails", "phone", "title", "description", "linkedin_url", "company_ref", "tags", "bio".

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

display_namestring or objectOptional

Commit only if the previous display_name 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.

emailstring or objectOptional

Commit only if the previous email 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.

emailsarray of string or objectOptional

Commit only if the previous emails 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.

phonestring or objectOptional

Commit only if the previous phone 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.

titlestring or objectOptional

Commit only if the previous title 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.

descriptionstring or objectOptional

Commit only if the previous description 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.

linkedin_urlstring or objectOptional

Commit only if the previous linkedin_url 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.

company_refstring or objectOptional

Commit only if the previous company_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.

tagsarray of string or objectOptional

Commit only if the previous tags 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.

bioobject (2 variants)Optional

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

Nested fields

Variant 1

summarystringOptional

Short summary of the source information.

highlightsarray of stringOptional

Key points extracted from the source information.

$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 Person record is a customer/contact identity, not an account ID for member delegation. System-managed member contacts cannot be edited as ordinary customer records.

Creating a Person does not upsert by email or guarantee email uniqueness. Before creating from an external system, search List people and retain the returned record ID for subsequent updates. A name or a shared mailbox is not a unique person's identity.

itemPersonRecordRequired

The requested record, including its metadata and data fields.

PersonRecord

idstringRequired

Stable core:Person 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.

dataPersonRequired

The record's fields.

Person

Contact details6 fields

display_namestringRequired

Full name shown for the contact.

emailstringOptional

Email address.

emailsarray of stringOptional

Additional email addresses.

phonestringOptional

Phone number including its country calling code.

titlestringOptional

The contact's job title.

linkedin_urlstringOptional

URL of the contact's LinkedIn profile.

Context and relationships4 fields

descriptionstringOptional

Notes describing this contact's role or relationship to your business.

company_refstringOptional

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

tagsarray of stringOptional

Stable tag keys, not labels. Use List tag vocabularies to find the vocabulary for this resource type and field, then List tags for its key/label pairs.

bioobjectOptional

A short professional profile with a summary and key facts.

Nested fields

summarystringOptional

Short summary of the source information.

highlightsarray of stringOptional

Key points extracted from the source information.

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:Person` record. Find it with [customers.ListPeople](/developers/reference/customers/ListPeople). Use the record's top-level `id`, not a business field or account ID."
    },
    "data": {
      "type": "object",
      "properties": {
        "display_name": {
          "type": "string",
          "description": "Full name shown for the contact."
        },
        "email": {
          "type": "string",
          "description": "Email address."
        },
        "emails": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Additional email addresses."
        },
        "phone": {
          "type": "string",
          "description": "Phone number including its country calling code."
        },
        "title": {
          "type": "string",
          "description": "The contact's job title."
        },
        "description": {
          "type": "string",
          "description": "Notes describing this contact's role or relationship to your business."
        },
        "linkedin_url": {
          "type": "string",
          "description": "URL of the contact's LinkedIn profile."
        },
        "company_ref": {
          "type": "string",
          "description": "ID of a `core:Company` record. Find it with [customers.ListCompanies](/developers/reference/customers/ListCompanies) and use the top-level `id`. This is not an account ID or a display name."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Stable tag keys, not labels. Use [List tag vocabularies](/developers/reference/customers/ListTagVocabularies) to find the vocabulary for this resource type and field, then [List tags](/developers/reference/customers/ListTags) for its key/label pairs."
        },
        "bio": {
          "type": "object",
          "properties": {
            "summary": {
              "type": "string",
              "description": "Short summary of the source information."
            },
            "highlights": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Key points extracted from the source information."
            }
          },
          "additionalProperties": false,
          "description": "A short professional profile with a summary and key facts."
        }
      },
      "required": [],
      "additionalProperties": false,
      "description": "The fields to set.",
      "title": "Person"
    },
    "unset": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "display_name",
          "email",
          "emails",
          "phone",
          "title",
          "description",
          "linkedin_url",
          "company_ref",
          "tags",
          "bio"
        ]
      },
      "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": {
        "display_name": {
          "description": "Commit only if the previous display_name value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Full name shown for the contact."
            },
            {
              "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
            }
          ]
        },
        "email": {
          "description": "Commit only if the previous email value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Email 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
            }
          ]
        },
        "emails": {
          "description": "Commit only if the previous emails value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Additional email addresses."
            },
            {
              "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
            }
          ]
        },
        "phone": {
          "description": "Commit only if the previous phone value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Phone number including its country calling code."
            },
            {
              "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
            }
          ]
        },
        "title": {
          "description": "Commit only if the previous title value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "The contact's job title."
            },
            {
              "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
            }
          ]
        },
        "description": {
          "description": "Commit only if the previous description value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Notes describing this contact's role or relationship to your business."
            },
            {
              "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
            }
          ]
        },
        "linkedin_url": {
          "description": "Commit only if the previous linkedin_url value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "URL of the contact's LinkedIn profile."
            },
            {
              "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
            }
          ]
        },
        "company_ref": {
          "description": "Commit only if the previous company_ref value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "ID of a `core:Company` record. Find it with [customers.ListCompanies](/developers/reference/customers/ListCompanies) 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
            }
          ]
        },
        "tags": {
          "description": "Commit only if the previous tags value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Stable tag keys, not labels. Use [List tag vocabularies](/developers/reference/customers/ListTagVocabularies) to find the vocabulary for this resource type and field, then [List tags](/developers/reference/customers/ListTags) for its key/label pairs."
            },
            {
              "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
            }
          ]
        },
        "bio": {
          "description": "Commit only if the previous bio value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "summary": {
                  "type": "string",
                  "description": "Short summary of the source information."
                },
                "highlights": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "description": "Key points extracted from the source information."
                }
              },
              "additionalProperties": false,
              "description": "A short professional profile with a summary and key facts."
            },
            {
              "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_person_example",
      "data": {
        "title": "Head of operations"
      }
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "item": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Stable core:Person 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": {
            "display_name": {
              "type": "string",
              "description": "Full name shown for the contact."
            },
            "email": {
              "type": "string",
              "description": "Email address."
            },
            "emails": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Additional email addresses."
            },
            "phone": {
              "type": "string",
              "description": "Phone number including its country calling code."
            },
            "title": {
              "type": "string",
              "description": "The contact's job title."
            },
            "description": {
              "type": "string",
              "description": "Notes describing this contact's role or relationship to your business."
            },
            "linkedin_url": {
              "type": "string",
              "description": "URL of the contact's LinkedIn profile."
            },
            "company_ref": {
              "type": "string",
              "description": "ID of a `core:Company` record. Find it with [customers.ListCompanies](/developers/reference/customers/ListCompanies) and use the top-level `id`. This is not an account ID or a display name."
            },
            "tags": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Stable tag keys, not labels. Use [List tag vocabularies](/developers/reference/customers/ListTagVocabularies) to find the vocabulary for this resource type and field, then [List tags](/developers/reference/customers/ListTags) for its key/label pairs."
            },
            "bio": {
              "type": "object",
              "properties": {
                "summary": {
                  "type": "string",
                  "description": "Short summary of the source information."
                },
                "highlights": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "description": "Key points extracted from the source information."
                }
              },
              "additionalProperties": false,
              "description": "A short professional profile with a summary and key facts."
            }
          },
          "required": [
            "display_name"
          ],
          "additionalProperties": false,
          "description": "The record's fields.",
          "title": "Person"
        }
      },
      "required": [
        "id",
        "created_at",
        "updated_at",
        "created_by",
        "private",
        "data"
      ],
      "additionalProperties": false,
      "description": "The requested record, including its metadata and data fields.",
      "title": "PersonRecord"
    }
  },
  "required": [
    "item"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "item": {
        "id": "e_person_example",
        "created_at": 1794301200000,
        "updated_at": 1794301200000,
        "created_by": "a_example",
        "private": false,
        "data": {
          "display_name": "Alex Morgan",
          "email": "alex@example.com",
          "title": "Head of operations",
          "company_ref": "e_company_example"
        }
      }
    }
  ]
}

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/customers.UpdatePerson' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "id": "e_person_example",
  "data": {
    "title": "Head of operations"
  }
}'

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/customers.UpdatePerson", {
  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_person_example",
    "data": {
      "title": "Head of operations"
    }
  }),
});
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_person_example",
  "data": {
    "title": "Head of operations"
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.UpdatePerson",
    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/customers.UpdatePerson' \
  -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_person_example",
  "data": {
    "title": "Head of operations"
  }
}'

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/customers.UpdatePerson", {
  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_person_example",
    "data": {
      "title": "Head of operations"
    }
  }),
});
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_person_example",
  "data": {
    "title": "Head of operations"
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.UpdatePerson",
    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_person_example",
    "created_at": 1794301200000,
    "updated_at": 1794301200000,
    "created_by": "a_example",
    "private": false,
    "data": {
      "display_name": "Alex Morgan",
      "email": "alex@example.com",
      "title": "Head of operations",
      "company_ref": "e_company_example"
    }
  }
}

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/customers.UpdatePerson' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "id": "e_person_example",
  "data": {
    "title": "Head of operations"
  },
  "expected": {
    "display_name": "Alex Morgan"
  }
}'

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/customers.UpdatePerson", {
  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_person_example",
    "data": {
      "title": "Head of operations"
    },
    "expected": {
      "display_name": "Alex Morgan"
    }
  }),
});
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_person_example",
  "data": {
    "title": "Head of operations"
  },
  "expected": {
    "display_name": "Alex Morgan"
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.UpdatePerson",
    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/customers.UpdatePerson' \
  -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_person_example",
  "data": {
    "title": "Head of operations"
  },
  "expected": {
    "display_name": "Alex Morgan"
  }
}'

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/customers.UpdatePerson", {
  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_person_example",
    "data": {
      "title": "Head of operations"
    },
    "expected": {
      "display_name": "Alex Morgan"
    }
  }),
});
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_person_example",
  "data": {
    "title": "Head of operations"
  },
  "expected": {
    "display_name": "Alex Morgan"
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.UpdatePerson",
    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_person_example",
    "created_at": 1794301200000,
    "updated_at": 1794301200000,
    "created_by": "a_example",
    "private": false,
    "data": {
      "display_name": "Alex Morgan",
      "email": "alex@example.com",
      "title": "Head of operations",
      "company_ref": "e_company_example"
    }
  }
}

Illustrative values, not a live response.