Skip to main content
POST
Publish on the partner's organization page

Authorizations

Authorization
string
header
required

OAuth 2.0 client credentials. Request a token from the token endpoint of the identity provider's domain (https://{cognito-domain}/oauth2/token, with HTTP Basic client authentication) and send it as a Bearer token. Production uses auth.mypilotindex.com. The sandbox uses the dev environment's Cognito domain, which is given to the partner with its sandbox credential. A token carries only the scopes the partner was approved for.

Body

application/json

Maximum 32768 bytes. Exactly client_ref and content; unknown or repeated members are rejected.

client_ref
string
required

The partner's own name for this create, unique per partner and kind of publication. Send the same ref to retry.

Required string length: 1 - 64
Pattern: ^[A-Za-z0-9._:-]{1,64}$
content
string
required

The text, up to 5,000 UTF-16 units after surrounding whitespace is trimmed. No control characters but line breaks and tabs, and no @handle or @all.

Required string length: 1 - 5000

Response

A retry of a create already made; nothing was published.

post_id
string<uuid>
required

The post; a removal names it.

replayed
boolean
required

True when this client_ref had already made the post and nothing was published.