paymo.users.add

Add a user to the authenticated user's company.

Authentication

This method requires authentication by a user with admin privileges.

Note: This method requires an HTTP POST request.

Arguments

api_key (Required)
Your application key. See here for more details.
auth_token (Required)
Authentication token received upon login.
name (Required)
Name of the new user.
username (Required)
Username of the new user.
password (Required)
Password for the new user.
email (Optional)
Email address of the new user.
phone (Optional)
Phone number of the new user.
workday_hours (Optional)
Working day length in hours. It is used to estimate user performance.
job_position (Optional)
Job position of the new user.
timezone (Optional)
Timezone of the new user. If left blank, user's timezone will be set to the company's timezone setting.
See the list of timezones.

Example Response

<?xml version="1.0" encoding="UTF-8"?> <response status="ok"> <user id="1280" /> </response>

Error Codes

101: Unknown API method
The requested method was not found.
102: Unknown response format
The requested response format was not found.
103: Invalid API Key
The API key passed was not valid.
104: Invalid auth token / Login failed
The login details or auth token passed were invalid.
105: Insufficient permissions
The user making the method call did not have the required permissions.
106: Service currently unavailable
The service is temporarily unavailable.
107: Too many requests for this API key
The application has reached the limit for number of API calls during a specific time period. Wait a bit and try again.
108: HTTP POST request expected
The method required that parameters are sent using an HTTP POST request.
207: Maximum number of users reached
The company has reached the maximum number of users. You can upgrade your account.
208: Blank name
Name argument was blank.
209: Blank username
Username argument was blank.
210: Blank password
Password argument was blank.
211: Timezone not found
Timezone was not found. See the list of timezones
212: Username is not available
A user with the given username already exists in the company.