Get Signatures

    Gets email signatures.

    API Type

    Service API

    Request URL

    https://apis.worksmobile.com/r/{API ID}/mail/v2/sign

    HTTP Method

    GET(Content-Type: application/x-www-form-urlencoded; charset=UTF-8)

    Request

    No parameters.

    Response

    It returns HTTP status 200 with response data in JSON format if the API call is successful.

    Property Type Required Description
    signList List Y List of signatures
    signList[].defaultSign String Y Signature number used to write a new message
    signList[].useDefaultSign Boolean Y Indicates whether to use a signature in a new message.
    signList[].useDefaultSignForRefw Boolean Y Indicates whether to use a signature for replies or forwards.
    signList[].defaultSignForRefw String Y Signature number used for replies or forwards
    signList[].signInfoList List Y Signature information list
    signList[].signInfoList[].keyNum String N Signature number
    signList[].signInfoList[].contents String N Signature content
    signList[].signInfoList[].name String N Signature title

    Response Example

    {
            "signList": [
                {
                    "defaultSign": "1",
                    "useDefaultSign": "true",
                    "useDefaultSignForRefw": "false",
                    "defaultSignForRefw": "0",
                    "signInfoList": [
                        {
                            "keyNum": "1",
                            "contents": "<html><body>Sign</body></html>",
                            "name": "Sign"
                        },
                        {
                            "keyNum": "2",
                            "contents": "<html><body>Sign 1</body></html>",
                            "name": "Sign 1"
                        }
                    ]
                }
            ]
      }
    

    Error

    It returns an error code and message with HTTP status when the API call fails.

    Property Type Description
    code String Error code
    message String Error message
    HTTP status Error code Description
    500 SYSTEM_ERROR Internal server error
    Error Example
    {
        "code": "SYSTEM_ERROR",
        "message": "internal error",
        "domain": "mail"
    }