This documentation outlines the API endpoints used in the Zapier integration for Yapp.
Authentication
All API requests require authentication using a bearer token in the Authorization header:
Authorization: Bearer YOUR_API_KEY
API Endpoints
Verify API Key
Verifies if the provided API key is valid and returns user information.
Request:
URL:
https://www.yapp.us/api/zapier/v1/verifyMethod:
GETHeaders:
Authorization: Bearer YOUR_API_KEY
Responses:
Status | Description |
200 OK | API key is valid |
401 Unauthorized | API key is invalid or revoked |
Example Successful Response:
{
"name": "John Doe",
"email": "john.doe@example.com"
}
Create Private App Email
Adds an email address to the list of approved users for a private app.
Request:
URL:
https://www.yapp.us/api/zapier/v1/private-app-emailsMethod:
POSTHeaders:
Authorization: Bearer YOUR_API_KEY
Parameters:
yapp_token_id(required): The Yapp ID of your appemail(required): The email address to add
Responses:
Status | Description |
201 Created | Email successfully added |
200 OK | Email already exists (idempotent) |
401 Unauthorized | API key is invalid or revoked |
403 Forbidden | Attempting to add an email to app for which you don't have admin privileges |
404 Not Found | Invalid yapp_token_id |
422 Unprocessable Entity | Invalid email format, missing yapp_token_id, or app not in private mode (see response body for details) |
Example Successful Response (201 Created):
{
"private_app_email": {
"email": "test@example.com",
"yapp_token_id": "EXAMPLE"
}
}Example Error Response (422 Unprocessable Entity):
{
"error": "Private app emails can only be added to apps in private mode",
"details": "Current mode: 'none'"
}
Important Notes:
Private app emails can only be added to apps with privacy mode set to 'private'
This endpoint is idempotent - attempting to add the same email twice will return a 200 OK status
You can only add emails to your own apps