Skip to main content

​
Use Postman for fast request prototyping.

The source collections live in voice_saas_api/docs/postman/. Treat these as maintained artifacts and version them with API contract changes.

​
Setup workflow

  1. Import collection and sandbox environment.
  2. Set CALLARO_API_KEY, CALLARO_PARTNER_KEY, and base URL variables.
  3. Run authentication and health requests first.
  4. Execute campaigns, contacts, numbers, and call log folders.
  5. Save examples and share workspace with your integration team.

​
Team maintenance guidance

  • Keep one canonical collection version for each release window.
  • Use environment files per sandbox and production.
  • Add request examples for common error responses.
  • Remove deprecated endpoints from team workspace promptly.

​
Validation checklist

  • All critical endpoint folders run without manual header edits.
  • Variables are scoped correctly for environment switching.
  • Example responses include success and error envelope shapes.