Data Types

ModifyUser Method

Description

Modifies an existing user.

HTTP Request

PUT https://api.skeddly.com/api/Users/{id}

URL Parameters

id

ID of the user to modify.

Type: string

Required: Yes

Body

The body is a JSON structure with the following properties. Only the values that are being modified are required.

emailAddress

Email address for the new user. It must not already be used by another user.

Type: string

Required: No

status

Updated status of the user.

Type: string

Valid Values:

  • enabled

  • disabled

Required: No

Returns

A User object.

Sample Request

HTTP
Bash
HTTP
PUT /api/Users/u-00000001 HTTP/1.1
Host: api.skeddly.com
Authorization: AccessKey <api key>
Content-Type: application/json
‚Äč
{
"emailAddress": "user@example.com",
"status": "disabled"
}
Bash
curl -X PUT "https://api.skeddly.com/api/Users/u-00000001" \
-H "Authorization: AccessKey <api key>" \
-d emailAddress="user@example.com" \
-d status=disabled

Sample Response

{
"emailAddress": "user@example.com",
"lastAccessDate": "2016-06-09T11:00:00Z",
"mfaType": "none",
"status": "disabled",
"userId": "u-00000001",
"username": "user1"
}