Skip to main content

LinkedIn Settings

API settings for posting to LinkedIn

Settings Schema

When creating a post for LinkedIn (profile or page), use the following settings schema:

{
"settings": {
"__type": "linkedin",
"post_as_images_carousel": false
}
}
info

Use __type: "linkedin" for personal profiles and __type: "linkedin-page" for company pages. Both use the same settings schema.

Fields

FieldTypeRequiredDescription
__typestringYeslinkedin or linkedin-page
post_as_images_carouselbooleanNoDisplay multiple images as a carousel
carousel_namestringNoName for the carousel document

post_as_images_carousel

When set to true and you have multiple images, they will be displayed as a swipeable carousel instead of a collage.

ValueDescription
trueImages displayed as carousel
falseImages displayed as collage (default)

Optional name for the carousel document. Only used when post_as_images_carousel is true.


Complete Example

Text Post

{
"type": "schedule",
"date": "2024-12-14T10:00:00.000Z",
"shortLink": false,
"tags": [],
"posts": [
{
"integration": {
"id": "your-linkedin-integration-id"
},
"value": [
{
"content": "Excited to share our latest update! 🎉\n\n#innovation #tech",
"image": []
}
],
"settings": {
"__type": "linkedin"
}
}
]
}

Carousel Post

{
"type": "schedule",
"date": "2024-12-14T10:00:00.000Z",
"shortLink": false,
"tags": [],
"posts": [
{
"integration": {
"id": "your-linkedin-integration-id"
},
"value": [
{
"content": "Check out our product showcase! Swipe through to see all features →",
"image": [
{
"id": "image-1-id",
"path": "https://uploads.sipstory.tech/image1.png"
},
{
"id": "image-2-id",
"path": "https://uploads.sipstory.tech/image2.png"
},
{
"id": "image-3-id",
"path": "https://uploads.sipstory.tech/image3.png"
}
]
}
],
"settings": {
"__type": "linkedin",
"post_as_images_carousel": true,
"carousel_name": "Product Showcase"
}
}
]
}

Company Page Post

{
"type": "now",
"date": "2024-12-14T10:00:00.000Z",
"shortLink": false,
"tags": [],
"posts": [
{
"integration": {
"id": "your-linkedin-page-integration-id"
},
"value": [
{
"content": "We're hiring! Join our team and help us build the future.",
"image": []
}
],
"settings": {
"__type": "linkedin-page",
"post_as_images_carousel": false
}
}
]
}