API Request actions in Zapier

API Request action is a feature that allows you to make raw HTTP requests to supported public apps within the Zap editor.  

With the API Request action, you can:

• Directly interact with the API when an existing app on Zapier does not have the actions that you need.
• Use your personal app connection accounts to automatically set the authentication header.
• View comprehensive API responses.

When to use API Request actions

Zapier recommends using API Request actions if you need to use a specific action in a single Zap. It is not intended for reuse in other Zaps. If you need to create an action that can be reused in other Zaps, consider using Custom Actions instead.

Learn how to set up your API Request action.

Error handling

With API Request actions, you have control over how Zaps handle errors using the Stop on error field.

If you select “Yes”:

• Zap runs will error if the app’s API does not return a 200 (OK) status code.
• Zapier will automatically attempt to refresh expired or invalid authentication tokens.
• If the app’s API returns an error, the API response will not include the full response data. 
  • However, you can use custom error handling to define how the Zap should proceed if the API call returns an error.

If you select “No”:

• Zap runs are always successful, regardless of the API’s response status code.
• The API response will always include the full response data, containing information about the error code, message, and status.
• If the app has custom error response handling for status codes above 400, Zap runs may error.

Limitations

• The API Request action is not available for all public apps. Review the list of supported apps.
• The API Request action is not available for private apps.
• You cannot use app connections owned by other members, even if they've been shared with you.
• If the API changes, you may need to update your API Request action.