POST/bots/{botId}/richmenus/{richmenuId}/image

Sets an uploaded image for a rich menu.
This API operation uses the file ID of the image uploaded using the Upload content operation.
The format and size of a rich menu image are as follows:

  • Image format: JPEG or PNG
  • Image size: 2500 x 1686 or 2500 x 843 px
  • Maximum file size: 1 MB

Note

  • The image of a rich menu is displayed only in the mobile environment, while the text in the label is displayed only in the desktop environment.

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}/image

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 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
fileId string 

Rich menu image file ID


required 
i18nFileIds array (i18nFileIds) 

List of multilingual file IDs


minItems : 0 

i18nFileIds

PropertyTypeDescription
language string 

Language code


required
Allowed values : ko_KR, ja_JP, en_US, zh_CN, zh_TW 
fileId string 

File ID


required 

Request Example

example

1{2  "fileId": "jp1.1628695315008671000.1628781715.0.1000001.0.0.0",3  "i18nFileIds": [4    {5      "language": "en_US",6      "fileId": "jp1.1628695315008671000.1628781715.0.1000001.0.0.0"7    }8  ]9}

Response

HTTP 204

No Content