API Documentation
User PUT

put

User PUT

Update user information. The application must be authenticated and acting on behalf of an admin user.
Required Scope: Users, Update

 

URL Parameters

  • Param Name
    Type
    Description
  • USER_EMAIL
    string
    Email address of the target user

Resource URL

https://api.syncplicity.com/ provisioning/user.svc/{USER_EMAIL}

Query Parameters


Name Values Description
modifier

If the value contains 'no_email', then no email will be sent to the user being modified


Header Parameters


Name Values Description
AppKey
(required)

Consumer Key of the app from Developer Portal

Accept
(required)

Accept type of the request

Content-Type
(required)

Content-Type of the request

Body Parameters


Name Values Description
body
(required)

Request Body

HTTP Basic

OAuth 2.0

API Key

Reset

Make a request and see the response.

Make a request and see the response.

Make a request and see the response.

Response Payload Example


		

Response Payload Schema

Response Error Details

  • HTTP Code
    Error Code
    Description
  • 400
    400

    (Bad request) - Invalid Email Format: The format of the supplied email address is bad
    (Bad request) - Invalid First Name or Invalid Last Name: field is empty or contains unsupported characters
    (Bad request) - Invalid Role Value

  • 401
    401

    (Unauthorized) - Not An Admin

  • 403
    403

    (Forbidden) - Not A Business Admin: The user attempting to execute this request is not a company administrator, or user with this email does not exists
    (Forbidden) - Not A Group Admin or Not A Global Admin or Not An Admin: The user attempting to execute this request is not a company administrator

  • 404
    404

    (Not Found) - Email Address Unknown: A user with the provided email address does not exist in Syncplicity

Working...