Execute Action

This endpoint runs an action from a message returned by Get Conversation, such as booking one of the times a business offered. The result shows up in the conversation as a new message, and the business is notified.

Requires a consumer OAuth access token with the project_actions scope. The action must come from a conversation belonging to the consumer who authorized your application.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
^[a-z]{2,3}_[A-Z]{2}$

Locale code in the format of {language code}_{country code}. See the list of supported locales.

Body Params
string
required

The action_id from a message's actions in GetConversation.

inputs
array of objects

A value for each of the action's inputs, matched by input_id. Send every input marked required. For a CHOICE input, the value must be the option_id of one of its options. Can be left out when the action has no inputs.

inputs
Responses
201

The action ran and the business has been notified. The response body is empty.

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json