Message Templates

List All

Changed on

List all available message templates.

get/message-templates/

Request

  • Base URL: https://api.thanks.io/api/v2
  • URL: https://api.thanks.io/api/v2/message-templates/
  • Auth: HTTP bearer

Query parameters

items_per_pageinteger

Number of items to return per page.

sub_account_idinteger

Filter results by Sub Account ID.

type'postcard' | 'postcard6x9' | 'postcard6x11' | 'letter' | 'windowlessletter' | 'notecard' | 'giftcard' | 'magnacard'

Only return templates of this type. postcard is 4x6.

Response

OK

Example response

{
  "data": [
    {
      "id": 2,
      "user_id": 2,
      "handwriting_style_id": 18,
      "font_color": "#000000",
      "name": "Thank You Message",
      "content": "Hey %FIRST_NAME%!,\n\nTHANK YOU for allowing us the opportunity to HELP you with your plan!",
      "custom_background_url": "https://example.com/background.png",
      "qrcode_url": "https://thanks.io",
      "created_at": "2018-08-08T02:56:59.000000Z",
      "updated_at": "2025-02-12T05:13:15.000000Z",
      "type": "notecard",
      "giftcard_brand_code": "amazonus",
      "giftcard_brand_image": "https://cdn.thanks.io/giftcards/amazonus.png",
      "giftcard_amount": 5000,
      "share_uuid": "5J5N-QAD3-6LLL-LSZZ"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "per_page": 25,
    "to": 1,
    "total": 1
  }
}

Changes

  • 02de08ab2a47Revision changes
    • warning

      added the new postcard6x9 enum value to the // response property for the response status

    • info

      added the new optional query request parameter type

  • 670a67b234a2Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      added the new magnacard enum value to the // response property for the response status

    • warning

      added the new postcard6x11 enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status