Skip to main content
POST
/
v1
/
workspaces
/
{workspaceId}
/
contacts
curl --request POST \
  --url https://api.bridge.new/v1/workspaces/{workspaceId}/contacts \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "cellphone": "+1-555-123-4567",
  "ownerId": "salesman1@your-company.com",
  "customAttributes": [
    {
      "key": "company",
      "value": "Acme Corp"
    },
    {
      "key": "role",
      "value": "Manager"
    }
  ]
}'
{
  "id": "contact_abc123",
  "workspaceId": "ws_abc123",
  "firstName": "John",
  "lastName": "Doe",
  "email": "john.doe@example.com",
  "cellphone": "+1-555-123-4567",
  "customAttributes": [
    {
      "key": "company",
      "value": "Acme Corp"
    }
  ],
  "ownerId": "salesperson@your-company.com",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Authorizations

​
X-API-Key
string
header
required

API Key authentication for machine-to-machine communication.

Authentication Process:

  1. Generate an access key and secret key pair from your Bridge dashboard
  2. Include the access key in the X-API-Key header
  3. Sign your requests using the secret key (HMAC-SHA256)
  4. Include the signature in the X-API-Signature header

Request Signing:

  • Create a string to sign: {HTTP_METHOD}\n{REQUEST_PATH}\n{REQUEST_BODY}\n{TIMESTAMP}
  • Generate HMAC-SHA256 signature using your secret key
  • Include timestamp in X-API-Timestamp header (Unix timestamp)
  • Include signature in X-API-Signature header

Example Headers:

X-API-Key: ak_1234567890abcdef
X-API-Timestamp: 1642234567
X-API-Signature: a1b2c3d4e5f6...

Path Parameters

​
workspaceId
string
required

Unique identifier of the workspace

Example:

"ws_abc123"

Body

application/json
​
firstName
string
required

Contact's first name

Example:

"John"

​
lastName
string
required

Contact's last name

Example:

"Doe"

​
cellphone
string
required

Contact's cellphone number (required)

Example:

"+1-555-123-4567"

​
email
string<email>

Contact's email address (optional)

Example:

"john.doe@example.com"

​
ownerId
string<email>

Email address of the salesperson or user who owns this contact

Example:

"salesperson@your-company.com"

​
customAttributes
object[]

Array of custom key-value attributes

Response

Contact created successfully

​
id
string
required

Unique identifier for the contact

Example:

"contact_abc123"

​
workspaceId
string
required

Unique identifier of the workspace this contact belongs to

Example:

"ws_abc123"

​
firstName
string
required

Contact's first name

Example:

"John"

​
lastName
string
required

Contact's last name

Example:

"Doe"

​
createdAt
string<date-time>
required

Timestamp when the contact was created

Example:

"2024-01-15T10:30:00Z"

​
updatedAt
string<date-time>
required

Timestamp when the contact was last updated

Example:

"2024-01-15T10:30:00Z"

​
email
string<email>

Contact's email address

Example:

"john.doe@example.com"

​
cellphone
string

Contact's cellphone number

Example:

"+1-555-123-4567"

​
customAttributes
object[]

Array of custom key-value attributes

​
ownerId
string<email>

Email address of the salesperson or user who owns this contact

Example:

"salesperson@your-company.com"

⌘I