Provider-Specific Settings

The Postiz CLI supports platform-specific settings for each integration. Different platforms have different options and requirements.

How to Use Provider Settings

Method 1: Command Line Flags

postiz posts:create \
  -c "Your content" \
  -p <provider-type> \
  --settings '<json-settings>' \
  -i "integration-id"

Method 2: JSON File

postiz posts:create --json post-with-settings.json

In the JSON file, specify settings per integration:

{
  "type": "now",
  "date": "2024-01-15T12:00:00Z",
  "shortLink": true,
  "tags": [],
  "posts": [{
    "integration": { "id": "reddit-123" },
    "value": [{ "content": "Post content", "image": [] }],
    "settings": {
      "__type": "reddit",
      "subreddit": [{
        "value": {
          "subreddit": "programming",
          "title": "My Post Title",
          "type": "text",
          "url": "",
          "is_flair_required": false
        }
      }]
    }
  }]
}

Supported Platforms & Settings

Reddit (`reddit`)

Settings:

subreddit (required): Subreddit name
title (required): Post title
type (required): "text" or "link"
url (required for links): URL if type is "link"
is_flair_required (boolean): Whether flair is required
flair (optional): Flair object with id and name

Example:

postiz posts:create \
  -c "Post content here" \
  -p reddit \
  --settings '{
    "subreddit": [{
      "value": {
        "subreddit": "programming",
        "title": "Check out this cool project",
        "type": "text",
        "url": "",
        "is_flair_required": false
      }
    }]
  }' \
  -i "reddit-123"

YouTube (`youtube`)

Settings:

title (required): Video title (2-100 characters)
type (required): "public", "private", or "unlisted"
selfDeclaredMadeForKids (optional): "yes" or "no"
thumbnail (optional): Thumbnail MediaDto object
tags (optional): Array of tag objects with value and label

Example:

postiz posts:create \
  -c "Video description here" \
  -p youtube \
  --settings '{
    "title": "My Awesome Video",
    "type": "public",
    "selfDeclaredMadeForKids": "no",
    "tags": [
      {"value": "tech", "label": "Tech"},
      {"value": "tutorial", "label": "Tutorial"}
    ]
  }' \
  -i "youtube-123"

X / Twitter (`x`)

Settings:

community (optional): X community URL (format: https://x.com/i/communities/1234567890)
who_can_reply_post (required): Who can reply
- "everyone" - Anyone can reply
- "following" - Only people you follow
- "mentionedUsers" - Only mentioned users
- "subscribers" - Only subscribers
- "verified" - Only verified users

Example:

postiz posts:create \
  -c "Tweet content" \
  -p x \
  --settings '{
    "who_can_reply_post": "everyone"
  }' \
  -i "twitter-123"

With Community:

postiz posts:create \
  -c "Community tweet" \
  -p x \
  --settings '{
    "community": "https://x.com/i/communities/1493446837214187523",
    "who_can_reply_post": "everyone"
  }' \
  -i "twitter-123"

LinkedIn (`linkedin`)

Settings:

post_as_images_carousel (boolean): Post as image carousel
carousel_name (optional): Carousel name if posting as carousel

Example:

postiz posts:create \
  -c "LinkedIn post" \
  -m "img1.jpg,img2.jpg,img3.jpg" \
  -p linkedin \
  --settings '{
    "post_as_images_carousel": true,
    "carousel_name": "Product Showcase"
  }' \
  -i "linkedin-123"

Instagram (`instagram`)

Settings:

post_type (required): "post" or "story"
is_trial_reel (optional): Boolean
graduation_strategy (optional): "MANUAL" or "SS_PERFORMANCE"
collaborators (optional): Array of collaborator objects with label

Example:

postiz posts:create \
  -c "Instagram post" \
  -m "photo.jpg" \
  -p instagram \
  --settings '{
    "post_type": "post",
    "is_trial_reel": false
  }' \
  -i "instagram-123"

Story Example:

postiz posts:create \
  -c "Story content" \
  -m "story-image.jpg" \
  -p instagram \
  --settings '{
    "post_type": "story"
  }' \
  -i "instagram-123"

TikTok (`tiktok`)

Settings:

title (optional): Video title (max 90 characters)
privacy_level (required): Privacy level
- "PUBLIC_TO_EVERYONE"
- "MUTUAL_FOLLOW_FRIENDS"
- "FOLLOWER_OF_CREATOR"
- "SELF_ONLY"
duet (boolean): Allow duets
stitch (boolean): Allow stitch
comment (boolean): Allow comments
autoAddMusic (required): "yes" or "no"
brand_content_toggle (boolean): Brand content toggle
brand_organic_toggle (boolean): Brand organic toggle
video_made_with_ai (optional): Boolean
content_posting_method (required): "DIRECT_POST" or "UPLOAD"

Example:

postiz posts:create \
  -c "TikTok video description" \
  -m "video.mp4" \
  -p tiktok \
  --settings '{
    "title": "Check this out!",
    "privacy_level": "PUBLIC_TO_EVERYONE",
    "duet": true,
    "stitch": true,
    "comment": true,
    "autoAddMusic": "no",
    "brand_content_toggle": false,
    "brand_organic_toggle": false,
    "content_posting_method": "DIRECT_POST"
  }' \
  -i "tiktok-123"