Posts

The Comments API supports managing posts.

Create post

Creates a new post in the specified posts app.

POST /api/apps/{id}/posts
Path parameters
id integer required

App id.

Body parameters
blobs array of integers

Ids of blobs to attach.

embed_id integer

Id of embed to attach.

meeting_id integer

Id of meeting to attach.

options array of objects

List of poll options to attach.

text string

The message text.

metadata object

Additional metadata properties, e.g. { "color": "blue", "size": "XL" }.

tags array of strings

A list of tags to associate with the item.

Response codes

200 Success

{
  "comment_count": "integer",
  "comments": [
    "object"
  ],
  "is_subscribed": "boolean",
  "id": "integer",
  "app_id": "integer",
  "text": "string",
  "html": "string",
  "plain": "string",
  "attachment_count": "integer",
  "attachments": [
    "object"
  ],
  "embed_id": "integer",
  "meeting_id": "integer",
  "option_count": "integer",
  "options": [
    "object"
  ],
  "reactions": [
    "object"
  ],
  "metadata": "object",
  "tags": [
    "string"
  ],
  "created_at": "string",
  "created_by_id": "integer",
  "modified_at": "string",
  "modified_by_id": "integer",
  "is_trashed": "boolean"
}
Code sample
curl https://{WEAVY-SERVER}/api/apps/1/posts
-H "Authorization: Bearer {ACCESS-TOKEN | API-KEY}"
--json "{ 'text': 'This is a post' }"

List app posts

List posts in the specified posts app.

GET /api/apps/{id}/posts
Path parameters
id integer required

App id.

Query parameters
q string

A query used to find matching items.

tag string

List items with the specified tag.

trashed boolean

Indicates whether trashed items should be listed (default is false). Specify null to return both trashed and non-trashed items.

order_by string

Specifies the sort order and direction for the listing, e.g. "name" or "name+desc"

top integer

Maximum number of items to return in the listing. Should be a value between 0 and 100. Default is 25.

skip integer

The number of items to skip. Used together with top to return a specific range of items (for pagination).

count boolean

false to skip counting the total number of matching items; default is true.

count_only boolean

true to only return the number of matching items; when this is specified the response will only contain the count property.

Response codes

200 Success

{
  "data": [
    "object"
  ],
  "start": "integer",
  "end": "integer",
  "count": "integer"
}
Code sample
curl https://{WEAVY-SERVER}/api/apps/1/posts?top=50
-H "Authorization: Bearer {ACCESS-TOKEN | API-KEY}"

Get post

Gets a post by id.

GET /api/posts/{id}
Path parameters
id integer required

Id of the post.

Query parameters
trashed boolean

true to return post even if trashed.

Response codes

200 Success

{
  "comment_count": "integer",
  "comments": [
    "object"
  ],
  "is_subscribed": "boolean",
  "id": "integer",
  "app_id": "integer",
  "text": "string",
  "html": "string",
  "plain": "string",
  "attachment_count": "integer",
  "attachments": [
    "object"
  ],
  "embed_id": "integer",
  "meeting_id": "integer",
  "option_count": "integer",
  "options": [
    "object"
  ],
  "reactions": [
    "object"
  ],
  "metadata": "object",
  "tags": [
    "string"
  ],
  "created_at": "string",
  "created_by_id": "integer",
  "modified_at": "string",
  "modified_by_id": "integer",
  "is_trashed": "boolean"
}
Code sample
curl https://{WEAVY-SERVER}/api/posts/1
-H "Authorization: Bearer {ACCESS-TOKEN | API-KEY}"

Update post

Updates a post.

PATCH /api/posts/{id}
Path parameters
id integer required

Id of the post.

Body parameters
attachments array of integers

Ids of attached files.

blobs array of integers

Ids of additional blobs to attach.

embed_id integer

Id of embed to attach.

meeting_id integer

Id of meeting to attach.

options array of objects

List of poll options for the item.

text string

The message text.

metadata object

Additional metadata properties, e.g. { "color": "blue", "size": "XL" }.

tags array of strings

A list of tags to associate with the item.

Response codes

204 No Content

404 Not Found

400 Bad Request

Code sample
curl -X PATCH https://{WEAVY_SERVER}/api/posts/1
-H "Authorization: Bearer {ACCESS-TOKEN | API-KEY}"
--json "{ 'text': 'This is an updated post' }"

Delete post

Delete a post.

DELETE /api/posts/{id}
Path parameters
id integer required

Id of the post.

Response codes

204 No Content

Code sample
curl -X DELETE https://{WEAVY_SERVER}/api/posts/1
-H "Authorization: Bearer {ACCESS-TOKEN | API-KEY}"

Subscribe to post

Subscribe to notifications for activity on a post.

POST /api/posts/{id}/subscribe
Path parameters
id integer required

Id of the post.

Response codes

200 Success

{
  "comment_count": "integer",
  "comments": [
    "object"
  ],
  "is_subscribed": "boolean",
  "id": "integer",
  "app_id": "integer",
  "text": "string",
  "html": "string",
  "plain": "string",
  "attachment_count": "integer",
  "attachments": [
    "object"
  ],
  "embed_id": "integer",
  "meeting_id": "integer",
  "option_count": "integer",
  "options": [
    "object"
  ],
  "reactions": [
    "object"
  ],
  "metadata": "object",
  "tags": [
    "string"
  ],
  "created_at": "string",
  "created_by_id": "integer",
  "modified_at": "string",
  "modified_by_id": "integer",
  "is_trashed": "boolean"
}
Code sample
curl -X POST https://{WEAVY_SERVER}/api/posts/1/subscribe
-H "Authorization: Bearer {ACCESS-TOKEN}"

Unsubscribe to post

Unsubscribe to notifications for activity on a post.

POST /api/posts/{id}/unsubscribe
Path parameters
id integer required

Id of the post.

Response codes

200 Success

{
  "comment_count": "integer",
  "comments": [
    "object"
  ],
  "is_subscribed": "boolean",
  "id": "integer",
  "app_id": "integer",
  "text": "string",
  "html": "string",
  "plain": "string",
  "attachment_count": "integer",
  "attachments": [
    "object"
  ],
  "embed_id": "integer",
  "meeting_id": "integer",
  "option_count": "integer",
  "options": [
    "object"
  ],
  "reactions": [
    "object"
  ],
  "metadata": "object",
  "tags": [
    "string"
  ],
  "created_at": "string",
  "created_by_id": "integer",
  "modified_at": "string",
  "modified_by_id": "integer",
  "is_trashed": "boolean"
}
Code sample
curl -X POST https://{WEAVY_SERVER}/api/posts/1/unsubscribe
-H "Authorization: Bearer {ACCESS-TOKEN}"

Trash post

Move a post to the trash.

POST /api/posts/{id}/trash
Path parameters
id integer required

Id of the post to trash.

Response codes

200 Success

{
  "comment_count": "integer",
  "comments": [
    "object"
  ],
  "is_subscribed": "boolean",
  "id": "integer",
  "app_id": "integer",
  "text": "string",
  "html": "string",
  "plain": "string",
  "attachment_count": "integer",
  "attachments": [
    "object"
  ],
  "embed_id": "integer",
  "meeting_id": "integer",
  "option_count": "integer",
  "options": [
    "object"
  ],
  "reactions": [
    "object"
  ],
  "metadata": "object",
  "tags": [
    "string"
  ],
  "created_at": "string",
  "created_by_id": "integer",
  "modified_at": "string",
  "modified_by_id": "integer",
  "is_trashed": "boolean"
}

404 Not Found

400 Bad Request

Code sample
curl -X POST https://{WEAVY_SERVER}/api/posts/1/trash
-H "Authorization: Bearer {API-KEY}"

Restore post

Restore a post from the trash.

POST /api/posts/{id}/restore
Path parameters
id integer required

Id of the post to restore.

Response codes

200 Success

{
  "comment_count": "integer",
  "comments": [
    "object"
  ],
  "is_subscribed": "boolean",
  "id": "integer",
  "app_id": "integer",
  "text": "string",
  "html": "string",
  "plain": "string",
  "attachment_count": "integer",
  "attachments": [
    "object"
  ],
  "embed_id": "integer",
  "meeting_id": "integer",
  "option_count": "integer",
  "options": [
    "object"
  ],
  "reactions": [
    "object"
  ],
  "metadata": "object",
  "tags": [
    "string"
  ],
  "created_at": "string",
  "created_by_id": "integer",
  "modified_at": "string",
  "modified_by_id": "integer",
  "is_trashed": "boolean"
}
Code sample
curl -X POST https://{WEAVY_SERVER}/api/posts/1/restore
-H "Authorization: Bearer {ACCESS-TOKEN | API-KEY}"

List posts

List posts.

GET /api/posts
Query parameters
q string

A query used to find matching items.

tag string

List items with the specified tag.

trashed boolean

Indicates whether trashed items should be listed (default is false). Specify null to return both trashed and non-trashed items.

order_by string

Specifies the sort order and direction for the listing, e.g. "name" or "name+desc"

top integer

Maximum number of items to return in the listing. Should be a value between 0 and 100. Default is 25.

skip integer

The number of items to skip. Used together with top to return a specific range of items (for pagination).

count boolean

false to skip counting the total number of matching items; default is true.

count_only boolean

true to only return the number of matching items; when this is specified the response will only contain the count property.

Response codes

200 Success

{
  "data": [
    "object"
  ],
  "start": "integer",
  "end": "integer",
  "count": "integer"
}
Code sample
curl https://{WEAVY-SERVER}/api/posts
-H "Authorization: Bearer {ACCESS-TOKEN | API-KEY}"

Indicate typing

Indicate that the authenticated user is writing a post.

PUT /api/apps/{id}/posts/typing
Path parameters
id integer required

Id of app where user is typing.

Response codes

204 No Content

Code sample
curl -X PUT https://{WEAVY_SERVER}/api/apps/1/posts/typing
-H "Authorization: Bearer {ACCESS-TOKEN}"
Weavy Docs