Skip to main content

Settings Schema

When creating a post for Reddit, use the following settings schema:
{
  "settings": {
    "__type": "reddit",
    "subreddit": [
      {
        "value": {
          "subreddit": "programming",
          "title": "My Post Title",
          "type": "self",
          "url": "",
          "is_flair_required": false,
          "flair": null
        }
      }
    ]
  }
}

Fields

FieldTypeRequiredDescription
__typestringYesMust be reddit
subredditarrayYesArray of subreddit configurations

Subreddit Object

Each item in the subreddit array contains a value object with:
FieldTypeRequiredDescription
subredditstringYesSubreddit name (without r/)
titlestringYesPost title (min 2 characters)
typestringYesPost type
urlstringConditionalURL for link posts
is_flair_requiredbooleanYesWhether flair is required
flairobjectConditionalFlair object (required if is_flair_required is true)

type (Post Type)

ValueDescription
selfText post (uses content from post value)
linkLink post (requires url field)
imageImage post
videoVideo post

Flair Object

Required when is_flair_required is true:
{
  "flair": {
    "id": "flair-template-id",
    "name": "Discussion"
  }
}

Complete Example

Text Post (Self Post)

{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-reddit-integration-id"
      },
      "value": [
        {
          "content": "I've been working on this project for the past few months and wanted to share my experience.\n\n## What I learned\n\n1. Planning is crucial\n2. Start small\n3. Iterate quickly\n\nWhat are your thoughts?",
          "image": []
        }
      ],
      "settings": {
        "__type": "reddit",
        "subreddit": [
          {
            "value": {
              "subreddit": "programming",
              "title": "My journey building a side project - lessons learned",
              "type": "self",
              "url": "",
              "is_flair_required": false,
              "flair": null
            }
          }
        ]
      }
    }
  ]
}

Link Post

{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-reddit-integration-id"
      },
      "value": [
        {
          "content": "",
          "image": []
        }
      ],
      "settings": {
        "__type": "reddit",
        "subreddit": [
          {
            "value": {
              "subreddit": "technology",
              "title": "Interesting article about AI developments",
              "type": "link",
              "url": "https://example.com/ai-article",
              "is_flair_required": false,
              "flair": null
            }
          }
        ]
      }
    }
  ]
}

Post with Required Flair

{
  "type": "schedule",
  "date": "2024-12-14T10:00:00.000Z",
  "shortLink": false,
  "tags": [],
  "posts": [
    {
      "integration": {
        "id": "your-reddit-integration-id"
      },
      "value": [
        {
          "content": "Looking for advice on my situation...",
          "image": []
        }
      ],
      "settings": {
        "__type": "reddit",
        "subreddit": [
          {
            "value": {
              "subreddit": "personalfinance",
              "title": "Need advice on budgeting",
              "type": "self",
              "url": "",
              "is_flair_required": true,
              "flair": {
                "id": "abc123-flair-id",
                "name": "Budgeting"
              }
            }
          }
        ]
      }
    }
  ]
}

Cross-post to Multiple Subreddits

{
  "settings": {
    "__type": "reddit",
    "subreddit": [
      {
        "value": {
          "subreddit": "webdev",
          "title": "New CSS feature just dropped!",
          "type": "link",
          "url": "https://example.com/css-news",
          "is_flair_required": false,
          "flair": null
        }
      },
      {
        "value": {
          "subreddit": "frontend",
          "title": "New CSS feature just dropped!",
          "type": "link",
          "url": "https://example.com/css-news",
          "is_flair_required": false,
          "flair": null
        }
      }
    ]
  }
}
Tip: You can post to multiple subreddits simultaneously by adding multiple objects to the subreddit array.