Create User

POST

/users

Creates a new user under your partner account.

Every domain, mailbox, subscription, and DNS record belongs to a user — create the user first before provisioning anything for a customer.

Store the returned data.id as userId and include it as a query parameter on all subsequent requests for this customer.

Request

Authorization

API Key

Add parameter in header

cmr-x-api-key

Example:

cmr-x-api-key: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

User created

Bodyapplication/json

🟠422Validation Error

🟠403Forbidden

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://customers.coldmailreseller.com/api/v1/integration/users' \
--header 'cmr-x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "email": "alice@company.com",
  "firstName": "Alice",
  "lastName": "Johnson",
  "company": "Acme Corp",
  "languagePreference": "en",
  "addressLineOne": "123 Main Street",
  "addressLineTwo": "Suite 400",
  "city": "New York",
  "state": "New York",
  "country": "US",
  "postalCode": "10001",
  "phoneCc": "1",
  "phone": "2125551234"
}'

Response Example

200 - Example 1

{
    "status": 200,
    "message": "User created",
    "data": {
        "id": "H8M9JV2S9HMPYFQW393AZHQVD4XM"
    },
    "actionId": "ACT_7a078272-0fa7-4db4-a85b-c78697dacea1"
}

Modified at 2026-08-06 06:20:56

Get User

Update User