PUT/bots/{botId}/domains/{domainId}

Updates a bot's domain information.

Caution

  • Users will be notified if a bot is added to a domain under Service > Bot in the LINE WORKS Admin, but they will not if a bot domain is added using the API.
  • The following API operations must not be called as parallel for same bot. Add, Update, Partially update, Delete, Add a domain, Update a domain, Partially update a domain, Delete a domain, Add a bot user, Delete a bot user

Authorization

oauth2

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

Scope

bot

HTTP Request

PUThttps://www.worksapis.com/v1.0/bots/{botId}/domains/{domainId}

Path Parameters

ParameterTypeDescription
botId integer 

Bot ID


required
example : 2000001
format : int64 
domainId integer 

Domain ID


required
example : 10000001
format : int64 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
visible boolean 

Indicates whether to make the bot visible on the customer's organization chart.


default : false 
allowToSelectedMember boolean 

Indicates whether to allow only specified members to use the bot.


default : false 

Request Example

example

1{2  "visible": true,3  "allowToSelectedMember": true4}

Response

HTTP 200

OK

PropertyTypeDescription
domainId integer 

Domain ID


format : int64
readOnly : true 
visible boolean 

Indicates whether to make the bot visible on the customer's organization chart.


default : false 
allowToSelectedMember boolean 

Indicates whether to allow only specified members to use the bot.


default : false 

Response Example

example

1{2  "domainId": 10000001,3  "visible": true,4  "allowToSelectedMember": true5}