Create a StoredAction

curl --request POST \
  --url https://api.zapier.com/actions/v1/stored-actions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "connection_id": "019320ab-0000-7000-8000-abcdef012345",
    "selected_api": "SplitwiseCLIAPI@1.0.0",
    "action_key": "new_contact",
    "action_type": "read",
    "inputs": {
      "first_name": "John",
      "last_name": "Doe"
    }
  }
}
'

{
  "type": "stored_action",
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Stored Actions

Create a StoredAction

Create Stored Action

Creates a new stored action entry that can then be executed from a simpler call to /stored-actions with just the stored action id.

This will not execute a StoredAction.

This is an async process and will only respond with the id of the stored action and other meta data, and it is the callers responsibility to poll GET /stored-actions//runs/ with the run id returned from POST /stored-actions//run to fetch the results after executing a stored action.

The triple (selected_api, action_type, action_key) is required to create a stored action. Only core actions are supported; external and custom (App Extension) actions cannot be created as stored actions via this endpoint.

Note on connection_id: Other Zapier APIs may expose the same identifier under the field name authentication_id. The value is the same UUID — pass it here under the connection_id key.

POST

actions

stored-actions

Create a StoredAction

curl --request POST \
  --url https://api.zapier.com/actions/v1/stored-actions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "connection_id": "019320ab-0000-7000-8000-abcdef012345",
    "selected_api": "SplitwiseCLIAPI@1.0.0",
    "action_key": "new_contact",
    "action_type": "read",
    "inputs": {
      "first_name": "John",
      "last_name": "Doe"
    }
  }
}
'

{
  "type": "stored_action",
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Authorizations

Authorization

string

header

required

OAuth 2.0 authentication.

Body

application/json

data

object

required

The shape of the payload that must be sent to create a Stored Action.

Only the triple (selected_api, action_type, action_key) is accepted — action_id is intentionally not exposed on this endpoint.

Show child attributes

Response

A StoredAction record was successfully created.

The response returned from creating a Stored Action record.

string<uuid>

required

The UUID id that identifies this stored action and can be used to execute the stored procedure by calling the POST /stored-actions/{stored_action_id}/run endpoint.

type

string

default:stored_action

Specifies the resource type, as required by the JSON:API specification.

Get a read-only list of StoredAction records for the caller Get a read-only StoredAction record by id

⌘I