POST/bots/{botId}/richmenus/{richmenuId}/set-default

Sets the default rich menu.

The display priority of rich menus is as follows:

  1. Custom rich menus
  2. Default rich menus

Authorization

oauth2

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

Scope

bot.message
bot

HTTP Request

POSThttps://www.worksapis.com/v1.0/bots/{botId}/richmenus/{richmenuId}/set-default

Path Parameters

ParameterTypeDescription
botId integer 

Bot ID


required
example : 2000001
format : int64 
richmenuId string 

Bot's rich menu ID


required
example : 40001 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 201

OK

PropertyTypeDescription
botId integer 

Bot ID


format : int64 
defaultRichmenuId string 

Default rich menu ID


readOnly : true 

Response Example

example

1{2  "botId": 2000001,3  "defaultRichmenuId": "40001"4}