Publishing

Publish a text post as the pilot

Publishes a text post authored by the pilot of a grant that holds feed.write. visibility is public or connections and defaults to connections, the narrower of the two. 201 for a new post; 200 with replayed true for a retry of the same client_ref and body, which publishes nothing. See the Publishing tag for the client_ref, mentions, the allowance of 3 posts per grant per rolling 24 hours and removals. A grant that is revoked, unknown or another partner’s answers 404 not_found; a grant, or a token, without feed.write is 403 scope_missing.

POST

partner

grants

{grant_id}

feed-posts

Publish a text post as the pilot

curl --request POST \
  --url https://{devApiHost}/v1/partner/grants/{grant_id}/feed-posts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_ref": "logbook-entry-20261107-01",
  "content": "Landed in Lisbon after my first Atlantic crossing as captain.",
  "visibility": "connections"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    client_ref: 'logbook-entry-20261107-01',
    content: 'Landed in Lisbon after my first Atlantic crossing as captain.',
    visibility: 'connections'
  })
};

fetch('https://{devApiHost}/v1/partner/grants/{grant_id}/feed-posts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{devApiHost}/v1/partner/grants/{grant_id}/feed-posts"

payload = {
    "client_ref": "logbook-entry-20261107-01",
    "content": "Landed in Lisbon after my first Atlantic crossing as captain.",
    "visibility": "connections"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "post_id": "9a3e1f54-7c2b-4d10-8e6f-2b1d4c7a9e10",
  "replayed": true
}

{
  "post_id": "9a3e1f54-7c2b-4d10-8e6f-2b1d4c7a9e10",
  "replayed": false
}

{
  "error": {
    "code": "invalid_request",
    "message": "Invalid request.",
    "correlation_id": "0af7651916cd43dd8448eb211c80319c",
    "reason": "personal_contact"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "scope_missing"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "conflict",
    "message": "Request conflicts with an earlier operation.",
    "correlation_id": "0af7651916cd43dd8448eb211c80319c",
    "reason": "client_ref_reused"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "unprocessable",
    "message": "Request cannot be applied.",
    "correlation_id": "0af7651916cd43dd8448eb211c80319c",
    "reason": "mentions_not_allowed"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests.",
    "correlation_id": "0af7651916cd43dd8448eb211c80319c",
    "reason": "publication_throttled"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

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.

Path Parameters

grant_id

string<uuid>

required

Body

application/json

Maximum 32768 bytes. Exactly client_ref, content and an optional visibility; 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

visibility

enum<string>

default:connections

Who reads the post; connections unless the partner says otherwise.

Available options:

public,

connections

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.

⌘I

Publish a text post as the pilot

curl --request POST \
  --url https://{devApiHost}/v1/partner/grants/{grant_id}/feed-posts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_ref": "logbook-entry-20261107-01",
  "content": "Landed in Lisbon after my first Atlantic crossing as captain.",
  "visibility": "connections"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    client_ref: 'logbook-entry-20261107-01',
    content: 'Landed in Lisbon after my first Atlantic crossing as captain.',
    visibility: 'connections'
  })
};

fetch('https://{devApiHost}/v1/partner/grants/{grant_id}/feed-posts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://{devApiHost}/v1/partner/grants/{grant_id}/feed-posts"

payload = {
    "client_ref": "logbook-entry-20261107-01",
    "content": "Landed in Lisbon after my first Atlantic crossing as captain.",
    "visibility": "connections"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "post_id": "9a3e1f54-7c2b-4d10-8e6f-2b1d4c7a9e10",
  "replayed": true
}

{
  "post_id": "9a3e1f54-7c2b-4d10-8e6f-2b1d4c7a9e10",
  "replayed": false
}

{
  "error": {
    "code": "invalid_request",
    "message": "Invalid request.",
    "correlation_id": "0af7651916cd43dd8448eb211c80319c",
    "reason": "personal_contact"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "scope_missing"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "conflict",
    "message": "Request conflicts with an earlier operation.",
    "correlation_id": "0af7651916cd43dd8448eb211c80319c",
    "reason": "client_ref_reused"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "unprocessable",
    "message": "Request cannot be applied.",
    "correlation_id": "0af7651916cd43dd8448eb211c80319c",
    "reason": "mentions_not_allowed"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests.",
    "correlation_id": "0af7651916cd43dd8448eb211c80319c",
    "reason": "publication_throttled"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "correlation_id": "<string>",
    "reason": "<string>"
  }
}

Overview

Grants

Jobs

Publishing

Insights

Certificates

Webhooks

Publish a text post as the pilot

Authorizations

Path Parameters

Body

Response