Access to the Contacts API requires secure authentication. Use the API key or OAuth token with the specified scope (contacts.readonly) to authorize requests. Store credentials securely and rotate them regularly.
For Eduzz, authenticate through a dedicated API key scoped to contacts access. Use secure storage and follow best practices for token rotation. Grant only the permissions needed to connect contacts and related data objects.
Key endpoints include: 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; 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 created or updated in Eduzz, push changes to the Contacts API to keep records synchronized in real time.
Actions: create or update a contact in the Contacts API using POST /contacts/ or PUT /contacts/:contactId; optionally update related tasks and notes as changes occur.
Key methods: POST /contacts/ to create, PUT /contacts/:contactId to update.
Key fields: email, firstName, lastName, phone, externalId
Trigger: when a task is created or updated in Eduzz, mirror the change in the Contacts API.
Actions: create or update tasks via POST /contacts/:contactId/tasks and PUT /contacts/:contactId/tasks/:taskId; optionally delete when needed.
Methods: POST /contacts/:contactId/tasks, PUT /contacts/:contactId/tasks/:taskId, DELETE /contacts/:contactId/tasks/:taskId
Key fields: title, dueDate, status, description
Trigger: Eduzz tag updates trigger synchronization in the Contacts API to reflect tagging in real time.
Actions: update tags via POST /contacts/:contactId/tags; ensure tagNames is populated on the Contacts record.
Methods: POST /contacts/:contactId/tags
Key fields: tags, tagIds
Fast setup with ready-made endpoints and guided templates, so you can connect without writing code.
Automated data flow between Eduzz and the Contacts API reduces manual entry and minimizes errors.
A unified view of contacts enables smarter campaigns and efficient team collaboration.
This glossary covers API basics: endpoints, authentication, triggers, actions, data mapping, and error handling to help you implement the Eduzz-to-Contacts workflow.
An interface that allows software applications to communicate and share data.
A URL callback that delivers real-time data updates from a service to your app.
A process that verifies the identity of a request, typically via API keys or tokens.
A specific URL path used to access a resource in an API.
Automate onboarding by creating contact records in the Contacts API when a new Eduzz customer signs up, then assign initial tasks.
Pull Eduzz events to enrich Contacts records with notes and tags for smarter segmentation.
Build dashboards that display data from the API endpoints and fire alerts when critical tasks are due.
Collect your Eduzz API credentials and define the required scope for contacts access.
Map Eduzz fields to Contacts API fields and set up triggers for real-time syncing.
Run tests with sample data, verify logs, and deploy to production with monitoring in place.
No coding is required to get started thanks to no-code connectors and templated workflows. You can begin with prebuilt endpoint templates and gradually customize mappings. If you prefer hands-on setup, the API docs provide clear examples for common tasks.
Supported authentication includes API keys and OAuth tokens. Use tokens with the minimum required scope (e.g., contacts.readonly) and rotate credentials regularly. Store credentials securely and audit access.
Start with the core endpoints for contacts (GET /contacts/:contactId, POST /contacts/ and PUT /contacts/:contactId) to establish basic data flow. Expand to tasks, notes, and tags as you validate synchronization.
Data mapping is about aligning Eduzz fields to Contacts API fields (e.g., email, name, phone). Use field mappings to ensure triggers send the right data, and test with sample records to confirm accuracy.
Yes. Use sandbox or test data environments and preview logs. Validate transformations before pushing changes to live data, and enable monitoring to catch issues quickly.
Rate limits depend on your plan and endpoint usage. Plan for bursts by implementing retries with exponential backoff and caching frequently requested data when possible.
Logs and errors are accessible in your integration workspace or connected app dashboard. Review error messages, retry failed operations, and adjust mappings or credentials as needed.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
