A secure enrichment endpoint for adding missing contact details to client-provided records, including email append and reverse email lookup workflows.
POST https://append-api.bettrdata.io/v1/append
Use for
Appending contact data to known people or resolving profile data from an email address.
Format
JSON request and JSON response. Up to 100 records per request.
Authentication
API key supplied in the x-api-key request header.
Authentication
Each request must include the client API key provided by BettrData. Keep the key private and send it only over HTTPS.
curl -X POST "https://append-api.bettrdata.io/v1/append" \
-H "content-type: application/json" \
-H "x-api-key: YOUR_API_KEY" \
--data '{ ... }'Request
Send a JSON object containing an optional batch ID, an array of records, and a configuration object that identifies the append type.
Field | Description |
batchId | Optional client-defined ID for tracking a request or file. |
data | Required array of 1 to 100 records. Every record must include a unique recId. |
config.type | Required. Use email-append or reverse-email. |
config.validation | Optional boolean indicating whether validation should be requested for the batch. |
Email append: Include identifying fields such as name and postal address.
Reverse email: Include an email address on each record.
Response
Successful requests return one result per submitted record. The original recId is preserved so clients can merge results back to the source file. Additional BettrData diagnostic metadata may be present and can be ignored for standard integrations.
Field | Description |
requestId | Unique ID assigned to the API request. |
batchId | Returned when supplied in the request. |
appendType | The requested append workflow. |
results[].recId | Record ID from the request. |
results[].status | matched means data was found, not_matched means no data was available, and error means the record could not be completed. |
results[].data | Appended fields for matched records. Empty when no match is found. |
results[].errorCode | Error code when a record could not be processed; otherwise null. |
{
"requestId": "req_abc123",
"batchId": "client-batch-001",
"appendType": "email-append",
"results": [
{
"recId": "1",
"status": "matched",
"data": {
"email": "jane.smith@example.com"
},
"errorCode": null
}
]
}Base URL: https://append-api.bettrdata.io