Reactions

The Reactions API enables you to create, list and delete reactions.

React to comment

Create reaction for a comment.

POST /api/comments/{id}/reactions
Path parameters
id integer required

Comment id.

Body parameters
content string required

A single emoji character describing the reaction, e.g. '👍' or '❤️'.

Response codes

204 No Content

404 Not Found

Code sample
curl https://{WEAVY-SERVER}/api/comments/1/reactions
-H "Authorization: Bearer {ACCESS-TOKEN}"
--json "{ 'content': '😍' }"

Unreact to comment

Delete authenticated user's reaction to a comment.

DELETE /api/comments/{id}/reactions
Path parameters
id integer required

Comment id.

Response codes

200 Success

404 Not Found

400 Bad Request

Code sample
curl -X DELETE https://{WEAVY_SERVER}/api/comments/1/reactions
-H "Authorization: Bearer {ACCESS-TOKEN}"

List comment reactions

List reactions for a comment.

GET /api/comments/{id}/reactions
Path parameters
id integer required

Comment id.

Query parameters
content string

Lists reactions with the specified emoji character. Omit this parameter to list all reactions.

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/comments/1/reactions
-H "Authorization: Bearer {ACCESS-TOKEN | API-KEY}"

React to message

Create reaction for a message.

POST /api/messages/{id}/reactions
Path parameters
id integer required

Message id.

Body parameters
content string required

A single emoji character describing the reaction, e.g. '👍' or '❤️'.

Response codes

204 No Content

404 Not Found

Code sample
curl https://{WEAVY-SERVER}/api/messages/1/reactions
-H "Authorization: Bearer {ACCESS-TOKEN}"
--json "{ 'content': '😍' }"

Unreact to message

Delete authenticated user's reaction to a message.

DELETE /api/messages/{id}/reactions
Path parameters
id integer required

Message id.

Response codes

200 Success

404 Not Found

400 Bad Request

Code sample
curl -X DELETE https://{WEAVY_SERVER}/api/messages/1/reactions
-H "Authorization: Bearer {ACCESS-TOKEN}"

List message reactions

List reactions for a message.

GET /api/messages/{id}/reactions
Path parameters
id integer required

Message id.

Query parameters
content string

Lists reactions with the specified emoji character. Omit this parameter to list all reactions.

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/messages/1/reactions
-H "Authorization: Bearer {ACCESS-TOKEN | API-KEY}"

React to post

Create reaction for a post.

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

Post id.

Body parameters
content string required

A single emoji character describing the reaction, e.g. '👍' or '❤️'.

Response codes

204 No Content

404 Not Found

Code sample
curl https://{WEAVY-SERVER}/api/posts/1/reactions
-H "Authorization: Bearer {ACCESS-TOKEN}"
--json "{ 'content': '😍' }"

Unreact to post

Delete authenticated user's reaction to a post.

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

Post id.

Response codes

200 Success

404 Not Found

400 Bad Request

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

List post reactions

List reactions for a post.

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

Post id.

Query parameters
content string

Lists reactions with the specified emoji character. Omit this parameter to list all reactions.

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/1/reactions
-H "Authorization: Bearer {ACCESS-TOKEN | API-KEY}"

Get reaction

Get a reaction by id.

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

Reaction id.

Response codes

200 Success

{
  "id": "integer",
  "content": "string",
  "created_at": "string",
  "created_by_id": "integer",
  "count": "integer"
}

404 Not Found

Code sample
curl https://{WEAVY-SERVER}/api/reactions/1
-H "Authorization: Bearer {ACCESS-TOKEN | API-KEY}"

Delete reaction

Delete a reaction.

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

Reaction id.

Response codes

200 Success

404 Not Found

400 Bad Request

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