API
Customers
Objects and fields, records, list views, search, pipelines, activities, imports and exports.
See Customers. Records are read and changed as the caller: what sharing and their role allow. Keys act as their maker, narrowed by the key's scopes.
Every route below, with its parameters, request and response, errors and samples, is in the API reference.
| Route | What it does |
|---|---|
GET /v1/orgs/:orgId/crm/objects | Every object with its fields, validation rules and indexes. |
POST /v1/orgs/:orgId/crm/objects | A custom object (Customers admins): a name field, the system fields and the built-in indexes. |
GET /v1/orgs/:orgId/crm/objects/:object | One object with its fields, validation rules and indexes. |
PATCH /v1/orgs/:orgId/crm/objects/:object | Labels, sharing default, default columns and search subtitle (Customers admins), over version. |
DELETE /v1/orgs/:orgId/crm/objects/:object | Deletes a custom object without records. |
POST /v1/orgs/:orgId/crm/objects/:object/fields | Adds a custom field (Customers admins): text, number, currency, date, picklist, multi-picklist, checkbox, lookup, email, phone or URL; required makes it required. |
PATCH /v1/orgs/:orgId/crm/objects/:object/fields/:field | Changes a field's label, help, required, picklist values or lookup, over the object's version. |
DELETE /v1/orgs/:orgId/crm/objects/:object/fields/:field | Deletes a custom field, with its rules and indexes (their entries go in the background). |
PUT /v1/orgs/:orgId/crm/objects/:object/rules | Replaces the object's validation rules. |
POST /v1/orgs/:orgId/crm/objects/:object/indexes | Adds an index (built in the background): up to two equality fields and a sort field. |
DELETE /v1/orgs/:orgId/crm/objects/:object/indexes/:indexId | Drops a custom index (its entries go in the background); built-in ones stay. |
GET /v1/orgs/:orgId/crm/objects/:object/views | Built-in, shared and the caller's own list views. |
POST /v1/orgs/:orgId/crm/objects/:object/views | Saves a view (shared ones: Customers admins); an index it needs is added and built. |
PATCH /v1/orgs/:orgId/crm/objects/:object/views/:viewId | Changes a saved view (the caller's own; shared ones: Customers admins). |
DELETE /v1/orgs/:orgId/crm/objects/:object/views/:viewId | Deletes a saved view (the caller's own; shared ones: Customers admins). |
GET /v1/orgs/:orgId/crm/objects/:object/records | A page of records by a view, or filters (JSON) and sort; cursor continues. |
POST /v1/orgs/:orgId/crm/objects/:object/records/query | The same list with the filters in the body. |
POST /v1/orgs/:orgId/crm/objects/:object/records | Creates a record owned by the caller (or ownerId); field errors come back as 422 with errors. |
POST /v1/orgs/:orgId/crm/objects/:object/records/bulk | Updates, transfers or deletes many records; each reports its own result. |
GET /v1/orgs/:orgId/crm/objects/:object/export | A view (or filters) as CSV, up to 10,000 rows; X-More: 1 when there are more (use an export job). |
POST /v1/orgs/:orgId/crm/objects/:object/exports | Exports a view to a file in the background (any size); download it from the job when done. |
GET /v1/orgs/:orgId/crm/records/:id | The record, what the caller may do with it, and names of the people and records it refers to. |
PATCH /v1/orgs/:orgId/crm/records/:id | Changes fields and the owner; version refuses a stale edit (409). |
DELETE /v1/orgs/:orgId/crm/records/:id | Deletes the record; its history and the audit log keep who deleted it. |
GET /v1/orgs/:orgId/crm/records/:id/history | Field changes, newest first. |
GET /v1/orgs/:orgId/crm/records/:id/related | Records of other objects that look up to this one (a few of each). |
GET /v1/orgs/:orgId/crm/records/:id/activities | The timeline: activities related to the record, newest first. |
POST /v1/orgs/:orgId/crm/records/:id/activities | Logs a task, call, meeting, note or email on the record (and any others in relatedIds). |
POST /v1/orgs/:orgId/crm/records/:id/convert | Converts a lead into an account (or uses one), a contact (or uses one) and an opportunity. |
GET /v1/orgs/:orgId/crm/pipelines | Opportunity pipelines with their stages. |
POST /v1/orgs/:orgId/crm/pipelines | A pipeline (Customers admins): stages with probability and whether each is open, won or lost. |
PUT /v1/orgs/:orgId/crm/pipelines/:pipelineId | Replaces a pipeline's name and stages (Customers admins), over version; a stage with deals can't be removed. |
DELETE /v1/orgs/:orgId/crm/pipelines/:pipelineId | Deletes a pipeline without opportunities (Customers admins); the default stays. |
GET /v1/orgs/:orgId/crm/pipelines/:pipelineId/board | The board: each stage's first opportunities by close date with its count and amount; stage and cursor page one column. |
GET /v1/orgs/:orgId/crm/jobs | Recent imports and exports (the caller's; every one for Customers admins). |
GET /v1/orgs/:orgId/crm/jobs/:jobId | An import or export: state, progress counts and the first errors. |
POST /v1/orgs/:orgId/crm/jobs/:jobId/cancel | Cancels an export that hasn't finished (the caller's, or any for Customers admins); a finished one comes back as it is. |
GET /v1/orgs/:orgId/crm/jobs/:jobId/download | A finished export's download link (ten minutes). |
POST /v1/orgs/:orgId/crm/imports | Starts an import: up to 5 MB in content, or a presigned uploadUrl for the file (PUT it, then call uploaded). |
POST /v1/orgs/:orgId/crm/imports/:jobId/uploaded | Marks a presigned upload complete so the import can be previewed. |
POST /v1/orgs/:orgId/crm/imports/:jobId/preview | The header, ten sample rows and a suggested column mapping. |
POST /v1/orgs/:orgId/crm/imports/:jobId/dry-run | Checks the first 1,000 rows with the mapping, writing nothing. |
POST /v1/orgs/:orgId/crm/imports/:jobId/start | Queues the import; follow it on the job. |
GET /v1/orgs/:orgId/crm/meta | The caller's view of Customers: objects, pipelines, settings, the people in the org and what the caller may do. |
GET /v1/orgs/:orgId/crm/summary | Home: the pipeline summary (counters) and the caller's open tasks. |
GET /v1/orgs/:orgId/crm/search | Records matching words, an email, a phone number or an id, that the caller can see. |
GET /v1/orgs/:orgId/crm/settings | Customers settings: currency, Mail and Calendar logging, role permissions, with version. |
PATCH /v1/orgs/:orgId/crm/settings | Currency, Mail and Calendar logging, and what each role may see and change. |