POST
/
v1
/
teams
/
{teamId}
/
provider-gateway
/
accounts
/
{accountId}
/
requests
TypeScript client
import { OctosparkClient } from '@octospark/sdk'

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

const response = await client.providerGateway.executeSocialProviderRequest({
  teamId: process.env.OCTOSPARK_TEAM_ID ?? "teamId",
  accountId: process.env.OCTOSPARK_ACCOUNT_ID ?? "accountId",
  body: {},
})
{
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": 123,
  "contentType": "<string>",
  "bodyBase64": "<string>",
  "retryAfter": "<string>",
  "chargeDecimillicents": 123
}

Authorizations

Authorization
string
header
required

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

Path Parameters

teamId
string
required

Team (workspace) id (UUID). Discover ids via the list teams endpoint or the agent context.

accountId
string<uuid>
required

Connected social account UUID, as returned by the social accounts list.

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}$

Body

application/json
method
enum<string>
required

HTTP method to send to the vendor; writes require an idempotency key.

Available options:
GET,
HEAD,
POST,
PUT,
PATCH,
DELETE
path
string
required

a string at most 4096 character(s) long

Required string length: 1 - 4096
idempotencyKey
string
required

a string at most 200 character(s) long

Required string length: 1 - 200
query
object

Vendor query parameters; omit for none. Authentication overrides are rejected.

contentType
string

a string at most 256 character(s) long

Maximum string length: 256
bodyBase64
string

a string at most 11184812 character(s) long

Maximum string length: 11184812
headers
object

Optional vendor request headers; authentication, host and framing overrides are rejected.

Response

Success

requestId
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

Social platform identifier: x, tiktok, instagram, facebook, youtube, linkedin, threads, or pinterest.

Available options:
x,
tiktok,
instagram,
facebook,
youtube,
linkedin,
threads,
pinterest
Example:

"x"

status
number
required
contentType
string | null
required
bodyBase64
string
required
retryAfter
string | null
required
chargeDecimillicents
number
required
settlementStatus
enum<string>
required
Available options:
pending,
settled