FirstPromoter icon

FirstPromoter

Interact with the official FirstPromoter APIs

Custom API → Custom FirstPromoter API Call

AI-generated

Summary

Make a custom HTTP request to any FirstPromoter API v2 endpoint by specifying the relative URL path, HTTP method, and optional query, header, and body parameters.

Inputs

  • URL Path (required) — The relative path of the FirstPromoter API endpoint to call, without the base URL (https://api.firstpromoter.com/v2). For example, '/company/promoters'.
  • Method (required) — The HTTP method to use for the API call, such as GET, POST, PUT, or DELETE.
  • Send Query Parameters — Toggle to specify if query parameters should be sent.
  • Query Parameters — One or more query parameters to include with the request, each consisting of a name and value.
  • Send Headers — Toggle to specify if custom header parameters should be sent.
  • Headers — One or more custom header parameters to include with the request, each consisting of a name and value.
  • Send Body — Toggle to specify if a JSON body should be sent with the request.
  • Body — The JSON object to send as the body of the request, required if 'Send Body' is true.

Output shape

A single JSON array containing the response data from the custom API call.

The node returns the parsed JSON response from the FirstPromoter API wrapped in a JSON array. Authentication credentials must be configured in the node's settings. If the URL path is missing or invalid, or authentication fails, the node throws an error with descriptive messaging.

Examples

Example 1: GET request to list promoters

Set URL Path to '/company/promoters', Method to GET, and do not send body, query, or header parameters.

Example 2: POST request to create a promoter

Set URL Path to '/company/promoters', Method to POST, enable 'Send Body' and provide a valid JSON object in the Body parameter with promoter details.

Links

Discussion