Documentation menu

Posts

Create, read, update, and delete posts and their per-platform targets.

GET `/posts`

Requires Authorization: Bearer <token>.

Query parameters

Field	Type	Notes
`status`	`draft \| scheduled \| publishing \| published \| partial \| failed \| deleted \| null`nullable	—
`q`	`string`nullable	`max 200`
`per_page`	`integer`nullable	`1–100`

Example request

curl 'https://app.shoutrrr.com/api/v1/posts' \
  -H 'Authorization: Bearer <token>'

const res = await fetch('https://app.shoutrrr.com/api/v1/posts', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>',
  },
});
const data = await res.json();

import requests

res = requests.get(
    'https://app.shoutrrr.com/api/v1/posts',
    headers={'Authorization': 'Bearer <token>'},
)
data = res.json()

<?php
$ch = curl_init('https://app.shoutrrr.com/api/v1/posts');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
    ],
]);
$data = json_decode(curl_exec($ch), true);

Responses

200

Field	Type	Notes
`data`required	`object`	—
`pagination`required	`object`	—
`per_page`required	`integer`	—
`next_cursor`required	`string`nullable	—
`prev_cursor`required	`string`nullable	—
`has_more`required	`boolean`	—

401 Unauthenticated

Field	Type	Notes
`message`requiredError overview.	`string`	—

422 Validation error

Field	Type	Notes
`message`requiredErrors overview.	`string`	—
`errors`requiredA detailed description of each field that failed validation.	`object`	—

POST `/posts`

Requires Authorization: Bearer <token>.

Request body

Field	Type	Notes
`base_text`required	`string`nullable	—
`segments`	`string[]`	—
`destination`required	`object`	—
`kind`required	`all \| set \| account`	—
`id`	`string`nullable	—
`mentions`	`object[]`	—
`id`required	`string`	—
`label`required	`string`	—
`handles`	`object`	—
`x`	`string`nullable	—
`bluesky`	`string`nullable	—
`linkedin`	`string`nullable	—

Example request

curl -X POST 'https://app.shoutrrr.com/api/v1/posts' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "base_text": "string",
  "destination": {
    "kind": "all"
  }
}'

const res = await fetch('https://app.shoutrrr.com/api/v1/posts', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "base_text": "string",
  "destination": {
    "kind": "all"
  }
}),
});
const data = await res.json();

import requests

res = requests.post(
    'https://app.shoutrrr.com/api/v1/posts',
    headers={'Authorization': 'Bearer <token>'},
    json={
        'base_text': 'string',
        'destination': {
            'kind': 'all'
        }
    },
)
data = res.json()

<?php
$ch = curl_init('https://app.shoutrrr.com/api/v1/posts');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_POSTFIELDS => '{
  "base_text": "string",
  "destination": {
    "kind": "all"
  }
}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
        'Content-Type: application/json',
    ],
]);
$data = json_decode(curl_exec($ch), true);

Responses

201

Field	Type	Notes
`post`required	`object`	—
`id`required	`string`	—
`base_text`required	`string`	—
`segments`required	`any[]`nullable	—
`mentions`required	`any[]`	—
`status`required	`string`	—
`scheduled_at`required	`string`nullable	—
`published_at`required	`string`nullable	—
`updated_at`required	`string`	—
`destination`required	`"all" \| "accounts" \| "account" \| "set"`	—
`targets`required	`object[]`	—
`id`required	`string`	—
`connected_account_id`required	`string`	—
`platform`required	`string`	—
`handle`required	`string`	—
`display_name`required	`string`nullable	—
`avatar_url`required	`string`nullable	—
`sections`required	`any[]`	—
`content_override`required	`any[]`nullable	—
`auto_split`required	`boolean`	—
`status`required	`string`	—
`error_kind`required	`string`nullable	—
`error_message`required	`string`nullable	—
`attempts`required	`integer`	—
`remote_id`required	`string`nullable	—
`issues`required	`string`	—
`media`required	`object[]`	—
`id`required	`string`	—
`url`required	`string`	—
`mime`required	`string`	—
`kind`required	`string`	—
`duration_seconds`required	`integer`nullable	—
`alt_text`required	`string`nullable	—
`position`required	`integer`	—
`edit_settings`required	`any[]`nullable	—
`source_url`required	`string`nullable	—

401 Unauthenticated

Field	Type	Notes
`message`requiredError overview.	`string`	—

403 Authorization error

Field	Type	Notes
`message`requiredError overview.	`string`	—

422 Validation error

Field	Type	Notes
`message`requiredErrors overview.	`string`	—
`errors`requiredA detailed description of each field that failed validation.	`object`	—

GET `/posts/{id}`

Requires Authorization: Bearer <token>.

Path parameters

Field	Type	Notes
`id`required	`string`	—

Example request

curl 'https://app.shoutrrr.com/api/v1/posts/{id}' \
  -H 'Authorization: Bearer <token>'

const res = await fetch('https://app.shoutrrr.com/api/v1/posts/{id}', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>',
  },
});
const data = await res.json();

import requests

res = requests.get(
    'https://app.shoutrrr.com/api/v1/posts/{id}',
    headers={'Authorization': 'Bearer <token>'},
)
data = res.json()

<?php
$ch = curl_init('https://app.shoutrrr.com/api/v1/posts/{id}');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
    ],
]);
$data = json_decode(curl_exec($ch), true);

Responses

200

Field	Type	Notes
`post`required	`object`	—
`id`required	`string`	—
`base_text`required	`string`	—
`segments`required	`any[]`nullable	—
`mentions`required	`any[]`	—
`status`required	`string`	—
`scheduled_at`required	`string`nullable	—
`published_at`required	`string`nullable	—
`updated_at`required	`string`	—
`destination`required	`"all" \| "accounts" \| "account" \| "set"`	—
`targets`required	`object[]`	—
`id`required	`string`	—
`connected_account_id`required	`string`	—
`platform`required	`string`	—
`handle`required	`string`	—
`display_name`required	`string`nullable	—
`avatar_url`required	`string`nullable	—
`sections`required	`any[]`	—
`content_override`required	`any[]`nullable	—
`auto_split`required	`boolean`	—
`status`required	`string`	—
`error_kind`required	`string`nullable	—
`error_message`required	`string`nullable	—
`attempts`required	`integer`	—
`remote_id`required	`string`nullable	—
`issues`required	`string`	—
`media`required	`object[]`	—
`id`required	`string`	—
`url`required	`string`	—
`mime`required	`string`	—
`kind`required	`string`	—
`duration_seconds`required	`integer`nullable	—
`alt_text`required	`string`nullable	—
`position`required	`integer`	—
`edit_settings`required	`any[]`nullable	—
`source_url`required	`string`nullable	—

401 Unauthenticated

Field	Type	Notes
`message`requiredError overview.	`string`	—

PATCH `/posts/{id}`

Requires Authorization: Bearer <token>.

Path parameters

Field	Type	Notes
`id`required	`string`	—

Request body

Field	Type	Notes
`base_text`required	`string`nullable	—
`expected_updated_at`	`string`nullable	—
`segments`	`string[]`	—
`destination`required	`object`	—
`kind`required	`all \| set \| account`	—
`id`	`string`nullable	—
`media_ids`	`string[]`	—
`mentions`	`object[]`	—
`id`required	`string`	—
`label`required	`string`	—
`handles`	`object`	—
`x`	`string`nullable	—
`bluesky`	`string`nullable	—
`linkedin`	`string`nullable	—
`targets`	`object[]`	—
`connected_account_id`required	`string`	—
`auto_split`	`boolean`	—
`content_override`	`object`nullable	—
`text`	`string`nullable	—
`media_ids`	`string[]`	—

Example request

curl -X PATCH 'https://app.shoutrrr.com/api/v1/posts/{id}' \
  -H 'Authorization: Bearer <token>' \
  -H 'Content-Type: application/json' \
  -d '{
  "base_text": "string",
  "destination": {
    "kind": "all"
  }
}'

const res = await fetch('https://app.shoutrrr.com/api/v1/posts/{id}', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "base_text": "string",
  "destination": {
    "kind": "all"
  }
}),
});
const data = await res.json();

import requests

res = requests.patch(
    'https://app.shoutrrr.com/api/v1/posts/{id}',
    headers={'Authorization': 'Bearer <token>'},
    json={
        'base_text': 'string',
        'destination': {
            'kind': 'all'
        }
    },
)
data = res.json()

<?php
$ch = curl_init('https://app.shoutrrr.com/api/v1/posts/{id}');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'PATCH',
    CURLOPT_POSTFIELDS => '{
  "base_text": "string",
  "destination": {
    "kind": "all"
  }
}',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
        'Content-Type: application/json',
    ],
]);
$data = json_decode(curl_exec($ch), true);

Responses

200

Field	Type	Notes
`post`required	`object`	—
`id`required	`string`	—
`base_text`required	`string`	—
`segments`required	`any[]`nullable	—
`mentions`required	`any[]`	—
`status`required	`string`	—
`scheduled_at`required	`string`nullable	—
`published_at`required	`string`nullable	—
`updated_at`required	`string`	—
`destination`required	`"all" \| "accounts" \| "account" \| "set"`	—
`targets`required	`object[]`	—
`id`required	`string`	—
`connected_account_id`required	`string`	—
`platform`required	`string`	—
`handle`required	`string`	—
`display_name`required	`string`nullable	—
`avatar_url`required	`string`nullable	—
`sections`required	`any[]`	—
`content_override`required	`any[]`nullable	—
`auto_split`required	`boolean`	—
`status`required	`string`	—
`error_kind`required	`string`nullable	—
`error_message`required	`string`nullable	—
`attempts`required	`integer`	—
`remote_id`required	`string`nullable	—
`issues`required	`string`	—
`media`required	`object[]`	—
`id`required	`string`	—
`url`required	`string`	—
`mime`required	`string`	—
`kind`required	`string`	—
`duration_seconds`required	`integer`nullable	—
`alt_text`required	`string`nullable	—
`position`required	`integer`	—
`edit_settings`required	`any[]`nullable	—
`source_url`required	`string`nullable	—

401 Unauthenticated

Field	Type	Notes
`message`requiredError overview.	`string`	—

409 An error

Field	Type	Notes
`message`requiredError overview.	`string`	—

422 Validation error

Field	Type	Notes
`message`requiredErrors overview.	`string`	—
`errors`requiredA detailed description of each field that failed validation.	`object`	—

DELETE `/posts/{id}`

Requires Authorization: Bearer <token>.

Path parameters

Field	Type	Notes
`id`required	`string`	—

Example request

curl -X DELETE 'https://app.shoutrrr.com/api/v1/posts/{id}' \
  -H 'Authorization: Bearer <token>'

const res = await fetch('https://app.shoutrrr.com/api/v1/posts/{id}', {
  method: 'DELETE',
  headers: {
    'Authorization': 'Bearer <token>',
  },
});
const data = await res.json();

import requests

res = requests.delete(
    'https://app.shoutrrr.com/api/v1/posts/{id}',
    headers={'Authorization': 'Bearer <token>'},
)
data = res.json()

<?php
$ch = curl_init('https://app.shoutrrr.com/api/v1/posts/{id}');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'DELETE',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer <token>',
    ],
]);
$data = json_decode(curl_exec($ch), true);

Responses

200

Field	Type	Notes
`deleted`required	`boolean`	—
`remote`required	`boolean`	—
`message`required	`"Remote deletion queued for published targets."`	—

Field	Type	Notes
`deleted`required	`boolean`	—
`remote`required	`boolean`	—

401 Unauthenticated

Field	Type	Notes
`message`requiredError overview.	`string`	—

403 Authorization error

Field	Type	Notes
`message`requiredError overview.	`string`	—

Posts

GET /posts

Query parameters

Example request

Responses

POST /posts

Request body

Example request

Responses

GET /posts/{id}

Path parameters

Example request

Responses

PATCH /posts/{id}

Path parameters

Request body

Example request

Responses

DELETE /posts/{id}

Path parameters

Example request

Responses

GET `/posts`

POST `/posts`

GET `/posts/{id}`

PATCH `/posts/{id}`

DELETE `/posts/{id}`