Create Account User
Creates a new user in your account.
Endpoint
PUT
v5/accountuser
Requires authentication. Accessible to Account Administrator users only.
Path Parameters
None
Query Parameters
email
string
required
The email address for the new user.
username
string
The display name for the new user.
team
integer
The ID of a team to add the user to.
defaultteam
integer
The ID of the team to set as the user's default team.
admin
integer
Whether to grant account administrator privileges. Accepted values:
1 (admin), 0 (standard user).phone_support
integer
Whether to enable phone support access. Accepted values:
1 (enabled), 0 (disabled).license
string
The license type to assign to the user. Accepted values:
Full Access, Professional, Collaborator, Stakeholder.create_access_token
boolean
Whether to generate an API access token for the new user. Only allowed when using OAuth authentication. Accepted value:
true.userdata
object
Custom user data fields to set on the new user. Each key is the column name of the custom field.
child attributes
column_name
string
The value to set for the named custom field. Example:
userdata[department]=sales.Response
Returns the newly created account user object.
result_ok
boolean
Whether the request succeeded.
data
object
The newly created account user object. See Get Account User for the full list of response fields.
child attributes
id
string
The unique ID of the newly created user.
username
string
The user's display name.
email
string
The user's email address.
status
string
The user's account status. Possible values:
Active, Disabled.api_key
string | null
The user's API token. Populated only if
create_access_token=true was passed; otherwise null.api_secret
string | null
The user's API token secret. Populated only if
create_access_token=true was passed; otherwise null.Examples
Request (cURL)
curl -X PUT "https://api.alchemer.com/v5/accountuser?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET&email=newuser@example.com&username=Jane+Doe&license=Full+Access"
Response
{
"result_ok": true,
"data": {
"id": "YOUR_USER_ID",
"username": "Jane Doe",
"email": "newuser@example.com",
"admin": 0,
"phone_support": 0,
"userdata": [],
"license": "Full Access",
"defaultteam": false,
"status": "Active",
"last_login": null,
"api_key": null,
"api_secret": null
}
}