Create User

Overview¶

You can create new records using the API.

Supported Versions¶

Function to update email address via API¶

1. Pleasanter 1.3.22.0 or later

Preparations¶

Please Create an API Key before performing API operations.
Also, this function can only be performed by the tenant manager, so please set up the tenant manager from user management.

Request¶

Send json data in the following request format:

(*1) Please edit the {server name} part to suit your environment as appropriate.
For Pleasanter.net, the format is as follows:
https://pleasanter.net/fs/api/users/create

Request¶

JSON¶

{
    "ApiVersion": 1.1,
    "ApiKey": "017dRapJ3f5f1Dgsdj95...",
    "LoginId": "[Enter the login ID of the user to register]",
    "Name": "[Name of user to register]",
    "Password": "[password]",
    "MailAddresses": [
        "webmaster@example.com",
        "info@example.com"
    ]
}

*When setting an email address at the same time as creating a user, list it in the MailAddresses (optional). Setting one or multiple email addresses for a single user is possible.

Response¶

The json data in the following format will be returned.

JSON¶

{
    "Id": 12345,
    "StatusCode": 200,
    "Message": "\"The name of the user to register\ created."
}

Confirmation Column in Case of Error¶

・Precautions when using the API and things to check if an error occurs
・FAQ: What to check if modified configuration files or API requests (JSON format) are not recognized correctly

Specification Changes¶

*API specifications have been partially changed since November 2018.**
- The URL format has been changed from '/pleasanter/api_items/xxxx' to '/pleasanter/api/items/xxxx'.
- The Content-Type specification has been changed from 'application/x-www-form-urlencoded' to 'application/json'.