Email Users

Bulk create email users

Create up to 500 email users on one domain in a single call.

Asynchronous, like POST /v1/email-users: the whole batch is enqueued as one job and the response is a job receipt (data.job_id, data.status: "pending", data.users_count), not the created mailboxes. Poll GET /v1/jobs/{job_id}, then list the mailboxes with GET /v1/email-users?filter[domain]={domain}.

domain in the body is the domain name, not the domain id.

post/v1/email-users/bulk

Request

  • Base URL: https://api.winnr.app
  • URL: https://api.winnr.app/v1/email-users/bulk
  • Auth: HTTP bearer

Request body

domainstring required

Domain name shared by all users in this request (e.g. "example.com"). All users in a single bulk request must be on the same domain — send one request per domain if creating users across multiple.

Example request

{
  "domain": "example.com",
  "users": [
    {
      "username": "john",
      "name": "John Doe"
    }
  ]
}

Response

Batch accepted and queued. The body is a job receipt, not the created mailboxes.

Example response

{
  "data": {
    "job_id": "job_e80f588c889b4091",
    "domain": "talent.example.com",
    "users_count": 5,
    "message": "Bulk creation of 5 user(s) queued on talent.example.com"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.