Authenticate requests using your GHL API credentials. Keep keys secure and rotate them regularly to protect data access.
Acumbamail uses its own API token or OAuth flow. Safely store credentials and grant appropriate scopes for object access.
GET /objects/:key — Retrieve a specific object by key; GET /objects — List objects; objects/schema.write — Create or update object schemas; objects/record.readonly — Read object records; GET /objects/:schemaKey/records/:id — Retrieve a single record; objects/record.write — Create or update a record; POST /objects/:schemaKey/records — Create records; PUT /objects/:schemaKey/records/:id — Update a record; DELETE /objects/:schemaKey/records/:id — Delete a record. Note: Endpoints 10–17 are not used on this page but are available for future expansion.
Trigger: when you need a quick snapshot of object keys and sample records to inform campaigns.
Actions: use GET /objects/:key and GET /objects/:schemaKey/records/:id to pull data into Acumbamail for segmentation.
GET /objects/:key
Key fields: key, schemaKey, id
Trigger: new or updated contact data in Acumbamail should be pushed to GHL as object records.
Actions: POST /objects/:schemaKey/records to create, PUT /objects/:schemaKey/records/:id to update.
POST /objects/:schemaKey/records
Fields: schemaKey, record payload (field mappings)
Trigger: scheduled pulls to keep dashboards and reports up to date without writes.
Actions: GET /objects and GET /objects/:schemaKey/records/:id for read-only access.
GET /objects
Fields: keys, schemaKey, id
No-code data sync keeps lists fresh without manual CSV imports.
Automated audience updates power targeted campaigns in Acumbamail.
Dynamic field mapping enables personalized messaging with minimal setup.
A quick glossary of terms and processes used when connecting the GHL Custom Objects API to Acumbamail.
A token used to authenticate requests to the GHL Custom Objects API.
A URL path that exposes a specific function in the API, such as retrieving objects or records.
A structured collection of object definitions and fields.
A single row within an object, representing an instance of data.
Use object fields to dynamically segment audiences in Acumbamail for personalized emails.
Push new or updated records from GHL into Acumbamail to keep lists current automatically.
Trigger Acumbamail campaigns when object data changes to drive timely communications.
Collect API keys from GHL and Acumbamail; store securely and share only where needed.
Map GHL object fields to Acumbamail contact fields and configure endpoints for sync.
Run test syncs, verify data integrity, and set up automation rules for ongoing syncs.
The Custom Objects API provides programmatic access to object definitions and records within GHL. It lets you read, create, update, and delete object data as part of integrations. Start by authenticating with your GHL API key and, if required, set up a dedicated app credential for Acumbamail. This keeps access scoped and secure. You can then explore endpoints to list objects, fetch records, and manage schemas. Two-paragraph guidance helps you begin safely and efficiently.
Authentication involves using your GHL API key to authorize requests and, for Acumbamail, using its token or OAuth flow. Store credentials securely (e.g., in a secret manager) and rotate keys periodically. Apply the principle of least privilege by granting only the necessary scopes for object read/write operations. In practice, keep keys out of code and use environment variables or vaults.
Common endpoints for syncing include GET /objects/:key to read a specific object, GET /objects to list objects, and POST /objects/:schemaKey/records to create records. For updates, use PUT /objects/:schemaKey/records/:id, and for deletions use DELETE /objects/:schemaKey/records/:id. This set covers most create/read/update/delete workflows across GHL objects and Acumbamail data.
Yes. The API supports reading object definitions and records (readonly or with write access depending on credentials). Create and update operations are performed through schema and record endpoints. Always validate responses and implement error handling, including 4xx client errors and 5xx server errors, to ensure robust automation.
Field mapping is done by aligning GHL object fields with corresponding Acumbamail contact fields. Use schema definitions to understand available fields and types, then transform payloads accordingly. Consider creating a mapping document to guide future changes and maintain consistency across campaigns.
Rate limits depend on your GHL plan and API usage. Plan for retries with exponential backoff, implement idempotent operations where possible, and monitor quota usage. If you anticipate spikes, consider batching requests to stay within limits.
Example payloads and sample requests are typically available in official docs or starter templates. Use these as a baseline and adapt field names to your object definitions. Test payloads in a sandbox or staging environment before moving to production.
Due to high volume, we will be upgrading our server soon!
Complete Operations Catalog - 126 Actions & Triggers
