Create person — Brigg developers

Access & visibility

Allow customers.CreatePerson 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.

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.

privatebooleanOptional

Defaults to false: the record is shared with the workspace. True assigns private ownership to the approved acting member and requires member delegation. This is independent of created_by provenance.

Choose ownership deliberately

Omitting private, or setting it to false, creates a workspace-shared record. Set private: true to create a record owned by the approved acting member. Private records require member delegation; a workspace-only credential cannot own a personal record. The credential’s exact resource grants authorize the write; private ownership and project membership remain enforced.

A create is a new record, not an upsert. Reuse the same idempotency key only for retries of that logical creation. For recurring synchronization, use the resource’s upsert operation when available: it matches a permanent external reference. Otherwise keep the returned record ID and use the corresponding update operation for subsequent changes.

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.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "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"
    },
    "private": {
      "type": "boolean",
      "description": "Defaults to false: the record is shared with the workspace. True assigns private ownership to the approved acting member and requires member delegation. This is independent of created_by provenance."
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "data": {
        "display_name": "Alex Morgan",
        "email": "alex@example.com",
        "title": "Operations manager",
        "company_ref": "e_company_example"
      }
    }
  ]
}

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": "Operations manager",
          "company_ref": "e_company_example"
        }
      }
    }
  ]
}

Try the request

Use your API key in a server environment.

Act 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.CreatePerson' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "data": {
    "display_name": "Alex Morgan",
    "email": "alex@example.com",
    "title": "Operations manager",
    "company_ref": "e_company_example"
  }
}'

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.CreatePerson", {
  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({
    "data": {
      "display_name": "Alex Morgan",
      "email": "alex@example.com",
      "title": "Operations manager",
      "company_ref": "e_company_example"
    }
  }),
});
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 = {
  "data": {
    "display_name": "Alex Morgan",
    "email": "alex@example.com",
    "title": "Operations manager",
    "company_ref": "e_company_example"
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.CreatePerson",
    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.CreatePerson' \
  -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 '{
  "data": {
    "display_name": "Alex Morgan",
    "email": "alex@example.com",
    "title": "Operations manager",
    "company_ref": "e_company_example"
  }
}'

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.CreatePerson", {
  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({
    "data": {
      "display_name": "Alex Morgan",
      "email": "alex@example.com",
      "title": "Operations manager",
      "company_ref": "e_company_example"
    }
  }),
});
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 = {
  "data": {
    "display_name": "Alex Morgan",
    "email": "alex@example.com",
    "title": "Operations manager",
    "company_ref": "e_company_example"
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.CreatePerson",
    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": "Operations manager",
      "company_ref": "e_company_example"
    }
  }
}

Illustrative values, not a live response.