Update API_USER

post

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

Update configuration of an existing API_USER (only supports POST method).
Tips:

Unsubscribe tracking will be forcibly enabled by the system for free users (source forces it for every non-VIP account: APIUserController:434-437 sets unsubscribe=1 whenever the parameter is present).
If the trackDomainName is set to the default tracking domain name (track2.sendcloud.net), it is not possible to enable read and click tracking — switching to the default domain forces open=0, click=0, unsubscribe=1 (APIUserController:441-445).
Only fields present in the request are updated; omitted fields keep their current value. newName is OPTIONAL (official page wrongly marks it required): omit it to keep the current name. Passing newName equal to the current name skips renaming.

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}$

API_USER name (existing name to be modified). Must reference an existing NORMAL-status API_USER owned by the caller, otherwise 41121.

newName

string

length between 6 and 64

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

New API_USER name, OPTIONAL (source checkNewName canNull=true; official page wrongly marks it required). Omit to keep the current name. Must be unique among the caller's API_USERs, otherwise 41130.

domainName

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 domain name, optional; omit to keep the current binding. Rebinding to a different domain requires it to be non-test (41123) and verified (41124); passing the current domain skips revalidation.

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, optional. Switching to the default domain (track2.sendcloud.net) forces open=0, click=0, unsubscribe=1. Switching to a custom one requires an existing tracking domain with CNAME passed/todo (41018/41019). Passing the current domain skips the switch.

unsubscribePageId

integer

1 to 2147483646

Unsubscribe page ID: integer in [1, 2147483646] (41113 on format violation); must reference an existing page owned by the caller (41112).

open

integer

enum

Whether to enable open-tracking: 0 (disable), 1 (enable). Omit to keep the current value. Non-{0,1} values return 41114.

Allowed:

click

integer

enum

Whether to enable click-tracking: 0 (disable), 1 (enable). Omit to keep the current value. Non-{0,1} values return 41116.

Allowed:

unsubscribe

integer

enum

Whether to enable unsubscribe-tracking: 0 (disable), 1 (enable). Omit to keep the current value. Forced to 1 for non-VIP accounts (free users); only VIP accounts can disable it. Non-{0,1} values return 41118.

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.