GEgetfrontline
Custom Tools

Test a tool

Changed on

Executes a persisted API call tool with the provided argument values and returns the HTTP response. Requires a USER API key.

post/public/v1/tools/{toolId}/test

Request

Path parameters

toolIdnumber nullable
Example:123

Request body

valuesobject

Argument values keyed by argument name. Every declared tool argument must be present.

Example request

{
  "values": {
    "contactId": "42"
  }
}

Response

Tool test result

statusnumber required
headersobject required
dataobject nullable
durationnumber required

Request duration in milliseconds

contentLengthnumber nullable

Example response

{
  "status": 200,
  "headers": {
    "content-type": "application/json"
  },
  "duration": 245,
  "contentLength": 128
}

Changes

  • 666cd9efa9f3Revision changes
    • warning

      added the new upgrade_required enum value to the / response property for the response status

    • warning

      added the new upgrade_required enum value to the / response property for the response status