# Create a new item in the queue POST https://services.leadconnectorhq.com/social-media-posting/category/queues/{queueId}/create/item Adds a new post item to a queue. Use sessionId for edit session or directToQueue for immediate addition. ## Authentication Send `Authorization: Bearer ` using: - **Sub-Account token: OAuth access token or Private Integration Token.** Scopes: `socialplanner/category.write` ## Parameters ### Header Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `Version` | string | Yes | API Version | ### Path Parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `queueId` | string | Yes | Category queue ID | ## OpenAPI Specification ```json { "openapi": "3.0.0", "info": { "title": "LeadConnector API", "version": "v3" }, "servers": [ { "url": "https://services.leadconnectorhq.com" } ], "paths": { "/social-media-posting/category/queues/{queueId}/create/item": { "post": { "summary": "Create a new item in the queue", "operationId": "createANewItemInTheQueue", "description": "Adds a new post item to a queue. Use sessionId for edit session or directToQueue for immediate addition.", "parameters": [ { "name": "Version", "in": "header", "description": "API Version", "required": true, "schema": { "type": "string", "enum": [ "v3" ] } }, { "name": "queueId", "required": true, "in": "path", "description": "Category queue ID", "schema": { "example": "507f1f77bcf86cd799439011", "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateQueueItemDTO" } } } }, "responses": { "201": { "description": "Queue item created successfully.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WrappedCreateQueueItemResponseDTO" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequestDTO" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnauthorizedDTO" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnprocessableDTO" } } } } }, "security": [ { "bearer": [ "socialplanner/category.write" ] } ] } } }, "components": { "securitySchemes": { "bearer": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.", "type": "http" }, "Location-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Sub-Account.", "type": "http" }, "Agency-Access": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.", "type": "http" }, "Agency-Access-Only": { "scheme": "bearer", "bearerFormat": "JWT", "name": "Authorization", "in": "header", "description": "Use the Access Token generated with user type as Agency.", "type": "http" } }, "schemas": { "CreateQueueItemDTO": { "type": "object", "properties": { "locationId": { "type": "string", "description": "Location ID", "example": "609e126a1c4ae1001291e1b5" }, "sessionId": { "type": "string", "description": "Edit session ID", "example": "60af88475f1b2c001f5d5f4b" }, "modifiedPostPayload": { "description": "New post details", "example": { "summary": "New queued post content", "media": [] }, "allOf": [ { "type": "object", "properties": { "accountIds": { "description": "Account Ids (OAuth only)", "example": [ "aF3KhyL8JIuBwzK3m7Ly_iVrVJ2uoXNF0wzcBzgl5_12554616564525983496" ], "type": "array", "items": { "type": "string" } }, "summary": { "type": "string", "description": "Post Content", "example": "Hello World" }, "media": { "description": "Post Media", "example": [ { "type": "image", "url": "https://example.com/image.jpg" } ], "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Public URL of the media file. Must be a valid, accessible HTTPS URL.", "example": "https://i0.wp.com/www.lifeofanarchitect.com/wp-content/uploads/2021/10/architectural-model-making-stairs.jpg" }, "caption": { "type": "string", "description": "Alt text or caption for the media. Used for accessibility and SEO.", "example": "Caption 1" }, "originalUrl": { "type": "string", "description": "Original media URL before any processing (watermarking/optimization). Set automatically by the system.", "example": "https://storage.googleapis.com/test/test/media/original.jpeg" }, "watermarkedUrl": { "type": "string", "description": "URL of the media after watermarking. Set automatically when watermark is applied.", "example": "https://storage.googleapis.com/test/test/media/watermarked.jpeg" }, "type": { "type": "string", "description": "MIME type of the media file. See Platform Limitations Guide for platform-specific format support.", "example": "image/jpeg", "enum": [ "image/jpeg", "image/jpg", "image/png", "image/gif", "video/mp4", "video/mov", "video/webm" ] }, "thumbnail": { "type": "string", "description": "Cover image URL for a video media item.\n\n**Scope**\n- Applies to the **first video** in `media[]`. Values supplied on subsequent video items are ignored.\n- Has no effect on image-only media items.\n\n**Response behavior**\n- After the post is published, the resolved cover image is surfaced on the post-level `thumbnail` field of the response and is no longer echoed back inside `media[]`. This represents the post's primary cover image and the cover used for the first video.\n\n**Limitations**\n- Per-item thumbnails for multi-video posts are not supported. Each destination network exposes a single cover image per post for the leading video; this matches the behavior of the underlying social platform APIs.\n\n**Format**\n- Provide a publicly accessible JPEG or PNG URL. Animated formats and video URLs are not accepted.\n- Recommended: an image matching the orientation of your video and ≤ 2 MB.", "example": "https://storage.googleapis.com/test/test/media/test.jpeg" }, "defaultThumb": { "type": "string", "description": "Default thumbnail URL, auto-generated from video if not provided.", "example": "https://storage.googleapis.com/test/test/media/default-thumb.jpeg" }, "id": { "type": "string", "description": "Unique identifier for the media item. Used for tracking and referencing.", "example": "media_abc123xyz" }, "optimizedUrl": { "type": "string", "description": "URL of the optimized/compressed media. Set automatically when media optimization is enabled.\n\n**Enable Optimization:** Set `mediaOptimization: true` in the post request.", "example": "https://storage.googleapis.com/your-bucket/media/optimized-image.jpg" }, "optimizedType": { "type": "string", "description": "MIME type of the optimized media. May differ from original if format conversion occurred.", "example": "image/jpeg" }, "isModified": { "type": "boolean", "description": "Flag indicating if the media was modified (watermarked, optimized, or processed).", "example": true }, "altText": { "type": "string", "description": "Alt text for accessibility. Supported on Instagram, Threads, Pinterest, Bluesky, and LinkedIn image posts (ignored for video and other platforms). Auto-truncated per platform: Pinterest 500, Instagram/Threads 1000, Bluesky 2000, LinkedIn 4086 chars.", "example": "A sunset over the ocean with silhouetted palm trees" } }, "required": [ "url", "type" ], "title": "PostMediaSchema" } }, "status": { "type": "string", "description": "Post status indicating the current state of the post.\n\n**Available Status Values:**\n- `draft` - Post saved as draft, not yet ready for publishing\n- `scheduled` - Post scheduled for future publishing (requires `scheduleDate`)\n- `in_review` - Post pending approval (requires `scheduleDate` and `postApprovalDetails`)\n- `published` - Post has been published\n- `in_progress` - Post is currently being processed\n- `pending` - Post is awaiting platform processing for Instagram media container creation\n- `failed` - Post publishing failed\n- `notification_sent` - Story notification sent (for manual story posting)\n- `deleted` - Post has been deleted\n\n**Validations:**\n- `scheduled` or `in_review` status requires `scheduleDate` to be set\n- Submitting for review (`in_review`) requires `postApprovalDetails.approver`; approve/reject actions reuse the stored approver\n- Draft posts skip most validations (accountIds, media requirements)", "example": "draft", "enum": [ "draft", "scheduled", "in_review", "published", "in_progress", "pending", "failed", "notification_sent", "deleted" ] }, "scheduleDate": { "type": "string", "description": "Schedule Date. Required when `status` is `scheduled` or `in_review`.", "example": "2024-01-15T10:00:00Z" }, "selectedBestTime": { "type": "string", "description": "Selected Best Time slot for scheduling", "example": "2024-01-15T10:00:00Z" }, "createdBy": { "type": "string", "description": "User ID of the creator who is creating/managing the post. Must be a valid 24-character hex ID.\n\n**Get User IDs from:** [Get User API](/users/{userId}) — use the `id` field from the user object.\n\n**Validation:** Must be a valid 24-character hex ID.", "example": "65f151c99bc2bf3aaf970d72" }, "followUpComment": { "type": "string", "description": "Follow-up comment to be posted immediately after the main post is published.\n\n**Supported Platforms:** Facebook, Instagram, LinkedIn, Community, Threads, Bluesky, YouTube, TikTok\n\n**NOT Supported:** GBP (Google Business Profile), Pinterest\n\n- TikTok: posted once the video becomes publicly viewable (~1-3 min), not instantly\n\n- TikTok: only public videos support a follow-up comment. Set `privacyLevel` to `PUBLIC_TO_EVERYONE` — friends-only and private videos are not supported\n\n**Use Case:** Great for adding hashtags, additional context, or engagement prompts without cluttering the main post.\n\n- Like `summary`, the follow-up comment is trimmed to the **strictest** limit among the post's platforms, not to each platform's own limit — a post that includes Bluesky (300) trims the comment to 300 everywhere. Send one request per platform to keep the full comment on each.\n\n**Reference:** [Platform Limitations Guide](https://help.leadconnectorhq.com/support/solutions/articles/48001240003-social-planner-image-video-content-and-api-limitations)", "example": "What do you think? Let us know in the comments!" }, "ogTagsDetails": { "description": "Og Tags Meta Data", "example": { "metaImage": "https://example.com/image.jpg", "metaLink": "https://www.yahoo.com/", "ogTitle": "Page Title", "ogDescription": "Page Description" }, "allOf": [ { "type": "object", "properties": { "metaImage": { "type": "string", "description": "Preview image URL for the shared link.\n\n**Best Practices:**\n- Use high-quality images (1200x630px recommended)\n- Ensure the image is publicly accessible\n\n**Auto-fetch:** Use the Get Metatags API to fetch OG data from a URL.", "example": "https://yoursite.com/images/og-image.jpg" }, "metaLink": { "type": "string", "description": "URL of the webpage being shared. This is the destination when users click the link preview.", "example": "https://yoursite.com/blog/amazing-article" }, "ogTitle": { "type": "string", "description": "Custom title for the link preview. Overrides the page's og:title meta tag.\n\n**Tip:** Keep titles concise (50-60 characters) for best display across platforms.", "example": "How to Double Your Social Media Engagement" }, "ogDescription": { "type": "string", "description": "Custom description for the link preview. Overrides the page's og:description meta tag.\n\n**Tip:** Keep descriptions under 155 characters for optimal display.", "example": "Learn proven strategies to boost your social media engagement and grow your audience." } }, "title": "OgTagsSchema" } ] }, "type": { "type": "string", "description": "Post Type must be one of the following values: post, story, reel, short", "example": "post", "enum": [ "post", "story", "reel" ] }, "postApprovalDetails": { "description": "Post Approval Details", "example": { "approver": "iVrVJ2uoXNF0wzcBzgl5", "approvalStatus": "pending" }, "allOf": [ { "type": "object", "properties": { "approver": { "type": "string", "description": "User ID of the designated approver.\n\n**Note:** The approver will receive a notification when a post is submitted for review.", "example": "iVrVJ2uoXNF0wzcBzgl5" }, "requesterNote": { "type": "string", "description": "Note from the post creator to the approver explaining the post or requesting specific feedback.", "example": "Please review the messaging for our Q4 campaign launch. Let me know if the CTA needs adjustment." }, "approverNote": { "type": "string", "description": "Note from the approver to the post creator with feedback or approval comments.", "example": "Approved! Great content. Consider adding more hashtags for visibility." }, "approvalStatus": { "type": "string", "description": "Current approval status of the post.\n\n**Available Values:**\n- `pending` - Awaiting approver review\n- `approved` - Approved and ready for publishing\n- `rejected` - Rejected by approver (needs revision)\n- `not_required` - No approval workflow needed", "example": "pending", "enum": [ "pending", "approved", "rejected", "not_required" ] } }, "title": "PostApprovalSchema" } ] }, "scheduleTimeUpdated": { "type": "boolean", "description": "Flag indicating if the schedule datetime was manually updated. Used for tracking rescheduled posts.", "example": true }, "tags": { "description": "Array of Tag IDs to associate with the post for organization and filtering.\n\n**Get Tag IDs from:** [Get Tags API](/social-media-posting/{locationId}/tags) — use the `_id` field from each tag.\n\n**Validation:** All IDs must be valid 24-character hex IDs.", "example": [ "65f151c99bc2bf3aaf970d72", "65f151c99bc2bf3aaf970d73" ], "type": "array", "items": { "type": "string" } }, "categoryId": { "type": "string", "description": "Category ID to organize the post. Categories help group related posts.\n\n**Get Category IDs from:** [Get Categories API](/social-media-posting/{locationId}/categories) — use the `_id` field.\n\n**Validation:** Must be a valid 24-character hex ID.", "example": "65f151c99bc2bf3aaf970d72" }, "applyWatermark": { "type": "boolean", "description": "Apply watermark to media in this post.\n\n**Note:** Watermarks are applied to images only. Videos are not watermarked.", "example": true }, "tiktokPostDetails": { "description": "Tiktok Post Details", "example": { "privacyLevel": "PUBLIC_TO_EVERYONE", "disableDuet": false, "disableStitch": false, "disableComment": false }, "allOf": [ { "type": "object", "properties": { "privacyLevel": { "type": "string", "description": "Privacy level controlling who can view the video.\n\n**Available Values:**\n- `PUBLIC_TO_EVERYONE` - Anyone can view (default)\n- `MUTUAL_FOLLOW_FRIENDS` - Only mutual followers can view\n- `SELF_ONLY` - Only you can view (private)\n\n**Note:** If set to `SELF_ONLY`, `videoDisclosure` must be `false`.", "example": "PUBLIC_TO_EVERYONE", "enum": [ "PUBLIC_TO_EVERYONE", "MUTUAL_FOLLOW_FRIENDS", "SELF_ONLY" ] }, "promoteOtherBrand": { "type": "boolean", "description": "Indicates if the video promotes a third-party brand or product.\n\n**Required:** Must be `true` if `videoDisclosure` is enabled and you're promoting another brand.", "example": false }, "enableComment": { "type": "boolean", "description": "Allow users to comment on the video. Default is determined by account settings.", "example": true }, "enableDuet": { "type": "boolean", "description": "Allow users to create Duet videos with your content.\n\n**Duet:** Side-by-side video featuring your content and the creator's reaction/addition.", "example": true }, "enableStitch": { "type": "boolean", "description": "Allow users to create Stitch videos with your content.\n\n**Stitch:** Clips up to 5 seconds of your video that creators can use in their own videos.", "example": true }, "videoDisclosure": { "type": "boolean", "description": "Enable branded content disclosure. Required when video is promotional content.\n\n**Validations:**\n- Cannot be `true` if `privacyLevel` is `SELF_ONLY`\n- If enabled, at least one of `promoteYourBrand` or `promoteOtherBrand` must be `true`", "example": false }, "promoteYourBrand": { "type": "boolean", "description": "Indicates if the video promotes your own brand or product.\n\n**Required:** Must be `true` if `videoDisclosure` is enabled and you're promoting your own brand.", "example": false } }, "title": "TiktokPostSchema" } ] }, "gmbPostDetails": { "description": "GMB Post Details", "example": { "topicType": "STANDARD" }, "allOf": [ { "type": "object", "properties": { "gmbEventType": { "type": "string", "description": "Google My Business post type.\n\n**Available Types:**\n- `STANDARD` - Regular update post (What's New)\n- `EVENT` - Event announcement with dates and title\n- `OFFER` - Promotional offer with coupon and redemption details\n\n**Required fields by type:**\n- STANDARD: None additional\n- EVENT: `title`, `startDate`, `endDate`\n- OFFER: `offerTitle`, `startDate`, `endDate`, `termsConditions`, `couponCode`, `redeemOnlineUrl`", "example": "STANDARD", "enum": [ "STANDARD", "EVENT", "OFFER" ] }, "title": { "type": "string", "description": "Event title. Required when `gmbEventType` is `EVENT`.\n\n**Max length:** 58 characters", "example": "Summer Sale Event 2024" }, "offerTitle": { "type": "string", "description": "Offer title. Required when `gmbEventType` is `OFFER`.", "example": "50% Off All Products" }, "startDate": { "description": "Start date and time for EVENT or OFFER posts.\n\n**Required:** When `gmbEventType` is `EVENT` or `OFFER`.\n\n**Structure:**\n- `startDate`: { year, month, day }\n- `startTime`: { hours, minutes, seconds }", "example": { "startDate": { "year": 2024, "month": 1, "day": 15 }, "startTime": { "hours": 10, "minutes": 0, "seconds": 0 } }, "allOf": [ { "type": "object", "properties": { "startDate": { "description": "Start Date", "example": { "year": 2024, "month": 1, "day": 15 }, "allOf": [ { "type": "object", "properties": { "year": { "type": "number", "description": "Year component of the date", "example": 2022 }, "month": { "type": "number", "description": "Month component of the date (1-12)", "example": 1 }, "day": { "type": "number", "description": "Day component of the date (1-31)", "example": 1 } }, "required": [ "year", "month", "day" ], "title": "DateSchema" } ] }, "startTime": { "description": "Start Time", "example": { "hours": 10, "minutes": 30, "seconds": 0 }, "allOf": [ { "type": "object", "properties": { "hours": { "type": "number", "description": "Hour component of the time (0-23)", "example": 23 }, "minutes": { "type": "number", "description": "Minute component of the time (0-59)", "example": 56 }, "seconds": { "type": "number", "description": "Second component of the time (0-59)", "example": 34 } }, "required": [ "hours", "minutes", "seconds" ], "title": "TimeSchema" } ] } }, "title": "StartDateSchema" } ] }, "endDate": { "description": "End date and time for EVENT or OFFER posts.\n\n**Required:** When `gmbEventType` is `EVENT` or `OFFER`.\n**Validation:** Must be after `startDate`.\n\n**Structure:**\n- `endDate`: { year, month, day }\n- `endTime`: { hours, minutes, seconds }", "example": { "endDate": { "year": 2024, "month": 1, "day": 20 }, "endTime": { "hours": 18, "minutes": 0, "seconds": 0 } }, "allOf": [ { "type": "object", "properties": { "endDate": { "description": "End Date", "example": { "year": 2024, "month": 1, "day": 20 }, "allOf": [ { "type": "object", "properties": { "year": { "type": "number", "description": "Year component of the date", "example": 2022 }, "month": { "type": "number", "description": "Month component of the date (1-12)", "example": 1 }, "day": { "type": "number", "description": "Day component of the date (1-31)", "example": 1 } }, "required": [ "year", "month", "day" ], "title": "DateSchema" } ] }, "endTime": { "description": "End Time", "example": { "hours": 18, "minutes": 0, "seconds": 0 }, "allOf": [ { "type": "object", "properties": { "hours": { "type": "number", "description": "Hour component of the time (0-23)", "example": 23 }, "minutes": { "type": "number", "description": "Minute component of the time (0-59)", "example": 56 }, "seconds": { "type": "number", "description": "Second component of the time (0-59)", "example": 34 } }, "required": [ "hours", "minutes", "seconds" ], "title": "TimeSchema" } ] } }, "title": "EndDateSchema" } ] }, "termsConditions": { "type": "string", "description": "URL to terms and conditions page. Required for OFFER posts.", "example": "https://yoursite.com/terms-and-conditions" }, "url": { "type": "string", "description": "Call-to-action URL. Required when `actionType` is set (except `none` and `call`).\n\n**Required for:** STANDARD and EVENT posts with actionType other than `none` or `call`.", "example": "https://yoursite.com/book-now" }, "couponCode": { "type": "string", "description": "Promotional coupon code. Required for OFFER posts.", "example": "SAVE50" }, "redeemOnlineUrl": { "type": "string", "description": "URL where customers can redeem the offer online. Required for OFFER posts.", "example": "https://yoursite.com/redeem-offer" }, "actionType": { "type": "string", "description": "Call-to-action button type for the post.\n\n**Available Actions:**\n- `none` - No action button\n- `order` - Order online\n- `book` - Book appointment\n- `shop` - Shop now\n- `learn_more` - Learn more\n- `call` - Call now (no URL required)\n- `sign_up` - Sign up\n\n**Note:** All actions except `none` and `call` require a `url`.", "example": "book", "enum": [ "none", "order", "book", "shop", "learn_more", "call", "sign_up" ] } }, "required": [ "gmbEventType" ], "title": "GMBPostSchema" } ] }, "userId": { "type": "string", "description": "User ID", "example": "sdfdsfdsfEWEsdfsdsW32dd" }, "linkedinPostDetails": { "description": "Linkedin Post Details", "example": { "postAsPdf": false, "pdfTitle": "Q4 Marketing Strategy Presentation" }, "allOf": [ { "type": "object", "properties": { "pdfTitle": { "type": "string", "description": "Title for the PDF document carousel. Displayed as the document name on LinkedIn.\n\n**Max length:** 100 characters\n\n**Tip:** Use a descriptive title that explains the document content.", "example": "Q4 Marketing Strategy Presentation" }, "postAsPdf": { "type": "boolean", "description": "Post images as a PDF document carousel.\n\n**Limits:**\n- Max 300 pages/images\n- Max PDF size: 100 MB", "example": true }, "poll": { "description": "Publish a LinkedIn poll post.\n\n**Required fields when `poll` is supplied:**\n- `question` (max 140 characters)\n- `options`: 2 to 4 entries, each `text` ≤ 30 characters; option texts must be unique\n- `settings.duration`: one of `ONE_DAY`, `THREE_DAYS`, `SEVEN_DAYS`, `FOURTEEN_DAYS`\n\n**LinkedIn restrictions:**\n- Polls cannot be edited after publishing.\n- A poll post cannot include `media` or a meta-link preview.", "example": { "question": "What is your favorite color?", "options": [ { "text": "Blue" }, { "text": "Green" } ], "settings": { "duration": "SEVEN_DAYS" } }, "allOf": [ { "type": "object", "properties": { "question": { "type": "string", "description": "Question for the poll. Max length: 140 characters.", "example": "What is your favorite color?", "maxLength": 140 }, "options": { "description": "Poll options. Minimum 2, maximum 4. Each option text max 30 characters. Option texts must be unique.", "minItems": 2, "maxItems": 4, "example": [ { "text": "Blue" }, { "text": "Green" } ], "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "Text describing the option. Max length: 30 characters.", "example": "Red", "maxLength": 30 } }, "required": [ "text" ], "title": "LinkedinPollOptionDto" } }, "settings": { "description": "Poll settings (duration).", "example": { "duration": "SEVEN_DAYS" }, "allOf": [ { "type": "object", "properties": { "duration": { "type": "string", "description": "Duration the poll stays open for votes.", "enum": [ "ONE_DAY", "THREE_DAYS", "SEVEN_DAYS", "FOURTEEN_DAYS" ], "example": "SEVEN_DAYS" } }, "required": [ "duration" ], "title": "LinkedinPollSettingsDto" } ] } }, "required": [ "question", "options", "settings" ], "title": "LinkedinPollDto" } ] } }, "title": "LinkedinPostSchema" } ] }, "pinterestPostDetails": { "description": "Pinterest Post Details", "example": { "title": "New collection", "link": "https://example.com", "boardIds": { "account_123": "board_123" } }, "allOf": [ { "type": "object", "properties": { "title": { "type": "string", "description": "Pin title displayed on Pinterest.\n\n**Max length:** 100 characters\n\n**Best Practices:**\n- Include relevant keywords\n- Be descriptive and engaging", "example": "10 Easy Home Decor Ideas for 2024" }, "link": { "type": "string", "description": "Destination URL for the pin. Users clicking the pin will be directed to this URL.\n\n**Max length:** 2048 characters\n\n**Best Practices:**\n- Use direct links to relevant content\n- Track with UTM parameters for analytics", "example": "https://yoursite.com/blog/home-decor-ideas" }, "boardIds": { "type": "object", "deprecated": true, "description": "**DEPRECATED — use `pinterestBoards` instead.** Will be removed on July 31, 2026.\n\nLegacy mapping of Pinterest account OAuth IDs to a single board ID:\n`{ accountOAuthId: \"boardId\" }`\n\nFor multi-board posting, use `pinterestBoards`.", "additionalProperties": { "type": "string" }, "example": { "6887d6de1d8175813d50dab8": "987654321098765432" } }, "pinterestBoards": { "description": "Per-account Pinterest board selection. Each entry binds one connected Pinterest account to a list of boards on that account. Each board produces an independent child post tracked separately for success/failure. Capped at 25 boards per account.\n\nWhen supplied, this field takes precedence over the deprecated `boardIds` field.", "example": [ { "accountId": "6887d6de1d8175813d50dab8", "boards": [ "987654321098765432", "234567890123456789" ] }, { "accountId": "682c7d1710a2fe3d805a3513", "boards": [ "111222333444555666" ] } ], "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string", "description": "Connected Pinterest account ID. Must match one of the accounts referenced in the post's `userIds`.", "example": "6887d6de1d8175813d50dab8" }, "boards": { "description": "Pinterest board IDs to publish to on this account. Each board produces an independent child post tracked separately for success/failure. Capped at 25 boards per account.", "example": [ "987654321098765432", "234567890123456789" ], "type": "array", "items": { "type": "string" } } }, "required": [ "accountId", "boards" ], "title": "PinterestBoardSelection" } }, "shortenedLinks": { "description": "Shortened links for the post (auto-generated).", "example": [ { "originalUrl": "https://example.com", "shortenedUrl": "https://short.link/abc" } ], "type": "array", "items": { "type": "string" } } }, "title": "PinterestPostSchema" } ] }, "facebookPostDetails": { "description": "Facebook Post Details", "example": { "postType": "feed" }, "allOf": [ { "type": "object", "properties": { "type": { "type": "string", "description": "Facebook post format type.\n\n**Available Types:**\n- `post` - Standard feed post (images, videos, text)\n- `story` - 24-hour temporary story\n- `reel` - Short-form vertical video\n\n**Restrictions:**\n- Reels: Require exactly 1 video, not supported on Groups\n- Stories: Captions not supported", "example": "post", "enum": [ "post", "story", "reel" ] }, "textFormatPresetId": { "type": "string", "description": "Facebook background preset ID for text-only feed posts. **Facebook `post` only** — not `story` or `reel`. Ignored when media is attached; `metaLink` is omitted on publish.\n\n**Validations** — request returns `400` if violated:\n- Must be a valid preset ID from the [Facebook text background preset reference](https://help.leadconnectorhq.com/support/solutions/articles/155000008005-facebook-text-background-posts-preset-reference). Empty strings, whitespace-only values, and `null` are rejected.\n- When set, `summary` must be 130 characters or fewer.", "example": "303063890126415" } }, "required": [ "type" ], "title": "FacebookPostSchema" } ] }, "instagramPostDetails": { "description": "Instagram Post Details", "example": { "type": "post", "collaborators": [] }, "allOf": [ { "type": "object", "properties": { "type": { "type": "string", "description": "Instagram post format type.\n\n**Available Types:**\n- `post` - Standard feed post (images, videos, carousels)\n- `story` - 24-hour temporary story\n- `reel` - Short-form vertical video (up to 90 seconds)\n\n**Restrictions:**\n- Media is REQUIRED for all Instagram posts\n- Reels: Require exactly 1 video\n- Stories: Captions not supported, JPEG only for images", "example": "post", "enum": [ "post", "story", "reel" ] }, "collaborators": { "type": "object", "description": "Collaboration invites mapping account IDs to Instagram usernames.\n\n**Structure:** `{ accountId: [username1, username2, username3] }`\n\n- **Key:** Account ID from `accountIds` array (the Instagram account posting)\n- **Value:** Array of Instagram usernames to invite as collaborators\n\n**Get Account IDs from:** [Get Accounts API](/social-media-posting/oauth/{locationId}/accounts) — use the `id` field from Instagram accounts.\n\n**✅ Supported for:** Posts and Reels only (NOT Stories)\n\n**Validations:**\n- Maximum 5 collaborators per account\n- No duplicate usernames allowed\n- Usernames are Instagram handles without @\n\n**Use Case:** Invite other Instagram users to collaborate. Once accepted, the post appears on both profiles.", "example": { "640ab864e8e47e7f8a186425_hE998piDgAGZDY1xzmFD_17841453046826624": [ "influencer_username", "partner_brand" ] } }, "publishViaPushNotification": { "type": "boolean", "description": "Send Instagram Story via Push Notification instead of direct posting. Only applicable for Story type.", "example": true }, "publisherNote": { "type": "string", "description": "Note to the publisher for manual posting guidance. Only used when publishViaPushNotification is true.", "example": "When publishing, add swipe up link to the landing page so that we can direct them to the sales page" }, "notificationSentCount": { "type": "number", "description": "Number of push notifications sent for this Instagram Story. Tracks how many notifications have been sent out.", "example": 1 }, "postedVia": { "type": "string", "description": "Source of where the post was marked as published. Values: \"web\" (web interface), \"mobile\" (mobile app), or null.", "example": "web", "enum": [ "web", "mobile" ] }, "showOnFeed": { "type": "boolean", "description": "Show Reel on profile grid/feed.\n\n**✅ Applies to:** Reels only\n\n- `true` - Reel appears on your profile grid\n- `false` - Reel only appears in Reels tab", "example": true } }, "required": [ "type" ], "title": "InstagramPostSchema" } ] }, "youtubePostDetails": { "description": "Youtube Post Details", "example": { "title": "Product walkthrough", "description": "A short product walkthrough video." }, "allOf": [ { "type": "object", "properties": { "title": { "type": "string", "description": "Video title displayed on YouTube.\n\n**Max length:** 100 characters\n\n**Best Practices:**\n- Include relevant keywords\n- Be descriptive but concise\n- Avoid clickbait", "example": "How to Build a Successful Marketing Strategy in 2024" }, "privacyLevel": { "type": "string", "description": "Video visibility/privacy setting.\n\n**Available Values:**\n- `public` - Anyone can search and view\n- `unlisted` - Only people with the link can view\n- `private` - Only you can view", "example": "public", "enum": [ "private", "public", "unlisted" ] }, "type": { "type": "string", "description": "YouTube video format type.\n\n**Available Types:**\n- `video` - Standard YouTube video (landscape, any duration)\n- `short` - YouTube Shorts (vertical, up to 60 seconds)\n\n**Required field.**", "example": "video", "enum": [ "video", "short" ] } }, "required": [ "type" ], "title": "YoutubePostSchema" } ] }, "communityPostDetails": { "description": "Community-specific post configuration for Communities.\n\n**Required Fields:**\n- `title`: Post title (max 1,000 characters)\n- `postAsUser`: the member to publish as, keyed by Community account ID\n\n**Optional Fields:**\n- `notifyAllGroupMembers`: notify all group members (`@everyone` broadcast)\n\n**Limits:**\n- Max 4 media items\n- Caption max 100,000 characters\n\n**Required when** `accountIds` contains a Community account and the post is not a draft.", "example": { "title": "Welcome to our community!", "notifyAllGroupMembers": false, "postAsUser": { "aF3KhyL8JIuBwzK3m7Ly_iVrVJ2uoXNF0wzcBzgl5_12554616564525983496": { "id": "YBjxnYiXJKmoyV7WDjjG", "name": "Jane Cooper" } } }, "allOf": [ { "type": "object", "properties": { "title": { "type": "string", "description": "Title of the community post. Displayed as the post headline.\n\n**Max length:** 1,000 characters\n\n**Required:** Yes, for all Community posts.", "example": "Welcome to Our New Community Feature!" }, "notifyAllGroupMembers": { "type": "boolean", "description": "Notify every member of the group when the post is published, equivalent to an `@everyone` broadcast prepended to the post content.\n\n**Use Case:** Enable for announcements that all members should see.\n\n**Default:** `false`", "example": true }, "postAsUser": { "type": "object", "description": "The Community member each post is published as, keyed by Community account ID.\n\n**Structure:** `{ accountId: { id, name, avatar } }`\n\n- **Key** — the Community account ID. This is the same value you pass in `accountIds`: take it from the `id` field of a Community account in the Get Accounts API, not the `oauthId` field.\n- `id` (required) — `contactId` of the member to publish as, from the Get Community Members API.\n- `name` (optional) — display name shown as the post author.\n- `avatar` (optional) — profile image URL shown against the post.\n\n**Required:** Yes. Every Community account listed in `accountIds` must have an entry here, otherwise the request is rejected.\n\n**Member eligibility:** the member must be an active member of the group and hold a role in it. This is checked again at publish time, so a member who leaves the group or loses access between scheduling and publishing causes that post to fail. Use the Validate Community Member API to confirm a stored member is still eligible before scheduling.\n\n**Private channels:** list members per account rather than reusing one list across accounts — for a private channel only that channel's members may be posted as.", "example": { "aF3KhyL8JIuBwzK3m7Ly_iVrVJ2uoXNF0wzcBzgl5_12554616564525983496": { "avatar": "https://storage.googleapis.com/revex-communities/avatars/jane.png", "id": "YBjxnYiXJKmoyV7WDjjG", "name": "Jane Cooper" } } } }, "required": [ "title", "postAsUser" ], "title": "CommunityPostSchema" } ] }, "locationId": { "type": "string", "description": "Location Id", "example": "ve9EPM428h8vShlRW1KT" } }, "title": "QueueModifiedPostDTO" } ] }, "order": { "description": "Order for the new item in the queue (cyclic-aware). Accepts:\n- A number: explicit order value calculated by FE as midpoint between adjacent items\n- \"top\": place at cyclic top (first to be scheduled next)\n- \"bottom\": place at cyclic bottom (last to be scheduled)\n\nFor positions between items, FE calculates: Math.floor((prevItem.order + nextItem.order) / 2)\nDefaults to end if not provided. Note: This field is ignored when directToQueue is true -\nthe order will be automatically calculated based on the queue's prioritizeNewContent setting.", "example": "top", "oneOf": [ { "type": "number" }, { "type": "string" } ] }, "variations": { "description": "Variations", "example": [ { "content": "Try this variation", "mentions": [], "ogTags": { "metaLink": "https://example.com" } } ], "type": "array", "items": { "type": "object", "properties": { "content": { "type": "string", "description": "The text content of the variation.", "example": "Check out our latest blog post! #marketing #socialmedia" }, "mentions": { "description": "Platform-specific mentions within the content (e.g., @username references).", "example": [ { "platform": "instagram", "username": "example_user", "offset": 10, "length": 12 } ], "type": "array", "items": { "type": "object" } }, "ogTags": { "description": "Open Graph tags for link previews.", "example": { "metaLink": "https://example.com", "ogTitle": "Article Title" }, "allOf": [ { "type": "object", "properties": { "metaLink": { "type": "string", "description": "The canonical URL of the content for link preview.", "example": "https://example.com/blog/post-title" }, "metaImage": { "type": "string", "description": "URL of the image to display in link preview.", "example": "https://example.com/images/preview.png" }, "ogTitle": { "type": "string", "description": "Title to display in link preview.", "example": "Check out our latest blog post!" } }, "title": "OgTagsInputDTO" } ] } }, "title": "VariationInputDTO" } }, "primaryImage": { "type": "string", "description": "Primary media URL (image) for the post. Falls back to modifiedPostPayload.primaryImage if not set.", "example": "http://example.com/media.png" }, "directToQueue": { "type": "boolean", "description": "When true, creates the queue item directly without requiring an edit session, even for active/paused queues. The order field is ignored and the item position is determined by the queue's prioritizeNewContent setting: if true, the item is added to the top of the queue; if false, it is added to the bottom.", "example": false } }, "required": [ "locationId" ], "title": "CreateQueueItemDTO" }, "WrappedCreateQueueItemResponseDTO": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Success or Failure", "example": true }, "statusCode": { "type": "number", "description": "Status Code", "example": 201 }, "results": { "description": "Response payload", "example": { "message": "Queue item created successfully", "queueItem": { "_id": "60af88475f1b2c001f5d5f4b", "order": 1000, "variations": [ { "_id": "60af88475f1b2c001f5d5f4c", "content": "Check out our latest blog post! #marketing #socialmedia", "mentions": [ { "platform": "instagram", "username": "example_user", "offset": 10, "length": 12 } ], "ogTags": { "metaLink": "https://example.com", "metaImage": "https://example.com/image.png", "ogTitle": "Example Title" } } ], "primaryImage": "https://example.com/images/post-image.png", "postId": "60af88475f1b2c001f5d5f4d", "post": { "_id": "60af88475f1b2c001f5d5f4d", "summary": "Scheduled queue post", "media": [], "type": "post" }, "errors": [], "scheduledDateTime": "2023-10-15T10:00:00.000Z", "scheduledVariationIndex": 0, "isSkipped": false, "currentVariation": 0 } }, "allOf": [ { "type": "object", "properties": { "message": { "type": "string", "example": "Queue item created successfully", "description": "Message" }, "queueItem": { "description": "The newly created queue item", "example": { "_id": "60af88475f1b2c001f5d5f4b", "order": 1000, "variations": [ { "_id": "60af88475f1b2c001f5d5f4c", "content": "Check out our latest blog post! #marketing #socialmedia", "mentions": [ { "platform": "instagram", "username": "example_user", "offset": 10, "length": 12 } ], "ogTags": { "metaLink": "https://example.com", "metaImage": "https://example.com/image.png", "ogTitle": "Example Title" } } ], "primaryImage": "https://example.com/images/post-image.png", "postId": "60af88475f1b2c001f5d5f4d", "post": { "_id": "60af88475f1b2c001f5d5f4d", "summary": "Scheduled queue post", "media": [], "type": "post" }, "errors": [], "scheduledDateTime": "2023-10-15T10:00:00.000Z", "scheduledVariationIndex": 0, "isSkipped": false, "currentVariation": 0 }, "allOf": [ { "type": "object", "properties": { "_id": { "type": "string", "description": "The unique identifier of the queue item.", "example": "60af88475f1b2c001f5d5f4b" }, "order": { "type": "number", "description": "The order of the item in the queue.", "example": 1000 }, "variations": { "description": "A list of content variations for the post.", "example": [ { "_id": "60af88475f1b2c001f5d5f4c", "content": "Check out our latest blog post! #marketing #socialmedia", "mentions": [ { "platform": "instagram", "username": "example_user", "offset": 10, "length": 12 } ], "ogTags": { "metaLink": "https://example.com", "metaImage": "https://example.com/image.png", "ogTitle": "Example Title" } } ], "type": "array", "items": { "type": "object", "properties": { "_id": { "type": "string", "description": "The ID of the variation.", "example": "60af88475f1b2c001f5d5f4c" }, "content": { "type": "string", "description": "The text content of the variation.", "example": "Check out our latest blog post! #marketing #socialmedia" }, "mentions": { "description": "Platform-specific mentions within the content (e.g., @username references).", "example": [ { "platform": "instagram", "username": "example_user", "offset": 10, "length": 12 } ], "type": "array", "items": { "type": "object" } }, "ogTags": { "description": "Open Graph tags for link previews.", "example": { "metaLink": "https://example.com", "metaImage": "https://example.com/image.png", "ogTitle": "Example Title" }, "allOf": [ { "type": "object", "properties": { "metaLink": { "type": "string", "example": "https://example.com", "description": "The canonical URL of the content." }, "metaImage": { "type": "string", "example": "https://example.com/image.png", "description": "URL of the content's primary image." }, "ogTitle": { "type": "string", "example": "Example Title", "description": "The title of the content." } }, "title": "OgTagsDTO" } ] } }, "title": "VariationDTO" } }, "primaryImage": { "type": "string", "description": "The primary image URL for the post.", "example": "https://example.com/images/post-image.png" }, "lastScheduledTime": { "format": "date-time", "type": "string", "example": null, "description": "Timestamp of the last scheduled post. Always null for a new queue.", "nullable": true }, "queueId": { "type": "string", "description": "The ID of the queue this post belongs to", "example": "60af88475f1b2c001f5d5f4a" }, "postId": { "type": "string", "description": "The ID of the original post, if any.", "example": "60af88475f1b2c001f5d5f4d" }, "modifiedPostPayload": { "description": "The formatted post data modified from original post.", "example": { "_id": "60af88475f1b2c001f5d5f4d", "summary": "Scheduled queue post", "media": [], "type": "post" }, "allOf": [ { "type": "object", "properties": { "_id": { "type": "string", "description": "Unique identifier of the post", "example": "61bb16833b3f2791f9715be2" }, "source": { "type": "string", "description": "source must be one of the following values: composer, recurring, csv", "enum": [ "composer", "csv", "recurring", "review", "rss", "template-library", "category-queue", "native" ], "example": "composer" }, "locationId": { "type": "string", "description": "Location Id", "example": "ve9EPM428h8vShlRW1KT" }, "displayDate": { "format": "date-time", "type": "string", "description": "Display date for the post", "example": "2023-08-02T00:00:00.000Z" }, "createdAt": { "format": "date-time", "type": "string", "description": "Date when the post was created", "example": "2023-08-02T00:00:00.000Z" }, "updatedAt": { "format": "date-time", "type": "string", "description": "Date when the post was last updated", "example": "2023-08-02T00:00:00.000Z" }, "accountId": { "type": "string", "description": "Account Id", "example": "w37swmmLbA02zgqKPpxITe" }, "error": { "type": "string", "description": "Error", "example": "Failed due to auth token" }, "postId": { "type": "string", "description": "Platform-specific post identifier", "example": "323534534435" }, "previewLink": { "type": "string", "description": "Direct link to view the published post on the native platform. Populated once the post is published on a platform that returns a permalink; `null` for posts that are not yet published (draft, scheduled, failed) or on platforms that do not return a link.", "example": "https://www.facebook.com/12345/posts/67890" }, "insights": { "description": "Aggregated engagement metrics for the published post. Populated asynchronously by the insights sync workers for supported platforms (Facebook, Instagram, LinkedIn, YouTube). Absent on posts that have not been synced yet or on platforms where insights are not supported.", "example": { "like": 12, "share": 3, "comment": 5 }, "allOf": [ { "type": "object", "properties": { "like": { "type": "number", "description": "Number of likes on the published post", "example": 12 }, "share": { "type": "number", "description": "Number of shares of the published post", "example": 3 }, "comment": { "type": "number", "description": "Number of comments on the published post", "example": 5 } }, "title": "PostInsightsSchema" } ] }, "publishedAt": { "type": "string", "description": "Date when the post was published", "example": "2021-06-22T05:32:49.463Z" }, "thumbnail": { "type": "string", "description": "Post-level cover image (thumbnail) URL.\n\nFor posts that contain a video, this is the resolved cover image used for the first video in `media[]`. It is set automatically from the `thumbnail` provided on the first video media item at create/edit time, or auto-generated from the video when one is not supplied. Per-item thumbnails inside `media[]` are not retained on the response — the primary cover image lives on this field.", "example": "https://storage.googleapis.com/test/test/media/test.jpeg" }, "accountIds": { "description": "Account Ids", "example": [ "aF3KhyL8JIuBwzK3m7Ly_iVrVJ2uoXNF0wzcBzgl5_12554616564525983496" ], "type": "array", "items": { "type": "string" } }, "summary": { "type": "string", "description": "Content text of the post", "example": "Sample Summary" }, "media": { "description": "Post Media Data \n The limitations of media as per the platforms is provided through the reference link in API description", "example": [ { "url": "https://example.com/image.jpg", "type": "image/jpeg", "caption": "Sample caption" } ], "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "description": "Public URL of the media file. Must be a valid, accessible HTTPS URL.", "example": "https://i0.wp.com/www.lifeofanarchitect.com/wp-content/uploads/2021/10/architectural-model-making-stairs.jpg" }, "caption": { "type": "string", "description": "Alt text or caption for the media. Used for accessibility and SEO.", "example": "Caption 1" }, "originalUrl": { "type": "string", "description": "Original media URL before any processing (watermarking/optimization). Set automatically by the system.", "example": "https://storage.googleapis.com/test/test/media/original.jpeg" }, "watermarkedUrl": { "type": "string", "description": "URL of the media after watermarking. Set automatically when watermark is applied.", "example": "https://storage.googleapis.com/test/test/media/watermarked.jpeg" }, "type": { "type": "string", "description": "MIME type of the media file. See Platform Limitations Guide for platform-specific format support.", "example": "image/jpeg", "enum": [ "image/jpeg", "image/jpg", "image/png", "image/gif", "video/mp4", "video/mov", "video/webm" ] }, "thumbnail": { "type": "string", "description": "Cover image URL for a video media item.\n\n**Scope**\n- Applies to the **first video** in `media[]`. Values supplied on subsequent video items are ignored.\n- Has no effect on image-only media items.\n\n**Response behavior**\n- After the post is published, the resolved cover image is surfaced on the post-level `thumbnail` field of the response and is no longer echoed back inside `media[]`. This represents the post's primary cover image and the cover used for the first video.\n\n**Limitations**\n- Per-item thumbnails for multi-video posts are not supported. Each destination network exposes a single cover image per post for the leading video; this matches the behavior of the underlying social platform APIs.\n\n**Format**\n- Provide a publicly accessible JPEG or PNG URL. Animated formats and video URLs are not accepted.\n- Recommended: an image matching the orientation of your video and ≤ 2 MB.", "example": "https://storage.googleapis.com/test/test/media/test.jpeg" }, "defaultThumb": { "type": "string", "description": "Default thumbnail URL, auto-generated from video if not provided.", "example": "https://storage.googleapis.com/test/test/media/default-thumb.jpeg" }, "id": { "type": "string", "description": "Unique identifier for the media item. Used for tracking and referencing.", "example": "media_abc123xyz" }, "optimizedUrl": { "type": "string", "description": "URL of the optimized/compressed media. Set automatically when media optimization is enabled.\n\n**Enable Optimization:** Set `mediaOptimization: true` in the post request.", "example": "https://storage.googleapis.com/your-bucket/media/optimized-image.jpg" }, "optimizedType": { "type": "string", "description": "MIME type of the optimized media. May differ from original if format conversion occurred.", "example": "image/jpeg" }, "isModified": { "type": "boolean", "description": "Flag indicating if the media was modified (watermarked, optimized, or processed).", "example": true }, "altText": { "type": "string", "description": "Alt text for accessibility. Supported on Instagram, Threads, Pinterest, Bluesky, and LinkedIn image posts (ignored for video and other platforms). Auto-truncated per platform: Pinterest 500, Instagram/Threads 1000, Bluesky 2000, LinkedIn 4086 chars.", "example": "A sunset over the ocean with silhouetted palm trees" } }, "required": [ "url", "type" ], "title": "PostMediaSchema" } }, "status": { "type": "string", "description": "Status must be one of the following values: in_progress, draft, failed, published, scheduled, in_review, notification_sent, pending, deleted", "enum": [ "in_progress", "draft", "failed", "published", "scheduled", "in_review", "notification_sent", "pending", "deleted" ], "example": "published" }, "createdBy": { "type": "string", "description": "User ID who created the post", "example": "Lx1EI6YIgQYMQi0ytFXv" }, "type": { "type": "string", "description": "Post Type must be one of the following values: post, story, reel, short", "enum": [ "post", "story", "reel", "short" ], "example": "post" }, "tags": { "description": "Tag Ids", "example": [ "aF3KhyL8JIuBwzK3m7Ly_iVrVJ2uoXNF0wzcBzgl5_12554616564525983496" ], "type": "array", "items": { "type": "string" } }, "ogTagsDetails": { "description": "Og Tags Meta Data", "example": { "metaImage": "https://example.com/image.jpg", "metaLink": "https://www.yahoo.com/", "ogTitle": "Page Title", "ogDescription": "Page Description" }, "allOf": [ { "type": "object", "properties": { "metaImage": { "type": "string", "description": "Preview image URL for the shared link.\n\n**Best Practices:**\n- Use high-quality images (1200x630px recommended)\n- Ensure the image is publicly accessible\n\n**Auto-fetch:** Use the Get Metatags API to fetch OG data from a URL.", "example": "https://yoursite.com/images/og-image.jpg" }, "metaLink": { "type": "string", "description": "URL of the webpage being shared. This is the destination when users click the link preview.", "example": "https://yoursite.com/blog/amazing-article" }, "ogTitle": { "type": "string", "description": "Custom title for the link preview. Overrides the page's og:title meta tag.\n\n**Tip:** Keep titles concise (50-60 characters) for best display across platforms.", "example": "How to Double Your Social Media Engagement" }, "ogDescription": { "type": "string", "description": "Custom description for the link preview. Overrides the page's og:description meta tag.\n\n**Tip:** Keep descriptions under 155 characters for optimal display.", "example": "Learn proven strategies to boost your social media engagement and grow your audience." } }, "title": "OgTagsSchema" } ] }, "postApprovalDetails": { "description": "Post Approval Details", "example": { "approver": "iVrVJ2uoXNF0wzcBzgl5", "approvalStatus": "approved" }, "allOf": [ { "type": "object", "properties": { "approver": { "type": "string", "description": "User ID of the designated approver.\n\n**Note:** The approver will receive a notification when a post is submitted for review.", "example": "iVrVJ2uoXNF0wzcBzgl5" }, "requesterNote": { "type": "string", "description": "Note from the post creator to the approver explaining the post or requesting specific feedback.", "example": "Please review the messaging for our Q4 campaign launch. Let me know if the CTA needs adjustment." }, "approverNote": { "type": "string", "description": "Note from the approver to the post creator with feedback or approval comments.", "example": "Approved! Great content. Consider adding more hashtags for visibility." }, "approvalStatus": { "type": "string", "description": "Current approval status of the post.\n\n**Available Values:**\n- `pending` - Awaiting approver review\n- `approved` - Approved and ready for publishing\n- `rejected` - Rejected by approver (needs revision)\n- `not_required` - No approval workflow needed", "example": "pending", "enum": [ "pending", "approved", "rejected", "not_required" ] }, "approverUser": { "description": "Approver User Details", "example": { "id": "6284c43d519161e96cc09c13", "title": "Mr", "firstName": "Harry", "lastName": "Spencer", "email": "abc@xyc.com" }, "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "User Id", "example": "6284c43d519161e96cc09c13" }, "title": { "type": "string", "description": "Title", "example": "Mr" }, "firstName": { "type": "string", "description": "First name", "example": "Harry" }, "lastName": { "type": "string", "description": "Last name", "example": "Spencer" }, "profilePhoto": { "type": "string", "description": "Profile photo", "example": "https://storage.googleapis.com/user/kCrjKGHZQ2/profile/1dca8c-61c9-404d-a459-751fbcb.jpeg" }, "phone": { "type": "string", "description": "Phone number", "example": "901111119" }, "email": { "type": "string", "description": "Email Id", "example": "abc@xyc.com" } }, "required": [ "id", "title", "firstName", "lastName", "profilePhoto", "phone", "email" ], "title": "PostUserSchema" } ] } }, "title": "FormatedApprovalDetails" } ] }, "tiktokPostDetails": { "description": "Tiktok Post Details", "example": { "privacyLevel": "PUBLIC_TO_EVERYONE", "enableComment": true }, "allOf": [ { "type": "object", "properties": { "privacyLevel": { "type": "string", "description": "Privacy level controlling who can view the video.\n\n**Available Values:**\n- `PUBLIC_TO_EVERYONE` - Anyone can view (default)\n- `MUTUAL_FOLLOW_FRIENDS` - Only mutual followers can view\n- `SELF_ONLY` - Only you can view (private)\n\n**Note:** If set to `SELF_ONLY`, `videoDisclosure` must be `false`.", "example": "PUBLIC_TO_EVERYONE", "enum": [ "PUBLIC_TO_EVERYONE", "MUTUAL_FOLLOW_FRIENDS", "SELF_ONLY" ] }, "promoteOtherBrand": { "type": "boolean", "description": "Indicates if the video promotes a third-party brand or product.\n\n**Required:** Must be `true` if `videoDisclosure` is enabled and you're promoting another brand.", "example": false }, "enableComment": { "type": "boolean", "description": "Allow users to comment on the video. Default is determined by account settings.", "example": true }, "enableDuet": { "type": "boolean", "description": "Allow users to create Duet videos with your content.\n\n**Duet:** Side-by-side video featuring your content and the creator's reaction/addition.", "example": true }, "enableStitch": { "type": "boolean", "description": "Allow users to create Stitch videos with your content.\n\n**Stitch:** Clips up to 5 seconds of your video that creators can use in their own videos.", "example": true }, "videoDisclosure": { "type": "boolean", "description": "Enable branded content disclosure. Required when video is promotional content.\n\n**Validations:**\n- Cannot be `true` if `privacyLevel` is `SELF_ONLY`\n- If enabled, at least one of `promoteYourBrand` or `promoteOtherBrand` must be `true`", "example": false }, "promoteYourBrand": { "type": "boolean", "description": "Indicates if the video promotes your own brand or product.\n\n**Required:** Must be `true` if `videoDisclosure` is enabled and you're promoting your own brand.", "example": false } }, "title": "TiktokPostSchema" } ] }, "gmbPostDetails": { "description": "GMB Post Details", "example": { "gmbEventType": "STANDARD", "actionType": "BOOK" }, "allOf": [ { "type": "object", "properties": { "gmbEventType": { "type": "string", "description": "Google My Business post type.\n\n**Available Types:**\n- `STANDARD` - Regular update post (What's New)\n- `EVENT` - Event announcement with dates and title\n- `OFFER` - Promotional offer with coupon and redemption details\n\n**Required fields by type:**\n- STANDARD: None additional\n- EVENT: `title`, `startDate`, `endDate`\n- OFFER: `offerTitle`, `startDate`, `endDate`, `termsConditions`, `couponCode`, `redeemOnlineUrl`", "example": "STANDARD", "enum": [ "STANDARD", "EVENT", "OFFER" ] }, "title": { "type": "string", "description": "Event title. Required when `gmbEventType` is `EVENT`.\n\n**Max length:** 58 characters", "example": "Summer Sale Event 2024" }, "offerTitle": { "type": "string", "description": "Offer title. Required when `gmbEventType` is `OFFER`.", "example": "50% Off All Products" }, "startDate": { "description": "Start date and time for EVENT or OFFER posts.\n\n**Required:** When `gmbEventType` is `EVENT` or `OFFER`.\n\n**Structure:**\n- `startDate`: { year, month, day }\n- `startTime`: { hours, minutes, seconds }", "example": { "startDate": { "year": 2024, "month": 1, "day": 15 }, "startTime": { "hours": 10, "minutes": 0, "seconds": 0 } }, "allOf": [ { "type": "object", "properties": { "startDate": { "description": "Start Date", "example": { "year": 2024, "month": 1, "day": 15 }, "allOf": [ { "type": "object", "properties": { "year": { "type": "number", "description": "Year component of the date", "example": 2022 }, "month": { "type": "number", "description": "Month component of the date (1-12)", "example": 1 }, "day": { "type": "number", "description": "Day component of the date (1-31)", "example": 1 } }, "required": [ "year", "month", "day" ], "title": "DateSchema" } ] }, "startTime": { "description": "Start Time", "example": { "hours": 10, "minutes": 30, "seconds": 0 }, "allOf": [ { "type": "object", "properties": { "hours": { "type": "number", "description": "Hour component of the time (0-23)", "example": 23 }, "minutes": { "type": "number", "description": "Minute component of the time (0-59)", "example": 56 }, "seconds": { "type": "number", "description": "Second component of the time (0-59)", "example": 34 } }, "required": [ "hours", "minutes", "seconds" ], "title": "TimeSchema" } ] } }, "title": "StartDateSchema" } ] }, "endDate": { "description": "End date and time for EVENT or OFFER posts.\n\n**Required:** When `gmbEventType` is `EVENT` or `OFFER`.\n**Validation:** Must be after `startDate`.\n\n**Structure:**\n- `endDate`: { year, month, day }\n- `endTime`: { hours, minutes, seconds }", "example": { "endDate": { "year": 2024, "month": 1, "day": 20 }, "endTime": { "hours": 18, "minutes": 0, "seconds": 0 } }, "allOf": [ { "type": "object", "properties": { "endDate": { "description": "End Date", "example": { "year": 2024, "month": 1, "day": 20 }, "allOf": [ { "type": "object", "properties": { "year": { "type": "number", "description": "Year component of the date", "example": 2022 }, "month": { "type": "number", "description": "Month component of the date (1-12)", "example": 1 }, "day": { "type": "number", "description": "Day component of the date (1-31)", "example": 1 } }, "required": [ "year", "month", "day" ], "title": "DateSchema" } ] }, "endTime": { "description": "End Time", "example": { "hours": 18, "minutes": 0, "seconds": 0 }, "allOf": [ { "type": "object", "properties": { "hours": { "type": "number", "description": "Hour component of the time (0-23)", "example": 23 }, "minutes": { "type": "number", "description": "Minute component of the time (0-59)", "example": 56 }, "seconds": { "type": "number", "description": "Second component of the time (0-59)", "example": 34 } }, "required": [ "hours", "minutes", "seconds" ], "title": "TimeSchema" } ] } }, "title": "EndDateSchema" } ] }, "termsConditions": { "type": "string", "description": "URL to terms and conditions page. Required for OFFER posts.", "example": "https://yoursite.com/terms-and-conditions" }, "url": { "type": "string", "description": "Call-to-action URL. Required when `actionType` is set (except `none` and `call`).\n\n**Required for:** STANDARD and EVENT posts with actionType other than `none` or `call`.", "example": "https://yoursite.com/book-now" }, "couponCode": { "type": "string", "description": "Promotional coupon code. Required for OFFER posts.", "example": "SAVE50" }, "redeemOnlineUrl": { "type": "string", "description": "URL where customers can redeem the offer online. Required for OFFER posts.", "example": "https://yoursite.com/redeem-offer" }, "actionType": { "type": "string", "description": "Call-to-action button type for the post.\n\n**Available Actions:**\n- `none` - No action button\n- `order` - Order online\n- `book` - Book appointment\n- `shop` - Shop now\n- `learn_more` - Learn more\n- `call` - Call now (no URL required)\n- `sign_up` - Sign up\n\n**Note:** All actions except `none` and `call` require a `url`.", "example": "book", "enum": [ "none", "order", "book", "shop", "learn_more", "call", "sign_up" ] } }, "required": [ "gmbEventType" ], "title": "GMBPostSchema" } ] }, "blueskyPostDetails": { "description": "Bluesky Post Details", "example": { "content": "Check out our latest post!" }, "allOf": [ { "type": "object", "properties": { "shortenedLinks": { "description": "Shortened links for the post (auto-generated).", "example": [ { "originalUrl": "https://example.com", "shortenedUrl": "https://short.link/abc" } ], "type": "array", "items": { "type": "string" } }, "replyTo": { "type": "string", "description": "Bluesky AT Protocol URI of a post to reply to.\n\n**Format:** `at://did:plc:{user-id}/app.bsky.feed.post/{post-id}`\n\n**Use Case:** Create a reply thread to an existing Bluesky post.", "example": "at://did:plc:abc123def456/app.bsky.feed.post/xyz789" }, "quotePost": { "type": "string", "description": "Bluesky AT Protocol URI of a post to quote.\n\n**Format:** `at://did:plc:{user-id}/app.bsky.feed.post/{post-id}`\n\n**Use Case:** Quote-post another user's post with your commentary.", "example": "at://did:plc:abc123def456/app.bsky.feed.post/xyz789" }, "language": { "type": "string", "description": "ISO 639-1 language code for the post content.\n\n**Examples:** `en` (English), `es` (Spanish), `fr` (French), `de` (German)", "example": "en" }, "externalLink": { "type": "string", "description": "External URL to embed as a link card in the post.", "example": "https://yoursite.com/article" }, "externalLinkTitle": { "type": "string", "description": "Title for the external link card. Displayed prominently in the embed.", "example": "10 Tips for Better Social Media Marketing" }, "externalLinkDescription": { "type": "string", "description": "Description for the external link card. Brief summary displayed below the title.", "example": "Learn how to improve your social media presence with these proven strategies." } }, "title": "BlueskyPostSchema" } ] }, "user": { "description": "User", "example": { "id": "6284c43d519161e96cc09c13", "firstName": "Harry", "lastName": "Spencer", "email": "abc@xyc.com" }, "allOf": [ { "type": "object", "properties": { "id": { "type": "string", "description": "User Id", "example": "6284c43d519161e96cc09c13" }, "title": { "type": "string", "description": "Title", "example": "Mr" }, "firstName": { "type": "string", "description": "First name", "example": "Harry" }, "lastName": { "type": "string", "description": "Last name", "example": "Spencer" }, "profilePhoto": { "type": "string", "description": "Profile photo", "example": "https://storage.googleapis.com/user/kCrjKGHZQ2/profile/1dca8c-61c9-404d-a459-751fbcb.jpeg" }, "phone": { "type": "string", "description": "Phone number", "example": "901111119" }, "email": { "type": "string", "description": "Email Id", "example": "abc@xyc.com" } }, "required": [ "id", "title", "firstName", "lastName", "profilePhoto", "phone", "email" ], "title": "PostUserSchema" } ] }, "linkedinPostDetails": { "description": "Linkedin Post Details", "example": { "visibility": "PUBLIC" }, "allOf": [ { "type": "object", "properties": { "pdfTitle": { "type": "string", "description": "Title for the PDF document carousel. Displayed as the document name on LinkedIn.\n\n**Max length:** 100 characters\n\n**Tip:** Use a descriptive title that explains the document content.", "example": "Q4 Marketing Strategy Presentation" }, "postAsPdf": { "type": "boolean", "description": "Post images as a PDF document carousel.\n\n**Limits:**\n- Max 300 pages/images\n- Max PDF size: 100 MB", "example": true }, "poll": { "description": "Publish a LinkedIn poll post.\n\n**Required fields when `poll` is supplied:**\n- `question` (max 140 characters)\n- `options`: 2 to 4 entries, each `text` ≤ 30 characters; option texts must be unique\n- `settings.duration`: one of `ONE_DAY`, `THREE_DAYS`, `SEVEN_DAYS`, `FOURTEEN_DAYS`\n\n**LinkedIn restrictions:**\n- Polls cannot be edited after publishing.\n- A poll post cannot include `media` or a meta-link preview.", "example": { "question": "What is your favorite color?", "options": [ { "text": "Blue" }, { "text": "Green" } ], "settings": { "duration": "SEVEN_DAYS" } }, "allOf": [ { "type": "object", "properties": { "question": { "type": "string", "description": "Question for the poll. Max length: 140 characters.", "example": "What is your favorite color?", "maxLength": 140 }, "options": { "description": "Poll options. Minimum 2, maximum 4. Each option text max 30 characters. Option texts must be unique.", "minItems": 2, "maxItems": 4, "example": [ { "text": "Blue" }, { "text": "Green" } ], "type": "array", "items": { "type": "object", "properties": { "text": { "type": "string", "description": "Text describing the option. Max length: 30 characters.", "example": "Red", "maxLength": 30 } }, "required": [ "text" ], "title": "LinkedinPollOptionDto" } }, "settings": { "description": "Poll settings (duration).", "example": { "duration": "SEVEN_DAYS" }, "allOf": [ { "type": "object", "properties": { "duration": { "type": "string", "description": "Duration the poll stays open for votes.", "enum": [ "ONE_DAY", "THREE_DAYS", "SEVEN_DAYS", "FOURTEEN_DAYS" ], "example": "SEVEN_DAYS" } }, "required": [ "duration" ], "title": "LinkedinPollSettingsDto" } ] } }, "required": [ "question", "options", "settings" ], "title": "LinkedinPollDto" } ] } }, "title": "LinkedinPostSchema" } ] }, "pinterestPostDetails": { "description": "Pinterest Post Details", "example": { "boardId": "123456789", "title": "Pin Title" }, "allOf": [ { "type": "object", "properties": { "title": { "type": "string", "description": "Pin title displayed on Pinterest.\n\n**Max length:** 100 characters\n\n**Best Practices:**\n- Include relevant keywords\n- Be descriptive and engaging", "example": "10 Easy Home Decor Ideas for 2024" }, "link": { "type": "string", "description": "Destination URL for the pin. Users clicking the pin will be directed to this URL.\n\n**Max length:** 2048 characters\n\n**Best Practices:**\n- Use direct links to relevant content\n- Track with UTM parameters for analytics", "example": "https://yoursite.com/blog/home-decor-ideas" }, "boardIds": { "type": "object", "deprecated": true, "description": "**DEPRECATED — use `pinterestBoards` instead.** Will be removed on July 31, 2026.\n\nLegacy mapping of Pinterest account OAuth IDs to a single board ID:\n`{ accountOAuthId: \"boardId\" }`\n\nFor multi-board posting, use `pinterestBoards`.", "additionalProperties": { "type": "string" }, "example": { "6887d6de1d8175813d50dab8": "987654321098765432" } }, "pinterestBoards": { "description": "Per-account Pinterest board selection. Each entry binds one connected Pinterest account to a list of boards on that account. Each board produces an independent child post tracked separately for success/failure. Capped at 25 boards per account.\n\nWhen supplied, this field takes precedence over the deprecated `boardIds` field.", "example": [ { "accountId": "6887d6de1d8175813d50dab8", "boards": [ "987654321098765432", "234567890123456789" ] }, { "accountId": "682c7d1710a2fe3d805a3513", "boards": [ "111222333444555666" ] } ], "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string", "description": "Connected Pinterest account ID. Must match one of the accounts referenced in the post's `userIds`.", "example": "6887d6de1d8175813d50dab8" }, "boards": { "description": "Pinterest board IDs to publish to on this account. Each board produces an independent child post tracked separately for success/failure. Capped at 25 boards per account.", "example": [ "987654321098765432", "234567890123456789" ], "type": "array", "items": { "type": "string" } } }, "required": [ "accountId", "boards" ], "title": "PinterestBoardSelection" } }, "shortenedLinks": { "description": "Shortened links for the post (auto-generated).", "example": [ { "originalUrl": "https://example.com", "shortenedUrl": "https://short.link/abc" } ], "type": "array", "items": { "type": "string" } } }, "title": "PinterestPostSchema" } ] }, "facebookPostDetails": { "description": "Facebook Post Details", "example": { "type": "feed" }, "allOf": [ { "type": "object", "properties": { "type": { "type": "string", "description": "Facebook post format type.\n\n**Available Types:**\n- `post` - Standard feed post (images, videos, text)\n- `story` - 24-hour temporary story\n- `reel` - Short-form vertical video\n\n**Restrictions:**\n- Reels: Require exactly 1 video, not supported on Groups\n- Stories: Captions not supported", "example": "post", "enum": [ "post", "story", "reel" ] }, "textFormatPresetId": { "type": "string", "description": "Facebook background preset ID for text-only feed posts. **Facebook `post` only** — not `story` or `reel`. Ignored when media is attached; `metaLink` is omitted on publish.\n\n**Validations** — request returns `400` if violated:\n- Must be a valid preset ID from the [Facebook text background preset reference](https://help.leadconnectorhq.com/support/solutions/articles/155000008005-facebook-text-background-posts-preset-reference). Empty strings, whitespace-only values, and `null` are rejected.\n- When set, `summary` must be 130 characters or fewer.", "example": "303063890126415" } }, "required": [ "type" ], "title": "FacebookPostSchema" } ] }, "instagramPostDetails": { "description": "Instagram Post Details", "example": { "type": "feed", "share_to_feed": true }, "allOf": [ { "type": "object", "properties": { "type": { "type": "string", "description": "Instagram post format type.\n\n**Available Types:**\n- `post` - Standard feed post (images, videos, carousels)\n- `story` - 24-hour temporary story\n- `reel` - Short-form vertical video (up to 90 seconds)\n\n**Restrictions:**\n- Media is REQUIRED for all Instagram posts\n- Reels: Require exactly 1 video\n- Stories: Captions not supported, JPEG only for images", "example": "post", "enum": [ "post", "story", "reel" ] }, "collaborators": { "type": "object", "description": "Collaboration invites mapping account IDs to Instagram usernames.\n\n**Structure:** `{ accountId: [username1, username2, username3] }`\n\n- **Key:** Account ID from `accountIds` array (the Instagram account posting)\n- **Value:** Array of Instagram usernames to invite as collaborators\n\n**Get Account IDs from:** [Get Accounts API](/social-media-posting/oauth/{locationId}/accounts) — use the `id` field from Instagram accounts.\n\n**✅ Supported for:** Posts and Reels only (NOT Stories)\n\n**Validations:**\n- Maximum 5 collaborators per account\n- No duplicate usernames allowed\n- Usernames are Instagram handles without @\n\n**Use Case:** Invite other Instagram users to collaborate. Once accepted, the post appears on both profiles.", "example": { "640ab864e8e47e7f8a186425_hE998piDgAGZDY1xzmFD_17841453046826624": [ "influencer_username", "partner_brand" ] } }, "publishViaPushNotification": { "type": "boolean", "description": "Send Instagram Story via Push Notification instead of direct posting. Only applicable for Story type.", "example": true }, "publisherNote": { "type": "string", "description": "Note to the publisher for manual posting guidance. Only used when publishViaPushNotification is true.", "example": "When publishing, add swipe up link to the landing page so that we can direct them to the sales page" }, "notificationSentCount": { "type": "number", "description": "Number of push notifications sent for this Instagram Story. Tracks how many notifications have been sent out.", "example": 1 }, "postedVia": { "type": "string", "description": "Source of where the post was marked as published. Values: \"web\" (web interface), \"mobile\" (mobile app), or null.", "example": "web", "enum": [ "web", "mobile" ] }, "showOnFeed": { "type": "boolean", "description": "Show Reel on profile grid/feed.\n\n**✅ Applies to:** Reels only\n\n- `true` - Reel appears on your profile grid\n- `false` - Reel only appears in Reels tab", "example": true } }, "required": [ "type" ], "title": "InstagramPostSchema" } ] }, "youtubePostDetails": { "description": "Youtube Post Details", "example": { "title": "Video Title", "privacyStatus": "public" }, "allOf": [ { "type": "object", "properties": { "title": { "type": "string", "description": "Video title displayed on YouTube.\n\n**Max length:** 100 characters\n\n**Best Practices:**\n- Include relevant keywords\n- Be descriptive but concise\n- Avoid clickbait", "example": "How to Build a Successful Marketing Strategy in 2024" }, "privacyLevel": { "type": "string", "description": "Video visibility/privacy setting.\n\n**Available Values:**\n- `public` - Anyone can search and view\n- `unlisted` - Only people with the link can view\n- `private` - Only you can view", "example": "public", "enum": [ "private", "public", "unlisted" ] }, "type": { "type": "string", "description": "YouTube video format type.\n\n**Available Types:**\n- `video` - Standard YouTube video (landscape, any duration)\n- `short` - YouTube Shorts (vertical, up to 60 seconds)\n\n**Required field.**", "example": "video", "enum": [ "video", "short" ] } }, "required": [ "type" ], "title": "YoutubePostSchema" } ] }, "communityPostDetails": { "description": "Community Post Details", "example": { "title": "Welcome to our community!", "notifyAllGroupMembers": false, "postAsUser": { "aF3KhyL8JIuBwzK3m7Ly_iVrVJ2uoXNF0wzcBzgl5_12554616564525983496": { "id": "YBjxnYiXJKmoyV7WDjjG", "name": "Jane Cooper" } } }, "allOf": [ { "type": "object", "properties": { "title": { "type": "string", "description": "Title of the community post. Displayed as the post headline.\n\n**Max length:** 1,000 characters\n\n**Required:** Yes, for all Community posts.", "example": "Welcome to Our New Community Feature!" }, "notifyAllGroupMembers": { "type": "boolean", "description": "Notify every member of the group when the post is published, equivalent to an `@everyone` broadcast prepended to the post content.\n\n**Use Case:** Enable for announcements that all members should see.\n\n**Default:** `false`", "example": true }, "postAsUser": { "type": "object", "description": "The Community member each post is published as, keyed by Community account ID.\n\n**Structure:** `{ accountId: { id, name, avatar } }`\n\n- **Key** — the Community account ID. This is the same value you pass in `accountIds`: take it from the `id` field of a Community account in the Get Accounts API, not the `oauthId` field.\n- `id` (required) — `contactId` of the member to publish as, from the Get Community Members API.\n- `name` (optional) — display name shown as the post author.\n- `avatar` (optional) — profile image URL shown against the post.\n\n**Required:** Yes. Every Community account listed in `accountIds` must have an entry here, otherwise the request is rejected.\n\n**Member eligibility:** the member must be an active member of the group and hold a role in it. This is checked again at publish time, so a member who leaves the group or loses access between scheduling and publishing causes that post to fail. Use the Validate Community Member API to confirm a stored member is still eligible before scheduling.\n\n**Private channels:** list members per account rather than reusing one list across accounts — for a private channel only that channel's members may be posted as.", "example": { "aF3KhyL8JIuBwzK3m7Ly_iVrVJ2uoXNF0wzcBzgl5_12554616564525983496": { "avatar": "https://storage.googleapis.com/revex-communities/avatars/jane.png", "id": "YBjxnYiXJKmoyV7WDjjG", "name": "Jane Cooper" } } } }, "required": [ "title", "postAsUser" ], "title": "CommunityPostSchema" } ] }, "mediaOptimization": { "type": "boolean", "description": "Pass this parameter to optimize the image media", "example": true } }, "required": [ "locationId", "error", "type" ], "title": "GetModifiedPayloadFormattedSchema" } ] }, "parentPostId": { "type": "string", "description": "The ID of the parent post before splitting to individual social posts.", "example": "60af88475f1b2c001f5d5f4e" }, "errors": { "example": [ "INVALID_USER_ID", "PIXABAY_MEDIA" ], "description": "List of errors associated with the queue item. Possible values: INVALID_USER_ID, PIXABAY_MEDIA.", "type": "array", "items": { "type": "string" } }, "currentVariation": { "type": "number", "description": "The index of the current variation being used for this post", "example": 0 }, "createdAt": { "type": "string", "example": "2024-12-09T13:41:21.385Z", "description": "Creation timestamp" }, "updatedAt": { "type": "string", "example": "2024-12-09T13:41:21.385Z", "description": "Last update timestamp" }, "deleted": { "type": "boolean", "example": false, "description": "Indicates if the item is deleted" }, "locationId": { "type": "string", "example": "fvg1TXIiVxGcdOaL0riG", "description": "Location ID" } }, "title": "CreatedQueueItemWithVariationsDTO" } ] } }, "title": "CreateQueueItemResponseDTO" } ] }, "traceId": { "type": "string", "description": "Trace ID for debugging", "example": "TRACE-abc123-def456" } }, "required": [ "success", "statusCode", "results" ], "title": "WrappedCreateQueueItemResponseDTO" }, "BadRequestDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 400 }, "message": { "type": "string", "example": "Bad Request" } }, "title": "BadRequestDTO" }, "UnauthorizedDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 401 }, "message": { "type": "string", "example": "Invalid token: access token is invalid" }, "error": { "type": "string", "example": "Unauthorized" } }, "title": "UnauthorizedDTO" }, "UnprocessableDTO": { "type": "object", "properties": { "statusCode": { "type": "number", "example": 422 }, "message": { "example": [ "Unprocessable Entity" ], "type": "array", "items": { "type": "string" } }, "error": { "type": "string", "example": "Unprocessable Entity" } }, "title": "UnprocessableDTO" } } } } ``` ## Code Examples **cURL** ```bash curl -L -X POST 'https://services.leadconnectorhq.com/social-media-posting/category/queues//create/item' \ -H 'Authorization: Bearer ' \ -H 'Version: v3' \ -H 'Content-Type: application/json' \ --data-raw '{ "locationId": "609e126a1c4ae1001291e1b5", "sessionId": "60af88475f1b2c001f5d5f4b", "modifiedPostPayload": { "summary": "New queued post content", "media": [] }, "order": "top", "variations": [ { "content": "Try this variation", "mentions": [], "ogTags": { "metaLink": "https://example.com" } } ], "primaryImage": "http://example.com/media.png", "directToQueue": false }' ``` **Node.js** ```javascript const options = { method: 'POST', headers: { Authorization: 'Bearer ', Version: 'v3', 'Content-Type': 'application/json' }, body: JSON.stringify({ "locationId": "609e126a1c4ae1001291e1b5", "sessionId": "60af88475f1b2c001f5d5f4b", "modifiedPostPayload": { "summary": "New queued post content", "media": [] }, "order": "top", "variations": [ { "content": "Try this variation", "mentions": [], "ogTags": { "metaLink": "https://example.com" } } ], "primaryImage": "http://example.com/media.png", "directToQueue": false }) }; try { const response = await fetch('https://services.leadconnectorhq.com/social-media-posting/category/queues//create/item', options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` **Python** ```python import requests url = "https://services.leadconnectorhq.com/social-media-posting/category/queues/{queueId}/create/item" headers = { "Authorization": "Bearer ", "Version": "v3" } payload = { "locationId": "609e126a1c4ae1001291e1b5", "sessionId": "60af88475f1b2c001f5d5f4b", "modifiedPostPayload": { "summary": "New queued post content", "media": [] }, "order": "top", "variations": [ { "content": "Try this variation", "mentions": [], "ogTags": { "metaLink": "https://example.com" } } ], "primaryImage": "http://example.com/media.png", "directToQueue": false } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` **PHP** ```php 'https://services.leadconnectorhq.com/social-media-posting/category/queues//create/item', CURLOPT_RETURNTRANSFER => true, CURLOPT_CUSTOMREQUEST => 'POST', CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ', 'Version: v3', 'Content-Type: application/json', ], CURLOPT_POSTFIELDS => '{ "locationId": "609e126a1c4ae1001291e1b5", "sessionId": "60af88475f1b2c001f5d5f4b", "modifiedPostPayload": { "summary": "New queued post content", "media": [] }, "order": "top", "variations": [ { "content": "Try this variation", "mentions": [], "ogTags": { "metaLink": "https://example.com" } } ], "primaryImage": "http://example.com/media.png", "directToQueue": false }', ]); $response = curl_exec($curl); curl_close($curl); echo $response; ``` **Java** ```java HttpResponse response = Unirest .post("https://services.leadconnectorhq.com/social-media-posting/category/queues//create/item") .header("Authorization", "Bearer ") .header("Version", "v3") .header("Content-Type", "application/json") .body("{\"locationId\":\"609e126a1c4ae1001291e1b5\",\"sessionId\":\"60af88475f1b2c001f5d5f4b\",\"modifiedPostPayload\":{\"summary\":\"New queued post content\",\"media\":[]},\"order\":\"top\",\"variations\":[{\"content\":\"Try this variation\",\"mentions\":[],\"ogTags\":{\"metaLink\":\"https://example.com\"}}],\"primaryImage\":\"http://example.com/media.png\",\"directToQueue\":false}") .asString(); ``` **Go** ```go package main import ( "fmt" "net/http" "io" "strings" ) func main() { url := "https://services.leadconnectorhq.com/social-media-posting/category/queues//create/item" payload := strings.NewReader(`{ "locationId": "609e126a1c4ae1001291e1b5", "sessionId": "60af88475f1b2c001f5d5f4b", "modifiedPostPayload": { "summary": "New queued post content", "media": [] }, "order": "top", "variations": [ { "content": "Try this variation", "mentions": [], "ogTags": { "metaLink": "https://example.com" } } ], "primaryImage": "http://example.com/media.png", "directToQueue": false }`) req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Version", "v3") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(string(body)) } ``` **Ruby** ```ruby require 'uri' require 'net/http' url = URI("https://services.leadconnectorhq.com/social-media-posting/category/queues//create/item") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = "Bearer " request["Version"] = "v3" request["Content-Type"] = "application/json" request.body = '{ "locationId": "609e126a1c4ae1001291e1b5", "sessionId": "60af88475f1b2c001f5d5f4b", "modifiedPostPayload": { "summary": "New queued post content", "media": [] }, "order": "top", "variations": [ { "content": "Try this variation", "mentions": [], "ogTags": { "metaLink": "https://example.com" } } ], "primaryImage": "http://example.com/media.png", "directToQueue": false }' response = http.request(request) puts response.read_body ``` **PowerShell** ```powershell $headers = @{ "Authorization" = "Bearer " "Version" = "v3" } $body = '{ "locationId": "609e126a1c4ae1001291e1b5", "sessionId": "60af88475f1b2c001f5d5f4b", "modifiedPostPayload": { "summary": "New queued post content", "media": [] }, "order": "top", "variations": [ { "content": "Try this variation", "mentions": [], "ogTags": { "metaLink": "https://example.com" } } ], "primaryImage": "http://example.com/media.png", "directToQueue": false }' $response = Invoke-RestMethod -Uri 'https://services.leadconnectorhq.com/social-media-posting/category/queues//create/item' -Method 'POST' -Headers $headers -Body $body -ContentType 'application/json' $response | ConvertTo-Json ```