Action APIs

Overview

Action APIs allow users to create various reactions to an action using their choice of emoji. It is designed for developers building chat applications.

Base URL

https://api.actionsapp.com/v1

Authentication

All API requests require an access token. You can obtain your access token by signing up at the Action API Developer Portal.

Header Example

Action-Authentication: {YOUR_ACCESS_TOKEN}

API Endpoints

Create Reaction for Action

This API allows a user to add a new reaction to an action.

Request

POST /actions/{action-id}/reactions

The following table lists the optional request attributes.

Attribute	Type	Description
shortName	String	The primary short name of the emoji to add.
skinVariation	String	The skin variation of the emoji to add.
native	String	The emoji to add as a native unicode emoji.
unified	String	The unified value of the emoji to add.

Examples

Client Request

{
  "shortName": "Smiling face",
  "skinVariation": "medium-light skin tone",
  "native": "U+1F642",
  "unified": "Slightly_Smiling_face"
}

Server Response

200 OK
{
  "id": 12345
}

Get the List for an Action

This API allows users to get a list for an Action.

Request

GET /actions/{action-id}/list

Response

The following table lists the default response attributes.

Attribute	Type	Description
id	String	The list ID.
name	String	The name of the list.
closed	Boolean	Indicates whether the list is closed.
subscribed	Boolean	Indicates whether the list is subscribed.
limits	Object	The limits for the list.

Examples

Client Request

GET /actions/12345/list

Server Response

{
    "id": "5abbe4b7ddc1b351ef961414",
    "name": "Things to buy today",
    "closed": true,
    "subscribed": true,
    "limits": {
        "attachments": {
            "perBoard": {
                "status": "ok",
                "disableAt": 36000,
                "warnAt": 32400
            }
        }
    }
}

Update an Action

This API allows users to update a particular action. Only comment actions can be updated.

Request

PUT /actions/{id}

The following table lists the required request attributes.

Attribute	Type	Description
text	String	The new text for the comment.

Examples

Client Request

PUT /actions/12345
{
  "text": "This comment is now updated with this action."
}  

Server Response

200 OK

Delete Action

This API allows users to delete an action.

Request

DEL /actions/{action-id}

Examples

Client Request

DEL /actions/12345

Server Response

200 OK
Success

Find Action

This API allows users to find an action.

Request

POST /actions/find

The following table lists the optional request attributes.

Attribute	Type	Description
id	String	The list ID.
name	String	The name of the list.
closed	Boolean	Indicates whether the list is closed.

Response

The following table lists the default response attributes.

Attribute	Type	Description
id	String	The list ID.
name	String	The name of the list.
closed	Boolean	Indicates whether the list is closed.
subscribed	Boolean	Indicates whether the list is subscribed.
limits	Object	The limits for the list.

Examples

Client Request

POST /actions/find
{
   "name": "Things to buy today"
}

Server Response

200 OK
{
    "id": "5abbe4b7ddc1b351ef961414",
    "name": "Things to buy today",
    "closed": true,
    "subscribed": true,
    "limits": {
        "attachments": {
            "perBoard": {
                "status": "ok",
                "disableAt": 36000,
                "warnAt": 32400
            }
        }
    }
}

Error Codes

Status Code	Description
200	Request was successful.
400	Bad request. Missing or invalid fields.
401	Unauthorized. Invalid Authentication Parameters.
404	Resource not found.
500	Internal server error.

Examples

{
	"errorKey": "EK.badToken",
	"message": "You are unauthorized to use this service. Invalid authentication parameters.",
	"help": "View documentation at http://actionapi.actions.com/",
	"title": "Login failed",
	"status": "401 Unauthorized"
}

Rate Limits

Plan	Limit
Free Plan	6 tps
Pro Plan	2,000 tps

Requests exceeding the limit will return a 429 Too Many Requests error.

Best Practices

• Cache responses to minimize redundant API calls.
• Handle rate-limiting errors gracefully and retry after the specified time.
• Use HTTPS for secure communication.