---
title: "Get Welcome Message"
method: GET
path: "/api/{account}/settings/welcome-message"
tags: ["Settings"]
---

# Get Welcome Message

`GET /api/{account}/settings/welcome-message`

Get the current automatic welcome message template that is sent when someone subscribes.

## Response `200`

Success

- object
  - `data` object
    - `id` string
    - `template` string
    - `text` string
    - `displayText` string
    - `price` integer
    - `lockedText` boolean
    - `previews` unknown[]
      - unknown
    - `isMediaReady` boolean
    - `mediaCount` integer
    - `media` object[]
      - `id` integer
      - `type` string
      - `convertedToVideo` boolean
      - `canView` boolean
      - `hasError` boolean
      - `createdAt` string
      - `isReady` boolean
      - `files` object
        - `full` object
          - `url` string
          - `width` integer
          - `height` integer
          - `size` integer
          - `sources` unknown[]
            - unknown
        - `thumb` object
          - `url` string
          - `width` integer
          - `height` integer
          - `size` integer
        - `preview` object
          - `url` string
          - `width` integer
          - `height` integer
          - `size` integer
        - `squarePreview` object
          - `url` string
          - `width` integer
          - `height` integer
          - `size` integer
      - `duration` integer
      - `releaseForms` unknown[]
        - unknown
      - `hasCustomPreview` boolean
      - `videoSources` object
        - `240` string, nullable
        - `720` string, nullable
    - `createdAt` string
    - `isActive` boolean
    - `giphyId` string, nullable
    - `isCouplePeopleMedia` boolean
    - `isMarkdownDisabled` boolean
    - `releaseForms` unknown[]
      - unknown
  - `_meta` object
    - `_credits` object
      - `used` integer
      - `balance` integer
      - `note` string
    - `_cache` object
      - `is_cached` boolean
      - `note` string
    - `_rate_limits` object
      - `limit_minute` integer
      - `limit_day` integer
      - `remaining_minute` integer
      - `remaining_day` integer

---

[API](https://skmtc.net/onlyfansapi/apis/onlyfans-api.md) · [All operations](https://skmtc.net/onlyfansapi/apis/onlyfans-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/onlyfansapi/onlyfans-api/versions/4a99d36f28a3/schema)