Contacts

Create, update, query, and delete contacts.

Create contact

post

https://pre.card.bizhttps://card.biz

/api/open/contact/save

Create a new contact.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key provided by BizCard. Send it in the X-API-Key header.

Body

application/json

requestIdstringOptional

Request ID for tracing.

contactOwnerEmailstringRequired

Owner email of the contact.

firstNamestringRequired

lastNamestringOptional

primaryEmailstringRequired

emailsstring[]Optional

phonesstring[]Optional

companystringOptional

departmentstringOptional

jobTitlestringOptional

countrystringOptional

citystringOptional

externalIdstringOptional

External system ID (unique under the same contactOwnerEmail).

externalRegistrationStatusinteger · enumOptional

External registration status: 0-unregistered, 1-registered.

Possible values:

externalSubscriptionStatusinteger · enumOptional

External subscription status: 0-none, 1-trial, 2-expired, 3-subscribed.

Possible values:

updaterinteger · enumRequired

Who performs the update: 1-UI manual, 2-Agent, 3-API.

Possible values:

updateTimestring · date-timeRequired

Responses

200

Success

application/json

codeintegerRequired

Business status code. 200 means success.

messagestringRequired

Human readable message.

400

Parameter error

application/json

401

Authentication failed

application/json

500

System error

application/json

post

/api/open/contact/save

curl

curl -X POST "https://pre.card.biz/api/open/contact/save" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "requestId": "req-001",
  "contactOwnerEmail": "[e-mail]",
  "firstName": "John",
  "lastName": "Doe",
  "primaryEmail": "[e-mail]",
  "emails": [
    "[e-mail]"
  ],
  "phones": [
    "[phone]"
  ],
  "company": "Acme Inc",
  "department": "Engineering",
  "jobTitle": "Software Engineer",
  "country": "USA",
  "city": "New York",
  "externalId": "ext-12345",
  "externalRegistrationStatus": 1,
  "externalSubscriptionStatus": 3,
  "updater": 3,
  "updateTime": "2025-12-26T10:00:00.000Z",
  "extParams": {
    "source": "website"
  }
}'

{
  "code": 1,
  "message": "text",
  "data": {
    "contactId": "text",
    "contactOwner": "text",
    "firstName": "text",
    "lastName": "text",
    "primaryEmail": "text",
    "emails": [
      "text"
    ],
    "phones": [
      "text"
    ],
    "company": "text",
    "department": "text",
    "jobTitle": "text",
    "country": "text",
    "city": "text",
    "externalId": "text",
    "createdAt": "2026-03-03T02:02:36.325Z",
    "updatedAt": "2026-03-03T02:02:36.325Z"
  }
}

Update contact

post

https://pre.card.bizhttps://card.biz

/api/open/contact/update

Update an existing contact by contactId. Note: emails and phones are append mode.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key provided by BizCard. Send it in the X-API-Key header.

Body

application/json

contactIdstringRequired

Contact ID.

requestIdstringOptional

contactOwnerEmailstringOptional

Owner email can be updated.

firstNamestringOptional

lastNamestringOptional

primaryEmailstringOptional

emailsstring[]Optional

Append mode (server will append).

phonesstring[]Optional

Append mode (server will append).

companystringOptional

departmentstringOptional

jobTitlestringOptional

countrystringOptional

citystringOptional

externalRegistrationStatusinteger · enumOptional

External registration status: 0-unregistered, 1-registered.

Possible values:

externalSubscriptionStatusinteger · enumOptional

External subscription status: 0-none, 1-trial, 2-expired, 3-subscribed.

Possible values:

updaterinteger · enumRequired

Who performs the update: 1-UI manual, 2-Agent, 3-API.

Possible values:

updateTimestring · date-timeRequired

Responses

200

Success

application/json

codeintegerRequired

Business status code. 200 means success.

messagestringRequired

Human readable message.

400

Parameter error

application/json

401

Authentication failed

application/json

404

Contact not found

application/json

500

System error

application/json

post

/api/open/contact/update

curl

curl -X POST "https://pre.card.biz/api/open/contact/update" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "contactId": "550e8400-e29b-41d4-a716-446655440000",
  "requestId": "req-002",
  "firstName": "Johnny",
  "phones": [
    "[phone]"
  ],
  "externalSubscriptionStatus": 2,
  "updater": 3,
  "updateTime": "2025-12-26T11:00:00.000Z"
}'

{
  "code": 1,
  "message": "text",
  "data": {
    "contactId": "text",
    "contactOwner": "text",
    "firstName": "text",
    "lastName": "text",
    "primaryEmail": "text",
    "emails": [
      "text"
    ],
    "phones": [
      "text"
    ],
    "company": "text",
    "department": "text",
    "jobTitle": "text",
    "country": "text",
    "city": "text",
    "externalId": "text",
    "createdAt": "2026-03-03T02:02:36.325Z",
    "updatedAt": "2026-03-03T02:02:36.325Z"
  }
}

Query contact

get

https://pre.card.bizhttps://card.biz

/api/open/contact/query

Query a contact by contactId.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key provided by BizCard. Send it in the X-API-Key header.

Query parameters

contactIdstringRequired

Responses

200

Success

application/json

codeintegerRequired

Business status code. 200 means success.

messagestringRequired

Human readable message.

400

Parameter error

application/json

401

Authentication failed

application/json

404

Contact not found

application/json

500

System error

application/json

get

/api/open/contact/query

curl

curl -X GET "https://pre.card.biz/api/open/contact/query?contactId=550e8400-e29b-41d4-a716-446655440000" \
  -H "X-API-Key: YOUR_API_KEY"

{
  "code": 1,
  "message": "text",
  "data": {
    "contactId": "text",
    "contactOwner": "text",
    "firstName": "text",
    "lastName": "text",
    "primaryEmail": "text",
    "emails": [
      "text"
    ],
    "phones": [
      "text"
    ],
    "company": "text",
    "department": "text",
    "jobTitle": "text",
    "country": "text",
    "city": "text",
    "externalId": "text",
    "createdAt": "2026-03-03T02:02:36.325Z",
    "updatedAt": "2026-03-03T02:02:36.325Z"
  }
}

Delete contact

post

https://pre.card.bizhttps://card.biz

/api/open/contact/delete

Delete a contact by contactId.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key provided by BizCard. Send it in the X-API-Key header.

Body

application/json

requestIdstringOptional

contactIdstringRequired

updaterinteger · enumRequired

Who performs the update: 1-UI manual, 2-Agent, 3-API.

Possible values:

Responses

200

Success

application/json

codeintegerRequired

messagestringRequired

dataany · nullableOptional

400

Parameter error

application/json

401

Authentication failed

application/json

404

Contact not found

application/json

500

System error

application/json

post

/api/open/contact/delete

curl

curl -X POST "https://pre.card.biz/api/open/contact/delete" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "requestId": "req-003",
  "contactId": "550e8400-e29b-41d4-a716-446655440000",
  "updater": 3
}'

{
  "code": 1,
  "message": "text",
  "data": null
}

Deprecated

Save or update contact

post

https://pre.card.bizhttps://card.biz

/api/open/contact/saveOrUpdate

If contactId is provided and exists, update; otherwise create. Prefer using /save or /update explicitly for clarity.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key provided by BizCard. Send it in the X-API-Key header.

Body

application/json

contactIdstringRequired

Contact ID.

requestIdstringOptional

contactOwnerEmailstringOptional

Owner email can be updated.

firstNamestringOptional

lastNamestringOptional

primaryEmailstringOptional

emailsstring[]Optional

Append mode (server will append).

phonesstring[]Optional

Append mode (server will append).

companystringOptional

departmentstringOptional

jobTitlestringOptional

countrystringOptional

citystringOptional

externalRegistrationStatusinteger · enumOptional

External registration status: 0-unregistered, 1-registered.

Possible values:

externalSubscriptionStatusinteger · enumOptional

External subscription status: 0-none, 1-trial, 2-expired, 3-subscribed.

Possible values:

updaterinteger · enumRequired

Who performs the update: 1-UI manual, 2-Agent, 3-API.

Possible values:

updateTimestring · date-timeRequired

Responses

200

Success

application/json

codeintegerRequired

Business status code. 200 means success.

messagestringRequired

Human readable message.

400

Parameter error

application/json

401

Authentication failed

application/json

404

Contact not found

application/json

500

System error

application/json

post

/api/open/contact/saveOrUpdate

curl

# Create (no contactId)
curl -X POST "https://pre.card.biz/api/open/contact/saveOrUpdate" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "requestId": "req-004",
  "contactOwnerEmail": "[e-mail]",
  "firstName": "Jane",
  "primaryEmail": "[e-mail]",
  "company": "Tech Corp",
  "updater": 3,
  "updateTime": "2025-12-26T12:00:00.000Z"
}'

# Update (with contactId)
curl -X POST "https://pre.card.biz/api/open/contact/saveOrUpdate" \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "contactId": "550e8400-e29b-41d4-a716-446655440000",
  "requestId": "req-005",
  "firstName": "Jane Updated",
  "updater": 3,
  "updateTime": "2025-12-26T12:00:00.000Z"
}'

{
  "code": 1,
  "message": "text",
  "data": {
    "contactId": "text",
    "contactOwner": "text",
    "firstName": "text",
    "lastName": "text",
    "primaryEmail": "text",
    "emails": [
      "text"
    ],
    "phones": [
      "text"
    ],
    "company": "text",
    "department": "text",
    "jobTitle": "text",
    "country": "text",
    "city": "text",
    "externalId": "text",
    "createdAt": "2026-03-03T02:02:36.325Z",
    "updatedAt": "2026-03-03T02:02:36.325Z"
  }
}