Flexible Template API

    Flexible Templates are messages with a customizable layout. You can customize the layout freely based on the specification for CSS Flexible Box (CSS Flexbox).

    This page provides the API information to send a flexible template.

    API Type

    Server API

    Request URL

    https://apis.worksmobile.com/r/{API ID}/message/v1/bot/{botNo}/message/push

    HTTP Method

    POST(Content-Type: application/json; charset=UTF-8)

    Request Content

    Parameter Type Required Description
    type string Y Set this parameter to flex.
    altText string Y Alternative text displayed on messages or push notifications.
    Alternative text can be written and sent in multiple languages.
    Max length: 400 characters
    contents object Y Flexible Template container

    Request Example

    Flexible Template structure

    
    {
      "accountId": "admin@example.com",
      "content": {
        "type": "flex",
        "altText": "this is a flexible template",
        "contents": {
          "type": "bubble",
          "body": {
            "type": "box",
            "layout": "vertical",
            "contents": [
              {
                "type": "text",
                "text": "hello"
              },
              {
                "type": "text",
                "text": "world"
              }
            ]
          }
        }
      }
    }
    

    See Also