Mailix Docs

English

Tiếng Việt

English

Tiếng Việt

Appearance

Overview of the customer API documentation ​

The customer API documentation lists the integration operations exposed to an account, along with parameters, results, and request examples.

Open the API documentation ​

Open Account settings → API, then select View full API documentation.

The page displays the base URL for the Mailix system you are using. Do not copy a URL from another Mailix installation.

Authentication ​

Each request requires the user's API token. The recommended method is the header:

text
Authorization: Bearer YOUR_API_TOKEN

Responses use JSON format. The status code depends on the operation and result; check both the HTTP status and response content instead of assuming every success uses the same code.

Resource groups ​

The customer documentation currently includes these main groups:

  • authentication;
  • lists;
  • campaigns;
  • subscribers;
  • API notifications;
  • notification responses;
  • files.

Use only operations that appear in the customer documentation. Admin documentation and internal addresses are outside the scope of a customer token.

Read an operation ​

Each entry may show:

  • method and path;
  • description;
  • required or optional parameters;
  • default values;
  • result format;
  • command example.

Pagination and rate limits ​

Some lists accept page and per_page parameters; read the corresponding entry carefully. The API notification interface has a rate limit and may return status 429 when exceeded, but it does not publish one universal number. The actual limit may depend on the plan or configuration.

Integration safety ​

  • Grant only a token with the permissions the user needs.
  • Do not put the token in public code or an application that runs entirely in the browser.
  • Start with read operations before using create, update, or delete operations.
  • Regenerate the token immediately if you suspect it has been exposed.

When a request fails ​

Check the base URL, authentication header, method, required parameters, and the user's permissions. Do not show the raw response, which may contain sensitive data, to end users.

Next steps ​