Add user

Use this method to add a user to the account. Only the administrator user is authorized to use this method.

Method Name: user.add

Arguments: sid, email, first_name, last_name

Optional arguments: timezone, report_group, can_submit_documents, share_folders, can_index_documents*, is_admin, password (optional - if no password is specified users will receive an activation email with a temporary password)

*can_index_documents is an option only for accounts that have a customer repository enabled for the account.

Returns: sid, api_status, response_timestamp, id

Errors: Returns an error message if invalid arguments are passed, detailing which arguments were invalid.

Messages: Returns a message indicating the user was added. No messages will be present if errors occurred in the transaction.

<?xml version=”1.0” encoding=”UTF-8”?><methodCall> <methodName>user.add</methodName> <params><param> <value><struct> <member> <name>sid</name> <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value> </member> <member> <name>email</name> <value><string>joe@user.com</string></value> </member> <member> <name>password</name> <value><string>swizzlestick123</string></value> </member> <member> <name>timezone</name> <value><int>126</int></value> </member> <member> <name>last_name</name> <value><string>User</string></value> </member> <member> <name>first_name</name> <value><string>Joe</string></value> </member> </struct></value> </param></params></methodCall>

Example Response

<struct> <member> <name>sid</name> <value><string>f6ebaf325cfec9f69b5a68f3a77d9d0b57b29b96</string></value> </member> <member> <name>messages</name> <value><array><data> <value><string>Joe User Created</string></value> </data></array></value> </member> <member> <name>api_status</name> <value><int>200</int></value> </member> <member> <name>id</name> <value><int>22</int></value> </member></struct>

Thank you! Your feedback will help us to improve this guide.

Was this page helpful?


We're sorry to hear that

If you have the time, we'd love to know how we could improve it.

Need to contact a human?

Get in touch