curl --request POST \
--url https://api.sendx.io/api/v1/rest/contact \
--header 'Content-Type: application/json' \
--header 'X-Team-ApiKey: <api-key>' \
--data '
{
"email": "john.doe@example.com"
}
'{
"id": "contact_BnKjkbBBS500CoBCP0oChQ",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com",
"company": "Example Corp",
"customFields": {
"field_MnuqBAG2NPLm7PZMWbjQxt": "Engineering",
"field_QqfhckbdcvQinLPlduIbHq": "Senior"
},
"lists": [
"list_OcuxJHdiAvujmwQVJfd3ss",
"list_xyz789ghi012"
],
"tags": [
"tag_UhsDkjL772Qbj5lWtT62VK",
"tag_UhsDkjL772Qbj5lWtT62VK"
],
"unsubscribed": false,
"bounced": false,
"spam": false,
"blocked": false,
"dropped": false,
"created": "2024-01-10T14:20:00Z",
"updated": "2024-01-15T09:15:00Z",
"trackData": "utm_source=website&utm_campaign=signup&utm_medium=banner",
"contactSource": 1,
"pageSource": "https://example.com/signup?ref=google-ads",
"lastTrackedIp": "203.0.113.42",
"LTV": 7500
}Create a new contact
Creates a new contact in your SendX team with the provided information.
🎯 Key Features:
- Email validation and duplicate detection
- Automatic relationship building with lists and tags
- Smart custom field handling
📋 Business Rules:
- Email is mandatory and must be unique within the team
- Last tracked IP is stored for analytics
curl --request POST \
--url https://api.sendx.io/api/v1/rest/contact \
--header 'Content-Type: application/json' \
--header 'X-Team-ApiKey: <api-key>' \
--data '
{
"email": "john.doe@example.com"
}
'{
"id": "contact_BnKjkbBBS500CoBCP0oChQ",
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com",
"company": "Example Corp",
"customFields": {
"field_MnuqBAG2NPLm7PZMWbjQxt": "Engineering",
"field_QqfhckbdcvQinLPlduIbHq": "Senior"
},
"lists": [
"list_OcuxJHdiAvujmwQVJfd3ss",
"list_xyz789ghi012"
],
"tags": [
"tag_UhsDkjL772Qbj5lWtT62VK",
"tag_UhsDkjL772Qbj5lWtT62VK"
],
"unsubscribed": false,
"bounced": false,
"spam": false,
"blocked": false,
"dropped": false,
"created": "2024-01-10T14:20:00Z",
"updated": "2024-01-15T09:15:00Z",
"trackData": "utm_source=website&utm_campaign=signup&utm_medium=banner",
"contactSource": 1,
"pageSource": "https://example.com/signup?ref=google-ads",
"lastTrackedIp": "203.0.113.42",
"LTV": 7500
}Authorizations
Team API key for authentication. Find your API key in SendX Settings → Team API Key.
Example:
X-Team-ApiKey: your_team_api_key_here
Body
Email address of the contact (required and must be unique within team).
Validation:
- Must be a valid email format
- Must be unique within the team
- Cannot be empty or null
255"john.doe@example.com"
First name of the contact
255"John"
Last name of the contact
255"Doe"
Company name of the contact
255"Example Corp"
Custom fields as key-value pairs. Keys should use custom_field_ prefix.
Processing:
- Keys are case-sensitive
- Values are stored as strings
Examples:
"field_MnuqBAG2NPLm7PZMWbjQxt": "Engineering"→ stored asdepartment: Engineering
Show child attributes
Show child attributes
{
"field_MnuqBAG2NPLm7PZMWbjQxt": "Engineering",
"field_QqfhckbdcvQinLPlduIbHq": "Senior"
}
Array of list identifiers to associate with the contact.
Identifiers should use list_ prefix.
Processing:
- Invalid list IDs will send our 400 error
- Duplicates will be removed
Examples:
"list_OcuxJHdiAvujmwQVJfd3ss"→ valid prefixed format
^(list_)?[a-zA-Z0-9]{22}$["list_OcuxJHdiAvujmwQVJfd3ss"]
Array of tag identifiers to associate with the contact.
Identifiers should use tag_ prefix.
Processing:
- Invalid tag IDs will be ignored
- Duplicates will be removed
Examples:
"tag_UhsDkjL772Qbj5lWtT62VK"→ valid prefixed format
^(tag_)?[a-zA-Z0-9]{22}$["tag_UhsDkjL772Qbj5lWtT62VK"]
Last tracked IP address of the contact for analytics purposes.
Usage:
- Used for geographic analytics
- Helps with spam detection
- Optional field
"192.168.1.100"
Response
✅ Contact created successfully
Unique contact identifier with contact_ prefix.
Format: contact_ + 22 alphanumeric characters
Usage:
- Use this ID for all subsequent API calls
- Unique across the entire SendX platform
- Never changes once created
^contact_[a-zA-Z0-9]{22}$"contact_BnKjkbBBS500CoBCP0oChQ"
First name of the contact
"John"
Last name of the contact
"Doe"
Email address of the contact (unique within team)
"john.doe@example.com"
Company name of the contact
"Example Corp"
Custom fields with custom_field_ prefixed keys.
Format: All keys have custom_field_ prefix in responses
Example Structure:
{
"field_MnuqBAG2NPLm7PZMWbjQxt": "Engineering",
"field_QqfhckbdcvQinLPlduIbHq": "Senior",
"field_MnuqBAG2NPLm7PZMWbjQxt": "$75000"
}
Show child attributes
Show child attributes
{
"field_MnuqBAG2NPLm7PZMWbjQxt": "Engineering",
"field_QqfhckbdcvQinLPlduIbHq": "Senior"
}
Associated lists with list_ prefixed identifiers.
Format: All IDs have list_ prefix in responses
^list_[a-zA-Z0-9]{22}$[
"list_OcuxJHdiAvujmwQVJfd3ss",
"list_xyz789ghi012"
]
Associated tags with tag_ prefixed identifiers.
Format: All IDs have tag_ prefix in responses
^tag_[a-zA-Z0-9]{22}$[
"tag_UhsDkjL772Qbj5lWtT62VK",
"tag_UhsDkjL772Qbj5lWtT62VK"
]
Whether the contact has unsubscribed from emails
false
Whether emails to this contact have bounced
false
Whether the contact has marked emails as spam
false
Whether the contact is blocked from receiving emails
false
Whether emails to this contact have been dropped
false
Contact creation timestamp (ISO 8601 format)
"2024-01-10T14:20:00Z"
Contact last update timestamp (ISO 8601 format)
"2024-01-15T09:15:00Z"
Email tracking data and UTM parameters.
Contains:
- UTM parameters from campaigns
- Attribution data
- Custom tracking parameters
"utm_source=website&utm_campaign=signup&utm_medium=banner"
Source type of the contact creation.
Values:
1- API/Manual2- Import3- Form4- Integration
1
URL of the page where contact was created
"https://example.com/signup?ref=google-ads"
Last tracked IP address of the contact
"203.0.113.42"
Lifetime Value of the contact in cents.
Example: 7500 = $75.00
7500
Was this page helpful?