Skip to main content
POST
/
{resource}
curl --request POST \
  --url http://localhost:5001/api/v1/{resource} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "Jane",
  "lastName": "Doe",
  "email": "jane.doe@example.com",
  "phone": "+1-555-0100",
  "company": "Acme Corp",
  "jobTitle": "VP of Sales",
  "address": {
    "street": "123 Main St",
    "city": "San Francisco",
    "state": "CA",
    "postalCode": "94105",
    "country": "US"
  }
}
'
{
  "success": true,
  "statusCode": 201,
  "message": "Created",
  "data": {
    "data": {
      "id": "12345",
      "remoteId": "12345",
      "firstName": "Jane",
      "lastName": "Doe",
      "email": "jane.doe@example.com",
      "phone": "+1-555-0100",
      "company": "Acme Corp",
      "jobTitle": "VP of Sales",
      "address": {
        "street": "123 Main St",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94105",
        "country": "US"
      },
      "lifecycleStage": "customer",
      "ownerId": "67823451",
      "ownerName": "John Smith",
      "ownerEmail": "john.smith@acme.com",
      "source": null,
      "tags": null,
      "customFields": null,
      "createdAt": "2025-01-15T10:00:00.000Z",
      "updatedAt": "2025-03-01T14:30:00.000Z"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Enter your API key with the Bearer prefix — e.g. Bearer sk_live_xxx (production) or Bearer sk_test_xxx (sandbox)

Path Parameters

​
resource
enum<string>
required
Available options:
contact,
lead,
deal,
meeting

Query Parameters

​
provider
string
required
Example:

"hubspot"

​
endUserId
string
required
Example:

"user-001"

Body

application/json

Unified resource body. Pick an example from the dropdown to see the schema for each resource type.

​
firstName
string
Example:

"Jane"

​
lastName
string
Example:

"Doe"

​
email
string
Example:

"jane.doe@example.com"

​
phone
string
Example:

"+1-555-0100"

​
company
string
Example:

"Acme Corp"

​
jobTitle
string
Example:

"VP of Sales"

​
address
object
​
tags
string[]
Example:
["vip", "prospect"]
​
ownerId
string

Provider-native owner/user ID

Example:

"owner_001"

​
lifecycleStage
string

Unified lifecycle stage (e.g. lead, customer, subscriber)

Example:

"lead"

​
source
string
Example:

"website"

​
customFields
object

Arbitrary provider-specific fields

Example:
{ "loyaltyScore": 85 }

Response

Resource created successfully