Add API_USER

post

https://api.aurorasendcloud.com/api/apiuser/add

Create an API_USER (POST only; official description 'Same as GET method' refers to parameter passing, the OpenAPI method is POST).
Tips:

To enable click-tracking, you need to make sure the bound domain has passed "cname" configuration validation.
When trackDomainName is the system default tracking domain name (track2.sendcloud.net), reading tracking and click tracking cannot be enabled — the server forces open=0 and click=0 (APIUserController:283-290). This also applies when trackDomainName is omitted.
Unsubscribe tracking is forcibly enabled (1) for free accounts regardless of the unsubscribe parameter (APIUserController:225-227).
An account may hold at most 10 NORMAL API_USERs (Constant.MAX_CATEGORY_COUNT); exceeding returns 41112 unless the account is whitelisted.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Form Data

name

string

required

length between 6 and 64

^[A-Za-z0-9_][[email protected]]{5,63}$

APIUSER name: 6-64 chars, must start with a letter/digit/underscore; may contain A-Z a-z 0-9 @ . - (Category.CATEGORY_PATTERN). Must be unique; duplicates fail creation with 41119 + 'API_USER already exists'.

emailType

integer

enum

required

Email type: 0 (Trigger), 1 (Batch). Non-integer or out-of-enum values return 41102.

Allowed:

domainName

string

required

length between 4 and 255

^([a-z0-9A-Z][a-z0-9A-Z\-]{0,46}[a-z0-9A-Z]{0,1}\.)+([a-z0-9A-Z]+)$

API_USER bound domain name: total length 4-255 AND each label 1-48 chars. Must be an existing domain owned by the caller (41108); test domains and unverified domains are rejected inside creation (41119 with service message).

trackDomainName

string

length between 4 and 255

^([a-z0-9A-Z][a-z0-9A-Z\-]{0,46}[a-z0-9A-Z]{0,1}\.)+([a-z0-9A-Z]+)$

API_USER bound tracking domain. When omitted or equal to the default (track2.sendcloud.net): defaults to the system tracking domain and forces open=0, click=0. Otherwise must be an existing tracking domain of the caller with CNAME status passed or todo (41018/41019).

unsubscribePageId

integer

1 to 2147483646

Unsubscribe page ID: integer in [1, 2147483646] (0, negative, >= 2147483647 or non-integer return 41113). Must reference an existing unsubscribe page owned by the caller, otherwise 41112.

open

integer

enum

Defaults to 0

Whether to enable open-tracking: 0 (disable), 1 (enable); disable by default. Non-{0,1} integer or non-integer returns 41114. Forced to 0 when the tracking domain is the default one.

Allowed:

click

integer

enum

Defaults to 0

Whether to enable click-tracking: 0 (disable), 1 (enable); disable by default. Non-{0,1} integer or non-integer returns 41116. Forced to 0 when the tracking domain is the default one.

Allowed:

unsubscribe

integer

enum

Defaults to 1

Whether to enable unsubscribe-tracking: 0 (disable), 1 (enable); enabled by default. Non-{0,1} integer or non-integer returns 41118. Forced to 1 for free accounts (server-side, reflected in the response).

Allowed:

Responses

200Request successful

400Business failure. HTTP status is 200 in the actual response body convention; the codes below are the statusCode values returned with result=false.