Thanks.io Dynamic Images API

openapi: 3.2.0
info:
  title: thanks.io Dynamic Images API
  description: Use the thanks.io API to send postcards, letters, notecards, windowless letters, and gift cards.
  contact:
    url: https://thanks.io
    email: support@thanks.io
  version: 1.0.0
servers:
- url: https://api.thanks.io/api/v2
  description: The main API server for thanks.io
security:
- bearerAuth: []
tags:
- name: Dynamic Images
  description: ''
paths:
  /build/image-template:
    get:
      tags:
      - Dynamic Images
      x-hidden: true
      summary: Create
      description: 'Build image for the front of your postcard or notecard. Includes ability to set dynmiac fields and QR code. This does not create an order, it simply builds the image and returns a URL to the image. You can then use this image URL in your order creation request.


        ## Dynamic Data Tags


        Use these tags in your header, sub-header, background image URL, and QR Code/Redirect URL to have recipient data automatically added further personalizing each postcard.

        - `~FULL_NAME~`

        - `~FIRST_NAME~`

        - `~COMPANY~`

        - `~ADDRESS~`

        - `~ADDRESS2~`

        - `~CITY~`

        - `~STATE~`

        - `~ZIP~`

        - `~EMAIL~`

        - `~PHONE~`

        - `~CUSTOM1~`

        - `~CUSTOM2~`

        - `~CUSTOM3~`

        - `~CUSTOM4~`

        - `~YOUR_FULL_NAME~`

        - `~YOUR_FIRST_NAME~`

        - `~YOUR_COMPANY~`

        - `~YOUR_EMAIL~`

        - `~YOUR_PHONE~`'
      parameters:
      - name: id
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 18
          example: '8'
        required: true
        description: Template ID to use
      - name: background_url
        in: query
        schema:
          type: string
          example: ~STREET_VIEW~
        description: "Background Image URL sits behind the generated dynamic image.  Can be one of the following\n- `~MAP_VIEW~` for Google Map View. \n- `~STREET_VIEW~` for Google Street View.\n- Valid HTTP png or jpg URL "
      - name: header
        in: query
        schema:
          type: string
          example: Want to Know ~ADDRESS~'s Value?
        description: Header Text - Taggable
      - name: subheader
        in: query
        schema:
          type: string
          example: Scan the QR code to get an immediate value for ~ADDRESS~.
        description: Sub-header Text - Taggable
      - name: redirect_url
        in: query
        schema:
          type: string
          example: https://thanks.io
        description: 'Location to redirect recipeint to on QR Code Scan. Can be one of the following

          - `~MESSAGE_QR~` for Message Template QR Code

          - Valid http URL'
      - name: logo_url
        in: query
        schema:
          type: string
          example: https://cdn.thanks.io/assets/brand/logo%402x.png
        description: 'Image Logo to use.  Can be one of the following

          - `~YOUR_LOGO~` for your branding logo

          - `~YOUR_SYMBOL~`for your branding symbol

          - Valid HTTP png or jpg URL'
      - name: overlay_url
        in: query
        schema:
          type: string
          example: https://s3.amazonaws.com/content.thanks.io/templates/dynamic-images/b96a8260-34ce-11f0-b5f2-81d9e83ce1aa.png
        description: Overlay Image URL sits in front of the generated dynamic image.   Must be 1875x1275 png or jpg, or 2738x1838 when `size` is `6x9`.
      - name: size
        in: query
        schema:
          type: string
          enum:
          - 4x6
          - 6x9
          default: 4x6
          example: 6x9
        description: Canvas to render the image at. `4x6` renders 1875x1275 for 4x6 postcards; `6x9` renders 2738x1838 for 6x9 postcards.
      responses:
        '200':
          description: Successful Response
          content:
            image/png:
              schema:
                type: string
                format: binary
      operationId: getBuildImageTemplate
      x-operation-id-source: derived
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Bearer token authentication using your thanks.io API key
externalDocs:
  description: Learn more about thanks.io
  url: https://docs.thanks.io
x-mint:
  mcp:
    enabled: true
x-mcp:
  enabled: true