Skip to main content
PATCH
/
bridge
/
api
/
v1
/
workspaces
/
{workspaceId}
/
contacts
/
{contactId}
Update contact
curl --request PATCH \
  --url https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/contacts/{contactId} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "languageCode": "EN",
  "cellphone": "+14084029292",
  "ownerIdentifier": {
    "identifier": "<string>"
  },
  "customAttributes": {
    "openAttributes": [
      {
        "customAttributeId": "<string>",
        "content": "<string>"
      }
    ],
    "closedAttributes": [
      {
        "customAttributeId": "<string>",
        "closedCustomAttributeIds": [
          "<string>"
        ]
      }
    ]
  }
}
'
import requests

url = "https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/contacts/{contactId}"

payload = {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "languageCode": "EN",
    "cellphone": "+14084029292",
    "ownerIdentifier": { "identifier": "<string>" },
    "customAttributes": {
        "openAttributes": [
            {
                "customAttributeId": "<string>",
                "content": "<string>"
            }
        ],
        "closedAttributes": [
            {
                "customAttributeId": "<string>",
                "closedCustomAttributeIds": ["<string>"]
            }
        ]
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    firstName: 'John',
    lastName: 'Doe',
    email: 'john.doe@example.com',
    languageCode: 'EN',
    cellphone: '+14084029292',
    ownerIdentifier: {identifier: '<string>'},
    customAttributes: {
      openAttributes: [{customAttributeId: '<string>', content: '<string>'}],
      closedAttributes: [{customAttributeId: '<string>', closedCustomAttributeIds: ['<string>']}]
    }
  })
};

fetch('https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/contacts/{contactId}', 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-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/contacts/{contactId}",
  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([
    'firstName' => 'John',
    'lastName' => 'Doe',
    'email' => 'john.doe@example.com',
    'languageCode' => 'EN',
    'cellphone' => '+14084029292',
    'ownerIdentifier' => [
        'identifier' => '<string>'
    ],
    'customAttributes' => [
        'openAttributes' => [
                [
                                'customAttributeId' => '<string>',
                                'content' => '<string>'
                ]
        ],
        'closedAttributes' => [
                [
                                'customAttributeId' => '<string>',
                                'closedCustomAttributeIds' => [
                                                                '<string>'
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/contacts/{contactId}"

	payload := strings.NewReader("{\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"email\": \"john.doe@example.com\",\n  \"languageCode\": \"EN\",\n  \"cellphone\": \"+14084029292\",\n  \"ownerIdentifier\": {\n    \"identifier\": \"<string>\"\n  },\n  \"customAttributes\": {\n    \"openAttributes\": [\n      {\n        \"customAttributeId\": \"<string>\",\n        \"content\": \"<string>\"\n      }\n    ],\n    \"closedAttributes\": [\n      {\n        \"customAttributeId\": \"<string>\",\n        \"closedCustomAttributeIds\": [\n          \"<string>\"\n        ]\n      }\n    ]\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	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-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/contacts/{contactId}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"email\": \"john.doe@example.com\",\n  \"languageCode\": \"EN\",\n  \"cellphone\": \"+14084029292\",\n  \"ownerIdentifier\": {\n    \"identifier\": \"<string>\"\n  },\n  \"customAttributes\": {\n    \"openAttributes\": [\n      {\n        \"customAttributeId\": \"<string>\",\n        \"content\": \"<string>\"\n      }\n    ],\n    \"closedAttributes\": [\n      {\n        \"customAttributeId\": \"<string>\",\n        \"closedCustomAttributeIds\": [\n          \"<string>\"\n        ]\n      }\n    ]\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api-connect-us.bridge.new/bridge/api/v1/workspaces/{workspaceId}/contacts/{contactId}")

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

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"firstName\": \"John\",\n  \"lastName\": \"Doe\",\n  \"email\": \"john.doe@example.com\",\n  \"languageCode\": \"EN\",\n  \"cellphone\": \"+14084029292\",\n  \"ownerIdentifier\": {\n    \"identifier\": \"<string>\"\n  },\n  \"customAttributes\": {\n    \"openAttributes\": [\n      {\n        \"customAttributeId\": \"<string>\",\n        \"content\": \"<string>\"\n      }\n    ],\n    \"closedAttributes\": [\n      {\n        \"customAttributeId\": \"<string>\",\n        \"closedCustomAttributeIds\": [\n          \"<string>\"\n        ]\n      }\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "workspaceId": "<string>",
  "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"
}

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"

​
contactId
string<uuid>
required

Unique identifier of the contact (UUID v4).

Example:

"4e362e2b-67b2-4a7e-a9df-e9ecf9141be8"

Body

application/json

Request body for updating an existing contact.

​
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"

​
languageCode
enum<string> | null

Contact's language code.

Available options:
ES,
EN
Example:

"EN"

​
cellphone
string<phone> | null

Contact's cellphone number in E.164 format.

Example:

"+14084029292"

​
ownerIdentifier
InternalUserIdentifierRequest · object | null

Body to identify an internal user in Bridge System.

​
customAttributes
Custom Attributes · object

Array of custom key-value attributes.

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"