Encharge Custom Objects API
The Custom Objects API from Encharge — 11 operation(s) for custom objects.
Operations 18
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“How do I list all my company records?”
“Can I page through custom object records sorted by a field?”
Tell an agent
List all {objectName} records.
List {limit} {objectName} records sorted by {sort}.
Ask an LLM
“How do I add brand-new company records?”
“Can I create several new records of a custom object in one call?”
Tell an agent
Create new {objectName} records.
Add fresh records to the {objectName} object, insert only.
Ask an LLM
“How do I create a company record or update it if it already exists?”
“Can I upsert a custom object record by its external ID?”
Tell an agent
Upsert a {objectName} record with external ID {externalId}.
Create or update the {objectName} record {id}.
GET
/objects/{objectName}/segments/{segmentId}
List custom object records in a segment · Get custom objects in segment
#
Ask an LLM
“How do I see which companies fall into a particular segment?”
“Can I page through the records of a segment of custom objects?”
Tell an agent
List the {objectName} records in segment {segmentId}.
Show {limit} {objectName} records from segment {segmentId}.
Ask an LLM
“How many company records do I have in total?”
“What's the total number of records stored in a custom object?”
Tell an agent
Count all {objectName} records.
Tell me how many {objectName} records exist overall.
GET
/objects/{objectName}/segments/{segmentId}/count
Count custom object records in a segment · Get custom objects in segment count
#
Ask an LLM
“How many companies are in a given segment?”
“What is the size of a custom object segment?”
Tell an agent
Count the {objectName} records in segment {segmentId}.
Give me the size of segment {segmentId} for {objectName}.
Ask an LLM
“How do I search my company records by name?”
“Can I restrict a custom object search to one segment?”
Tell an agent
Search {objectName} records for {query}.
Search {objectName} records for {query} within segment {segmentId}.
Ask an LLM
“How do I fetch one company record by its Encharge ID?”
“Can I retrieve a single custom object record if I know its id?”
Tell an agent
Get {objectName} record {id}.
Show me the details of {objectName} {id}.
Ask an LLM
“How do I edit an existing company record I know the Encharge ID of?”
“Can I set an external ID on a custom object record after it's created?”
Tell an agent
Update {objectName} record {id}.
Set external ID {externalId} on {objectName} record {id}.
Ask an LLM
“How do I remove a company record using its Encharge ID?”
“Can I delete one custom object record by id?”
Tell an agent destructive · confirm first
Delete {objectName} record {id}.
Remove the {objectName} with Encharge ID {id}.
GET
/objects/{objectName}/externalId/{externalId}
Get a custom object record by external ID · Get custom object by external id
#
Ask an LLM
“How do I look up a company using the ID from my own system?”
“Can I fetch a custom object record by its external ID instead of the Encharge ID?”
Tell an agent
Get the {objectName} record with external ID {externalId}.
Find {objectName} by my system's ID {externalId}.
PATCH
/objects/{objectName}/externalId/{externalId}
Update a custom object record by external ID · Update custom object by external id
#
Ask an LLM
“How do I update a company record when I only have my CRM's ID for it?”
“Can I patch a custom object record addressed by external ID?”
Tell an agent
Update the {objectName} record with external ID {externalId}.
Patch {objectName} {externalId}, looked up by external ID.
DELETE
/objects/{objectName}/externalId/{externalId}
Delete a custom object record by external ID · Delete custom object by external id
#
Ask an LLM
“How do I delete a company record using my own system's ID?”
“Can I remove a custom object record by external ID?”
Tell an agent destructive · confirm first
Delete the {objectName} record with external ID {externalId}.
Remove {objectName} {externalId} using its external ID.
GET
/objects/{objectName}/{id}/associations/{associationId}
List records linked through one association · Get objects by association
#
Ask an LLM
“How do I list the people who are employees of a specific company?”
“Can I get only the objects linked to a record through one particular association?”
Tell an agent
List objects linked to {objectName} {id} through association {associationId}.
Show {limit} records associated with {objectName} {id} via association {associationId}.
GET
/objects/{objectName}/{id}/associations
List everything associated with a record · Get all associated objects
#
Ask an LLM
“How do I see every object connected to a company, across all association types?”
“What records are linked to this custom object in any way?”
Tell an agent
List all objects associated in any way with {objectName} {id}.
Show up to {limit} linked records of any kind for {objectName} {id}.
POST
/objects/{objectName}/{id}/associations/default/{targetObjectName}/{targetId}
Link two records using the default association · Associate objects by default association
#
Ask an LLM
“How do I link a contact to a company without knowing the association ID?”
“Can I connect two objects when there's only one association between their types?”
Tell an agent
Link {objectName} {id} to {targetObjectName} {targetId} using the default association.
Attach person {id} to {targetObjectName} {targetId} with the default link, object type {objectName}.
POST
/objects/{objectName}/{id}/associations/{associationId}/{targetId}
Link two records through a specific association · Associate custom objects
#
Ask an LLM
“How do I associate two records using a named association like Owner or Manager?”
“Can I pick which association schema to use when linking two objects?”
Tell an agent
Link {objectName} {id} to {targetId} through association {associationId}.
Associate {objectName} {id} with record {targetId} using association schema {associationId}.
DELETE
/objects/{objectName}/{id}/associations/{associationId}/{targetId}
Unlink two associated records · Remove custom objects association
#
Ask an LLM
“How do I unlink a person from a company?”
“Can I remove the association between two records without deleting either one?”
Tell an agent destructive · confirm first
Unlink {objectName} {id} from {targetId} in association {associationId}.
Remove association {associationId} between {objectName} {id} and record {targetId}.