REST endpoints v1
The PostPal REST API v1 provides production endpoints for programmatic campaigns and postcards. The most relevant endpoints are currently POST /api/v1/campaigns and POST /api/v1/postcards. Every request needs a valid account API token and is recorded in the API logs.
The REST API v1 is the programmatic interface for technical integrations.
Important endpoints:
POST /api/v1/campaigns- create campaigns programmatically.POST /api/v1/postcards- submit postcard requests.
Every request needs an account API token. Use the developer page, OpenAPI file or Postman file to check payload structure and required fields precisely.
Frequently asked questions
- Which REST endpoints are available?
- The v1 API provides endpoints for campaigns and postcards: POST /api/v1/campaigns and POST /api/v1/postcards.
- How do I authenticate API requests?
- Use an account API token from the PostPal API settings.
- Is there machine-readable documentation?
- Yes. PostPal provides OpenAPI and Postman exports for the developer documentation.