Skip to main content
POST
Post an update on a site

Authorizations

Authorization
string
header
required

A company admin credential for your company, or a droplet installation token with the website scope for reads, except on the share routes, which refuse a droplet token.

Path Parameters

id
string<uuid>
required

The site's id.

Body

application/json

The line to post on a site and whether it should go out as a push too, unwrapped. 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.

site_update
object
required

An update posted on a site.

status
integer
required

The HTTP status.

meta
object
required

Response metadata included on every response body.