Skip to main content
POST
Post an update on a site

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, an opaque member token, or a verified One Auth identity access token. The credential alone identifies the member and company. Member session JWTs, and portal JWTs the server minted read-only, are refused with 403 on every write.

Path Parameters

site_id
string<uuid>
required

Public id of one of the member's sites.

Body

application/json

The line to post on a site and whether it should go out as a push too. Any other field is refused.

text
string
required

The line. Surrounding whitespace is trimmed first, and the trimmed line must have 1 to 240 characters, else 422.

push
boolean
default:false

Whether the poster asks for the update to go out as a push too. With true, each member it reaches also gets a push on their phone and desktop, subject to their do-not-disturb and push settings.

Response

The update was posted.

One posted update.

status
integer
required

HTTP status code (mirrors the response status line).

data
object
required

An update posted on a site.

meta
object
required

Envelope metadata present on every response.