POST
/
v1
/
teams
/
{teamId}
/
posts
/
{postId}
/
post-now
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

const client = new OctosparkClient({
  token: process.env.OCTOSPARK_TOKEN
})

const response = await client.socialPostNow({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  postId: process.env.OCTOSPARK_POST_ID ?? "postId",
  body: {},
})
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "teamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contentItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "socialAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scheduledAt": "<string>",
  "timezone": "<string>",
  "platformPostId": "<string>",
  "platformSettings": {},
  "publishResults": {},
  "providerPublishState": {
    "requiresPolling": true,
    "publishId": "<string>",
    "platformPostId": "<string>",
    "providerStatus": "<string>",
    "pollingReason": "<string>",
    "uploadProgress": {
      "nextByteStart": 123,
      "uploadSize": 123
    },
    "failureCode": "<string>"
  },
  "errorCode": "<string>",
  "errorMessage": "<string>",
  "workflowId": "<string>",
  "workflowRunId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

teamId
string
required
postId
string
required

Body

application/json
socialAccountId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
platformSettings
object
firstComment
object
engagementCommentTrigger
object
repostAfter
object
recurrenceIntervalDays
integer

a number between 1 and 365

Required range: 1 <= x <= 365
recurrenceEndsAt
string | null

Response

Success

id
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
teamId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
contentItemId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
socialAccountId
string<uuid>
required

a Universally Unique Identifier

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
provider
enum<string>
required
Available options:
x,
tiktok,
instagram,
facebook,
youtube,
linkedin,
threads
status
enum<string>
required
Available options:
draft,
scheduled,
publishing,
published,
failed,
cancelled
scheduledAt
string
required
timezone
string | null
required
platformPostId
string | null
required
platformSettings
object
required
publishResults
object
required
providerPublishState
object
required
errorCode
string | null
required
errorMessage
string | null
required
errorCategory
enum<string> | null
required
Available options:
rate_limited,
transient,
auth,
validation,
permanent
workflowId
string | null
required
workflowRunId
string | null
required
createdAt
string
required
updatedAt
string
required