Creates a new user account in the system with contact and address information.Request Body#
| Field | Type | Required | Description |
|---|
email | string | Yes | User's email address |
company | string | Yes | Name of the company the user is associated with |
firstName | string | Yes | User's first name |
lastName | string | Yes | User's last name |
country | string | Yes | User's country of residence |
city | string | Yes | User's city of residence |
addressLineOne | string | Yes | Primary address line (street address) |
addressLineTwo | string | No | Secondary address line (e.g., building number) |
addressLineThree | string | No | Additional address line (e.g., apartment number) |
languagePreference | string | Yes | User's preferred language (e.g., en) |
postalCode | string | Yes | Postal code for the user's address |
state | string | Yes | State or province where the user resides |
phoneCc | string | Yes | Country code for the user's phone number |
phone | string | Yes | User's phone number (excluding country code) |
Notes#
Save the userId from the response for use in subsequent user-related requests.
Request
Add parameter in header cmr-x-api-key
Example:cmr-x-api-key: ********************
or
Body Params application/json
{
"addressLineThree": "Apt 5B",
"languagePreference": "en",
"email": "johndoe@company.com",
"company": "TechCorp Inc.",
"firstName": "John",
"lastName": "Doe",
"country": "US",
"city": "New York",
"addressLineOne": "123 Main Street",
"addressLineTwo": "Suite 400",
"postalCode": "10001",
"state": "New York",
"phoneCc": "1",
"phone": "2125551234"
}
Request Code Samples
curl --location --request POST 'https://customers.coldmailreseller.com/api/v1/integration/users' \
--header 'cmr-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
"addressLineThree": "Apt 5B",
"languagePreference": "en",
"email": "johndoe@company.com",
"company": "TechCorp Inc.",
"firstName": "John",
"lastName": "Doe",
"country": "US",
"city": "New York",
"addressLineOne": "123 Main Street",
"addressLineTwo": "Suite 400",
"postalCode": "10001",
"state": "New York",
"phoneCc": "1",
"phone": "2125551234"
}'
Responses
application/json {
"status": 200,
"message": "User created",
"data": {
"id": "H8M9JV2S9HMPYFQW393AZHQVD4XM"
}
}
Modified at 2025-10-29 17:03:46
