Skip to main content

What API Tools Are

Workspace API Tools are saved HTTP requests that Tuco can call when it builds a message. Use them to personalize messages — pull data from your backend into message variables.

Creating an API Tool

  1. Go to Integrations → API Tools
  2. Click + Add Tool
  3. Configure:
    • Name — e.g. “Check DNC Status” (becomes variable {api_check_dnc_status})
    • Method — GET, POST, PUT, PATCH, DELETE
    • URL — supports lead variables: https://api.example.com/check/{phone}
    • Headers — authorization, content-type, etc.
    • Body — JSON request body (with validator and format button)
    • Response mapping — dot-path to extract from response (e.g. data.status)
  4. Test with a real lead to verify it works
  5. Save

URL Variables

Use lead data in the URL or request body:

Response Mapping

The dot-path tells Tuco which value to extract from the JSON response:

Using in Messages

Important Notes

  • API tools are workspace-level — all team members can use them
  • Calls are made in real-time when the message is built
  • Test tools before using them in live sends