Skip to main content
POST
/
bridge
/
api
/
v1
/
workspaces
/
{workspaceId}
/
contacts
/
partial
Create or update a contact
curl --request POST \
  --url https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/contacts/partial \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "cellphone": "<string>",
  "firstName": "Maria",
  "lastName": "Lopez",
  "email": "maria@acme.com",
  "languageCode": "EN",
  "ownerIdentifier": {
    "identifier": "jane@acme.com",
    "identifierType": "EMAIL"
  },
  "customAttributes": {
    "openAttributes": [
      {
        "customAttributeId": "<string>",
        "content": "<string>"
      }
    ],
    "closedAttributes": [
      {
        "customAttributeId": "<string>",
        "closedCustomAttributeIds": [
          "<string>"
        ]
      }
    ]
  }
}
'
{
  "id": "<string>",
  "workspaceId": "<string>",
  "type": "PARTIAL",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "cellphone": "+14084029292",
  "customAttributes": [
    {
      "key": "<string>",
      "values": [
        "<string>"
      ]
    }
  ],
  "languageCode": "EN",
  "ownerId": "37673840-6259-40f9-bbe5-a7db40f8e3cf"
}

Documentation Index

Fetch the complete documentation index at: https://docs.bridge.new/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Copy the API key as provided by the Bridge Console.

Path Parameters

​
workspaceId
string<uuid>
required

Unique identifier of the workspace (UUID v4).

Example:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

Body

application/json

Request body for partial contact creation. Only cellphone is required.

​
cellphone
string<phone>
required

Contact's cellphone number in E.164 format. Used to identify the contact for upsert.

Example:

"+14084029292"

​
firstName
string | null

Contact's first name. Required for NORMAL classification.

Example:

"Maria"

​
lastName
string | null

Contact's last name. Required for NORMAL classification.

Example:

"Lopez"

​
email
string<email> | null

Contact's email address.

Example:

"maria@acme.com"

​
languageCode
enum<string> | null

Contact's language code. Required for NORMAL classification.

Available options:
ES,
EN
Example:

"EN"

​
ownerIdentifier
InternalUserIdentifierRequest · object

Body to identify an internal user in Bridge System.

Example:
{
  "identifier": "jane@acme.com",
  "identifierType": "EMAIL"
}
​
customAttributes
Custom Attributes · object

Object with open and closed custom attributes.

Example:
{
  "closedAttributes": [],
  "openAttributes": []
}

Response

Successful Response

Response body for contact-related operations.

​
id
string
required

Unique identifier for the contact (UUID v4).

Example:

"b6cf1c4a-2b1e-4e63-8f3e-0f9d1a2a1234"

​
workspaceId
string
required

Unique identifier of the workspace this contact belongs to

Example:

"92b2d4f3-81e1-4b61-a7ec-6f4ff3b58be5"

​
type
enum<string>
required

NORMAL when all required identity and custom attribute fields are present, PARTIAL otherwise.

Available options:
PARTIAL,
NORMAL
Examples:

"NORMAL"

"PARTIAL"

​
createdAt
string
required

Timestamp when the contact was created.

Example:

"2003-04-10T08:00:00.000Z"

​
updatedAt
string
required

Timestamp when the contact was last updated.

Example:

"2003-04-10T08:00:00.000Z"

​
firstName
string | null

Contact's first name.

Example:

"John"

​
lastName
string | null

Contact's last name.

Example:

"Doe"

​
email
string<email> | null

Contact's email address.

Example:

"john.doe@example.com"

​
cellphone
string<phone> | null

Contact's cellphone address.

Example:

"+14084029292"

​
customAttributes
CustomAttributeResponse · object[]

Array of custom key-value attributes.

​
languageCode
enum<string> | null

Language code from external user.

Available options:
ES,
EN
Example:

"EN"

​
ownerId
string | null

Email address of the salesperson or user who owns this contact.

Example:

"37673840-6259-40f9-bbe5-a7db40f8e3cf"