POST/users/{userId}/user-profile-statuses

Adds a member's current status or scheduled status.
You can add either the current status or scheduled status or both for a member, where startTime and endTime for the scheduled status must be set for some point in the future.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

user
directory

HTTP Request

POSThttps://www.worksapis.com/v1.0/users/{userId}/user-profile-statuses

Path Parameters

ParameterTypeDescription
userId string 

Member ID
- Email address
- Resource ID
- External key in "externalKey:{externalKey}" format


required
example : userf7da-f82c-4284-13e7-030f3b4c756x 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
profileStatusId string 

Status ID.
BUSY, AWAY, LEAVE_OFFICE, ABSENCE, CUSTOM01-CUSTOM12


required
Allowed values : BUSY, AWAY, LEAVE_OFFICE, ABSENCE, CUSTOM01, CUSTOM02, CUSTOM03, CUSTOM04, CUSTOM05, CUSTOM06, CUSTOM07, CUSTOM08, CUSTOM09, CUSTOM10, CUSTOM11, CUSTOM12 
statusMessage string 

Status message


maxLength : 50
nullable : true 
startTime string 

Start date (format: YYYY-MM-DDThh:mm:ssTZD).
If startTime is specified, endTime must be specified.


format : date-time
nullable : true 
endTime string 

End date (format: YYYY-MM-DDThh:mm:ssTZD).
If startTime is specified, endTime must be specified.


format : date-time
nullable : true 
autoReplyMail object (autoReplyMail) 

Auto reply settings


nullable : true 

autoReplyMail

PropertyTypeDescription
internal object (internal) 

Auto replay settings for internal emails

 
external object (external) 

Auto replay settings for external emails

 

internal

PropertyTypeDescription
content string 

Content


maxLength : 300 
sentDirectlyToMe boolean 

Indicates whether to automatically reply to email messages only sent directly to me.


default : false 

external

PropertyTypeDescription
content string 

Content


maxLength : 300 
sentDirectlyToMe boolean 

Indicates whether to automatically reply to email messages only sent directly to me.


default : false 

Request Example

example

1{2  "profileStatusId": "BUSY",3  "statusMessage": "status message1",4  "startTime": "2017-03-16T09:00:00+09:00",5  "endTime": "2017-03-18T18:00:00+09:00",6  "autoReplyMail": {7    "internal": {8      "content": "internal mail content",9      "sentDirectlyToMe": true10    },11    "external": {12      "content": "external mail content",13      "sentDirectlyToMe": false14    }15  }16}

Response

HTTP 201

OK

PropertyTypeDescription
userProfileStatusId string 

Member status ID

 
profileStatusId string 

Status ID.
BUSY, AWAY, LEAVE_OFFICE, ABSENCE, CUSTOM01-CUSTOM12


Allowed values : BUSY, AWAY, LEAVE_OFFICE, ABSENCE, CUSTOM01, CUSTOM02, CUSTOM03, CUSTOM04, CUSTOM05, CUSTOM06, CUSTOM07, CUSTOM08, CUSTOM09, CUSTOM10, CUSTOM11, CUSTOM12 
profileStatusName string 

Status name

 
iconUrl string 

Icon URL

 
scheduleType string 

Indicates whether the member status type is present or reserved.


Allowed values : PRESENT, RESERVED 
statusMessage string 

Status message


maxLength : 50
nullable : true 
startTime string 

Start date (format: YYYY-MM-DDThh:mm:ssTZD).
If startTime is specified, endTime must be specified.


format : date-time
nullable : true 
endTime string 

End date (format: YYYY-MM-DDThh:mm:ssTZD).
If startTime is specified, endTime must be specified.


format : date-time
nullable : true 
autoReplyMail object (autoReplyMail) 

Auto reply settings


nullable : true 

autoReplyMail

PropertyTypeDescription
internal object (internal) 

Auto replay settings for internal emails

 
external object (external) 

Auto replay settings for external emails

 

internal

PropertyTypeDescription
content string 

Content


maxLength : 300 
sentDirectlyToMe boolean 

Indicates whether to automatically reply to email messages only sent directly to me.

 

external

PropertyTypeDescription
content string 

Content


maxLength : 300 
sentDirectlyToMe boolean 

Indicates whether to automatically reply to email messages only sent directly to me.

 

Response Example

example

1{2  "userProfileStatusId": "uprofile-b785-4aae-c330-01e94337846b",3  "profileStatusId": "BUSY",4  "profileStatusName": "Busy",5  "iconUrl": "https://static.worksmobile.net/static/wm/settings/profile_state/ic-16-busy.png",6  "scheduleType": "PRESENT",7  "statusMessage": "status message1",8  "startTime": "2017-03-16T09:00:00+09:00",9  "endTime": "2017-03-18T18:00:00+09:00",10  "autoReplyMail": {11    "internal": {12      "content": "internal mail content",13      "sentDirectlyToMe": true14    },15    "external": {16      "content": "external mail content",17      "sentDirectlyToMe": false18    }19  }20}

HTTP 400

Bad Request

HTTP 403

Not used status. (The status must be used in the domain status.)
The status must be enable. (The use of statuses must be enabled for the domain to use this API operation.)