Update a User Account Using the REST API

Use the users API endpoint with the PUT method to update a specific user’s details.

Note:You can use this API endpoint to change any information about a user except their password. The topic Change a User's Password Using the REST API describes how to change a user’s password using the API.

Prerequisites

• You must have a user already configured. To create a new user, refer to the topic Create a User Account Using the REST API.

• Note the User ID of the user you want to update.

Base URL

https://api.prontoforms.com

Endpoint

URL structure

https://api.prontoforms.com/api/1.1/users/{UserID}

Request parameters

None

Request header

Include the standard authorization header. This includes the username and password, where username is the API Key ID and password is the API Key Secret.

cURL example

curl -v -k -u {username}:{password} -X PUT --upload-file {filename}.{extension} https://api.prontoforms.com/api/1.1/users/{UserID}

where username is the API Key ID and password is the API Key Secret. Supported file extensions are .xml and .json.

Request body

Sample request body

{
    "username": "UpdatedUser01",
    "email": "MJ@email.com",
    "role": "ProntoAdmin",
    "firstName": "Mary",
    "lastName": "Johnston",
    "alternateEmail": "alt@email.com",
    "companyName": "Company Co.",
    "address": {
        "address1": "123 Street Street",
        "address2": "Apt 100",
        "city": "Ottawa",
        "state": "Ontario",
        "country": "CA",
        "zipCode": "A1B 2C3"
    },
    "locale": "en_CA",
    "preferredTimeZone": "America/New_York",
    "phoneNumber": "+16132252255",
    "billingId": "1010101010",
    "defaultViewFormSpaceId": "190000000",
    "defaultViewFormDashboardId": "140000000",
    "groupIds": ["2100000000"],
    "ssoOnly": false,
    "organization": {
        "employeeId": "12345",
        "managerName": "Jane Doe",
        "managerEmailAddress": "jdoe@email.com",
        "managerPhoneNumber": "+15062111111",
        "company": "Company Co.",
        "department": "Sales",
        "division": "National",
        "region": "Eastern Canada",
        "subRegion": "Ontario",
        "branch": "Ottawa",
        "branchOffice": "Kanata",
        "office": "02",
        "organizationalUnitName": "Executive",
        "organizationalUnitAddress": {
            "address1": "123 Street Avenue",
            "address2": "Apt 100",
            "city": "Ottawa",
            "state": "Ontario",
            "country": "CA",
            "zipCode": "A1B 2C3"
        }
    }
}

Important considerations

• All objects are optional. Include the objects you want to update.

• If you don’t include an object in the request body, the information related to that object does not change.

• If you want to clear information, include the related object with an empty string as the value.

Description of objects

This list includes a description of the objects that might not be obvious.

role

Change the user’s role to ProntoUser, ProntoAdmin, or ProntoMobileOnly.

billingId

Include a Billing ID to change the user’s subscription.

defaultViewFormSpaceId

Include a FormSpace ID to change the user’s default FormSpace. The user can later change this if they have access to more than one FormSpace.

defaultViewFormDashboardId

Include a Form ID to change the default Form that the user can see in the Basic Analytics section.

Note:You must configure Basic Analytics for the selected form.

groupIds

Include the Group IDs of the groups you want to assign the user to.

ssoOnly

Do you want the user to sign in using your corporate SSO credentials?

• If yes, specify True.
• If no, specify false.

Response code

200—OK

Response examples

This endpoint does not return a response body.

Error codes

Related topics

• Change a User's Password Using the REST API

• Expire a User's Password Using the REST API

• Retrieve a User's Details Using the REST API

• Retrieve a List of Users Using the REST API