Use your API key with the Contacts API and ensure your Bannerbear API key is valid. The provided scope is ‘contacts.readonly’, limiting to read operations.
Generate and securely store a Bannerbear API key and grant access to the templates that will receive contact data.
GET /contacts/:contactId; GET /contacts/:contactId/tasks; GET /contacts/:contactId/tasks/:taskId; GET /contacts/:contactId/notes; GET /contacts/:contactId/notes/:id; GET /contacts/:contactId/appointments; GET /contacts/; GET /contacts/business/:businessId; contacts.write; POST /contacts/; PUT /contacts/:contactId; DELETE /contacts/:contactId; POST /contacts/:contactId/tasks; PUT /contacts/:contactId/tasks/:taskId; PUT /contacts/:contactId/tasks/:taskId/completed; DELETE /contacts/:contactId/tasks/:taskId; POST /contacts/:contactId/tags
Trigger: when a contact is selected or updated in Bannerbear, pull the latest contact data from the API.
Actions: GET /contacts/:contactId to fetch details, GET /contacts/:contactId/tasks for related tasks, GET /contacts/:contactId/notes for context.
GET /contacts/:contactId
Required key fields: contactId, name, email
Trigger: a new banner is created in Bannerbear which triggers adding a contact via the API.
Actions: POST /contacts/ to create, POST /contacts/:contactId/tasks to assign tasks, PUT /contacts/:contactId to update.
POST /contacts/
Required fields: name, email
Trigger: updates to tasks or notes in Contacts API reflect in Bannerbear banners.
Actions: PUT /contacts/:contactId/tasks/:taskId, PUT /contacts/:contactId/tasks/:taskId/completed, GET /contacts/:contactId/notes.
PUT /contacts/:contactId/tasks/:taskId
Key fields: taskId, status, dueDate
Automate banner generation from live contact data without writing custom code.
Speed up marketing content creation by driving banners directly from contact updates and tasks.
Centralized workflow control through a single integration that exposes multiple endpoints.
Definitions of terms and processes used throughout this integration guide.
A set of endpoints and methods that let Bannerbear and Contacts API communicate.
A specific URL path in an API used to perform an operation.
The level of access granted to API requests (e.g., readonly).
A secret used to authorize API requests.
Automatically generate banners in Bannerbear using real-time contact data from the Contacts API.
Update banners when a contact’s tasks are updated via the API.
Incorporate key notes into banners to reflect context.
Register and exchange credentials for both services and verify access tokens.
Choose endpoints you need and define triggers in your workflow to drive banner updates.
Run tests, verify data flow, and monitor logs to ensure reliable banners.
Both API integrations use token-based authentication. For the Contacts API, use your API key, and ensure your Bannerbear key is valid. If your scope is set to ‘contacts.readonly’, you’ll be limited to read operations. Keep your tokens secure and rotate them regularly. Always use HTTPS for requests.
With the readonly scope, many endpoints are read-only (GET requests). If you need write access (POST, PUT, DELETE), you must request elevated scopes or use a dedicated integration user. Always apply the principle of least privilege.
Use webhooks or event-driven triggers in Bannerbear to respond to contact updates. Map the contactId to the banner data field, and configure a Zapier or custom workflow to pull the latest details via GET /contacts/:contactId and refresh the banner content.
Yes. With proper scopes, you can create or update contacts via POST /contacts/ and PUT /contacts/:contactId. Bannerbear visuals can reflect new or updated contact data after successful writes. Validate data before sending and test in a staging environment.
Required fields vary by endpoint. Typically, creating a contact requires name and email; updating a contact requires contactId; tasks require contactId and task details; notes require content. Refer to the endpoint docs for exact field requirements and validation rules.
Common errors include 401 unauthorized, 403 forbidden, 404 not found, and 422 validations. Ensure tokens are valid, endpoints exist, IDs are correct, and required fields are supplied. Implement retry logic with backoff for transient issues.
Rate limits depend on your account tier and endpoint type. Check response headers for remaining quota and reset times. If you hit the limit, back off and retry after the recommended interval; request higher quotas if needed.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
