object_association_definitions
ChatGPTList the association definitions a CRM object type can participate in — the valid links to other object types (source_object, target_object, association_name, cardinality, is_default), and what each side calls the link (source_object_label, target_object_label). Use this to discover which target types object_list's associations parameter, object_record_associations, and the associations of object_create and object_update accept. Optionally restrict to definitions linking to one target type.
object_batch
ChatGPTApply one operation (create or update) to many records of an object type in a single call. Tasks must use USER_TASK; AI task types are reserved. Each record is processed independently: a per-item failure is reported in the results (keyed by its request-body index, with an errors array) and never aborts the rest of the batch. all_or_none=true (transactional) is not supported yet — only false is accepted. For update, each record must carry its id under id_property (default 'id'). Delete is not a batch operation — passing it is rejected; delete one record at a time with object_delete.
object_create
ChatGPTCreate a record of an object type from a properties map (snake_case field names). Runs the same validation and RBAC as the REST API. Optionally link the new record to existing records via associations. Returns the created record envelope (with the created links embedded when associations were supplied). Call object_describe first if unsure which properties are valid. Tasks must use USER_TASK; AI task types are reserved. A new deal or company takes product_ids. To change the products of a company, also send product_change_rationale. An update cannot change the products of a deal. Sending the stored product_ids again is not a change.
object_delete
ChatGPTDelete a record by id. Destructive and irreversible. Returns an acknowledgement with the deleted id and type.
object_describe
ChatGPTReturn the schema for one CRM object type: its label, description, and field definitions (name, type, whether multi-valued). Call this before creating or updating records to learn the valid property names and types. DROPDOWN fields list their choices as {id, label} objects; write and filter on a choice's id, never its label. Links to other records are not fields: find them with object_association_definitions and write them through the associations of object_create and object_update. A reference to configuration or to a user is a field that holds its id: write the id directly, and get it from pipeline_list, stage_list, product_list or user_list.
object_filter
ChatGPTFind records of an object type matching a structured filter. The request has filterGroups (groups are OR'd, filters within a group are AND'd; each filter is fieldPath + operator + value or values), optional sort (field + direction), and optional pagination (1-based page starting at 1 with a default of 1, plus size). Operators include EQUALS, NOT_EQUALS, CONTAINS, GREATER_THAN, LESS_THAN, IN, IS_NULL, BETWEEN. RBAC-scoped. Returns the v2 page envelope.
object_get
ChatGPTFetch one record of an object type by id, as the v2 snake_case envelope. RBAC-checked.
object_list
ChatGPTList records of one object type as a paginated v2 envelope (results + metadata), RBAC-scoped to the caller. Use object_filter when you need conditions; this returns records in id order. Pass associations to embed each record's linked ids grouped by target type (ids only, not expanded records) — call object_association_definitions to discover valid target types. Only fully listable target types can be embedded here; for read-by-id-only targets, page their links per record with object_record_associations.
object_record_associations
ChatGPTPage the association links from one record to a target object type — the linked record ids and association name only (never expanded records), RBAC-checked. Hydrate the returned ids with object_get or object_filter (id IN [...]). Use object_association_definitions to find valid target types.
object_types
ChatGPTList the slugs of every CRM object type registered for the current tenant (standard objects like contact, company, deal plus any custom objects). Use this to discover what types the other object_* tools can operate on.
object_update
ChatGPTPartially update a record by id: only the provided properties change and omitted fields are preserved (merge, not replace — ADR-026). Optionally add links to other records via associations; the record keeps its other links. Returns the updated record envelope (with the links of each named target type embedded when associations were supplied). Tasks must use USER_TASK; AI task types are reserved.
pipeline_get
ChatGPTFetch one deal pipeline by numeric id as a v2 record envelope. Read-only.
pipeline_list
ChatGPTList up to 100 deal pipelines the caller may view in the current tenant. Read-only.
product_get
ChatGPTFetch one product by numeric id as a v2 record envelope. Read-only.
product_list
ChatGPTList up to 100 products of the current tenant as v2 record envelopes. A deal or a company holds product ids in its product_ids property. A new deal or company takes product_ids. To change the products of a company, also send product_change_rationale. An update cannot change the products of a deal. Sending the stored product_ids again is not a change. Read-only.
stage_get
ChatGPTFetch one pipeline stage by numeric id as a v2 record envelope. Read-only.
stage_list
ChatGPTList all pipeline stages of the current tenant as v2 record envelopes. Read-only.
task_reassign
ChatGPTHand a task to another rep. This is the only way to change a task's owner; object_update refuses an owner change. A hand-off also moves the email draft's copy list, queues the rewrite for a task that carries a draft, and tells the new holder. The caller must hold the task or be a tenant admin. The task must be open and of a kind that may move, and the new holder must be an activated colleague who can see every record the task is linked to — call task_reassign_targets first to get the people who qualify. Returns an acknowledgement; read the moved task with object_get('task', id).
task_reassign_targets
ChatGPTList the colleagues a task can be handed to: every activated user in the tenant except the person holding it, who can also see every record the task is linked to. The list never offers somebody task_reassign would refuse. Read-only.
user_get
ChatGPTFetch one user (team member) by numeric id as an id, name, email, role and status summary. Finds a deleted user too. Read-only.
user_list
ChatGPTList the current users (team members) of the current tenant as id, name, email, role and status summaries. Deleted users are not in the list; user_get finds one by id. Read-only.
user_me
ChatGPTIdentify the user this connection acts as — the owner of the API key or the signed-in account — as an id, name, email, and role summary. Call this before any request phrased as "my" or "mine" (my tasks, my deals, assign it to me), then filter on the id it returns. Read-only.