Skip to content
Connect an agent

Inbox

Read an account's inbox now

Reads new comments and mentions now rather than at the next 15-minute read.

POST/v1/accounts/{id}/inbox/sync

TL;DR

QuestionAnswer
What does it do?Read an account's inbox now.
What does it need?An API key or an OAuth access token.
What does it take?id in the path.
What does it return?Status 200 with a body of type InboxSync.
In the SDK?flung.accounts.syncInbox()
What can go wrong?401 Missing, unknown, revoked or expired API key; 404 No such account in this workspace; 422 The request failed validation; 429 Too many requests for this credential; wait for retry-after seconds. Every failure has the same error shape.

Example

bash
curl -X POST 'https://api.flung.dev/v1/accounts/acct_aaaaaaaaaaaaaaaaaaaaaaaa/inbox/sync' \  --header "Authorization: Bearer $FLUNG_API_KEY"

A successful answer looks like this:

json
{  "added": 1}

Path parameters

FieldTypeRequiredDescription
idstringyes

Responses

StatusMeaningBody
200How many were new.InboxSync
401Missing, unknown, revoked or expired API key.Error
404No such account in this workspace.Error
422The request failed validation.Error
429Too many requests for this credential; wait for retry-after seconds.Error

Response body

A 200 answer has the type InboxSync.

FieldTypeRequiredDescription
addedintegeryesNew items read.

See also

DocWhy
API referenceEvery endpoint
SchemasEvery request and response type
ErrorsEvery error code and what to do about it