Send instructions to change email
POST /api/2.0/people/emailRequest
Sends a message to the user email with the instructions to change the email address connected to the portal.
Authorization
An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.
Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.
Headers
- Accept
enum of string Can be one of:
application/json,text/json,text/plain.- Content-Type
enum of string Can be one of:
application/json,application/*+json,text/json.
Body
Request parameters for updating user information
- email
stringformat: email Email
- password
string Password
- passwordHash
string Password hash
- type
one of - .
enum of string [All - All, RoomAdmin - Room admin, Guest - Guest, DocSpaceAdmin - DocSpace admin, User - User]
Can be one of:
All,RoomAdmin,Guest,DocSpaceAdmin,User.- .
enum of integer [0 - All, 1 - Room admin, 2 - Guest, 3 - DocSpace admin, 4 - User]
Can be one of:
0,1,2,3,4.
- isUser
boolean Specifies if this is a guest or a user
- firstName
string First name
- lastName
string Last name
- department
array of string List of user departments
- title
string Title
- location
string Location
- sex
one of - .
enum of string [Female - Female, Male - Male]
Can be one of:
Female,Male.- .
enum of integer [0 - Female, 1 - Male]
Can be one of:
0,1.
- birthday
object - utcTime
stringformat: date-time UtcTime
- timeZoneOffset
stringformat: date-span TimeZoneOffset
- worksfrom
object - utcTime
stringformat: date-time UtcTime
- timeZoneOffset
stringformat: date-span TimeZoneOffset
- comment
string Comment
- contacts
array of object List of user contacts
- type
string Contact type
- value
string Contact value
- files
string Avatar photo URL
- fromInviteLink
boolean Specifies if the user is added via the invitation link or not
- key
string Key
- cultureName
string Language
- target
stringformat: uuid Target
- spam
boolean Spam
- userId
string User ID
- disable
boolean Specifies whether to disable a user or not
Examples
POST /api/2.0/people/email HTTP/1.1
Accept: application/json
Content-Length: 896
Content-Type: application/json
Host: example.com
{
"email": "Vince58@hotmail.com",
"password": "Iga5elNxPe",
"passwordHash": "some text",
"isUser": true,
"firstName": "Durward",
"lastName": "Steuber",
"department": [
"75a5f745-f697-4418-b38d-0fe0d277e258"
],
"title": "unbranded_steel_car",
"location": "62615 Gaetano Greens, South Estelle, Cayman Islands",
"birthday": {
"utcTime": "2008-04-10T06:30:00.0000000+04:00",
"timeZoneOffset": "00:00:00"
},
"worksfrom": {
"utcTime": "2008-04-10T06:30:00.0000000+04:00",
"timeZoneOffset": "00:00:00"
},
"comment": "some text",
"contacts": [
{
"value": {
"type": "GTalk",
"value": "my@gmail.com"
}
}
],
"files": "some text",
"fromInviteLink": true,
"key": "some text",
"cultureName": "some text",
"target": "75a5f745-f697-4418-b38d-0fe0d277e258",
"spam": true,
"userId": "5152",
"disable": true
}curl --request POST \
--url https://example.com/api/2.0/people/email \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"email": "Vince58@hotmail.com",
"password": "Iga5elNxPe",
"passwordHash": "some text",
"isUser": true,
"firstName": "Durward",
"lastName": "Steuber",
"department": [
"75a5f745-f697-4418-b38d-0fe0d277e258"
],
"title": "unbranded_steel_car",
"location": "62615 Gaetano Greens, South Estelle, Cayman Islands",
"birthday": {
"utcTime": "2008-04-10T06:30:00.0000000+04:00",
"timeZoneOffset": "00:00:00"
},
"worksfrom": {
"utcTime": "2008-04-10T06:30:00.0000000+04:00",
"timeZoneOffset": "00:00:00"
},
"comment": "some text",
"contacts": [
{
"value": {
"type": "GTalk",
"value": "my@gmail.com"
}
}
],
"files": "some text",
"fromInviteLink": true,
"key": "some text",
"cultureName": "some text",
"target": "75a5f745-f697-4418-b38d-0fe0d277e258",
"spam": true,
"userId": "5152",
"disable": true
}'Responses
200
Message text
400
Incorrect userId or email
401
Unauthorized
403
No permissions to perform this action
404
User not found