{ "info": { "name": "Auto Appy CRM API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}", "type": "string" } ] }, "variable": [ { "key": "api_key", "value": "" }, { "key": "organisation_id", "value": "" }, { "key": "activity_id", "value": "" }, { "key": "local_workspace_id", "value": "" }, { "key": "lead_id", "value": "" } ], "item": [ { "name": "GET /me", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://crmapi.autoappy.com/me", "protocol": "https", "host": [ "crmapi", "autoappy", "com" ], "path": [ "me" ], "query": [ { "key": "data", "value": "", "description": "Data. Optional. ", "disabled": true } ] }, "description": "Me for auto appy auth. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /api/auth/me", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://crmapi.autoappy.com/api/auth/me", "protocol": "https", "host": [ "crmapi", "autoappy", "com" ], "path": [ "api", "auth", "me" ], "query": [ { "key": "data", "value": "", "description": "Data. Optional. ", "disabled": true } ] }, "description": "" } }, { "name": "GET /workspaces", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces", "description": "Index for workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /workspaces/{workspace}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}", "description": "Show for workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /workspaces/{workspace}/overview", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/overview", "description": "Overview for workspace. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /workspaces/{workspace}/organisation-link", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/organisation-link", "description": "Show for organisation connection. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /workspaces/{workspace}/organisation-link/preview", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://crmapi.autoappy.com/workspaces/{{workspace}}/organisation-link/preview", "protocol": "https", "host": [ "crmapi", "autoappy", "com" ], "path": [ "workspaces", "{{workspace}}", "organisation-link", "preview" ], "query": [ { "key": "organisation_id", "value": "", "description": "Organisation id. Required. ", "disabled": false } ] }, "description": "Preview for organisation connection. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /workspaces/{workspace}/users", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/users", "description": "Index for workspace user. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. \n\nLookup `assigned_user_id`: read `data[].user_id` as the value and `data[].user.name` as the label. Use identifiers only within their authorised workspace." } }, { "name": "GET /workspaces/{workspace}/users/{workspaceUser}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/users/{{workspaceUser}}", "description": "Show for workspace user. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /workspaces/{workspace}/team/{user}/performance", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://crmapi.autoappy.com/workspaces/{{workspace}}/team/{{user}}/performance", "protocol": "https", "host": [ "crmapi", "autoappy", "com" ], "path": [ "workspaces", "{{workspace}}", "team", "{{user}}", "performance" ], "query": [ { "key": "from", "value": "", "description": "From. Optional. ", "disabled": true }, { "key": "to", "value": "", "description": "To. Optional. ", "disabled": true }, { "key": "data", "value": "", "description": "Data. Optional. ", "disabled": true } ] }, "description": "Show for team performance. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /workspaces/{workspace}/lead-fields", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://crmapi.autoappy.com/workspaces/{{workspace}}/lead-fields", "protocol": "https", "host": [ "crmapi", "autoappy", "com" ], "path": [ "workspaces", "{{workspace}}", "lead-fields" ], "query": [ { "key": "pipeline_id", "value": "", "description": "", "disabled": true }, { "key": "include_inactive", "value": "", "description": "", "disabled": true } ] }, "description": "\n\nLookup `lookup_field`: read `data[].key` as the value and `data[].label` as the label. Use identifiers only within their authorised workspace.\n\nLookup `lookup_field_2`: read `data[].key` as the value and `data[].label` as the label. Use identifiers only within their authorised workspace." } }, { "name": "POST /workspaces/{workspace}/lead-fields", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/lead-fields", "description": "Store for lead field. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "PUT /workspaces/{workspace}/lead-fields/reorder", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/lead-fields/reorder", "description": "Reorder for lead field. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "PUT /workspaces/{workspace}/lead-fields/{field}", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/lead-fields/{{field}}", "description": "Update for lead field. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE /workspaces/{workspace}/lead-fields/{field}", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/lead-fields/{{field}}", "description": "Destroy for lead field. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "POST /leads/import/google-sheet", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/leads/import/google-sheet", "description": "Google sheet for lead import. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /workspaces/{workspace}/document-storage", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/document-storage", "description": "Index for document storage. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /workspaces/{workspace}/document-categories", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/document-categories", "description": "Index for document category. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "POST /workspaces/{workspace}/document-categories", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/document-categories", "description": "Store for document category. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "PUT /workspaces/{workspace}/document-categories/{category}", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/document-categories/{{category}}", "description": "Update for document category. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "PATCH /workspaces/{workspace}/document-categories/{category}", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/document-categories/{{category}}", "description": "Update for document category. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE /workspaces/{workspace}/document-categories/{category}", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/document-categories/{{category}}", "description": "Destroy for document category. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "GET /workspaces/{workspace}/documents/options", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/documents/options", "description": "Options for lead document. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /workspaces/{workspace}/documents", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://crmapi.autoappy.com/workspaces/{{workspace}}/documents", "protocol": "https", "host": [ "crmapi", "autoappy", "com" ], "path": [ "workspaces", "{{workspace}}", "documents" ], "query": [ { "key": "index", "value": "", "description": "Index. Optional. Limits: max:150.", "disabled": true }, { "key": "lead_id", "value": "", "description": "Lead id. Optional. Limits: min:1.", "disabled": true }, { "key": "category_id", "value": "", "description": "Category id. Optional. ", "disabled": true }, { "key": "kind", "value": "", "description": "Kind. Optional. ", "disabled": true }, { "key": "assignment", "value": "", "description": "Assignment. Optional. ", "disabled": true }, { "key": "archived", "value": "", "description": "Archived. Optional. ", "disabled": true }, { "key": "sort", "value": "", "description": "Sort. Optional. ", "disabled": true }, { "key": "page", "value": "", "description": "Page. Optional. Limits: min:1.", "disabled": true }, { "key": "per_page", "value": "", "description": "Per page. Optional. Limits: min:1, max:100.", "disabled": true }, { "key": "initiate", "value": "", "description": "Initiate. Required. ", "disabled": false }, { "key": "file_name", "value": "", "description": "File name. Required. Limits: max:200.", "disabled": false }, { "key": "size_bytes", "value": "", "description": "Size bytes. Required. Limits: min:1.", "disabled": false }, { "key": "update", "value": "", "description": "Update. Required. Limits: max:200.", "disabled": false }, { "key": "description", "value": "", "description": "Description. Optional. Limits: max:2000.", "disabled": true }, { "key": "assign", "value": "", "description": "Assign. Required. Limits: min:1, max:100.", "disabled": false }, { "key": "matches", "value": "", "description": "Matches. Required. Limits: min:1, max:100.", "disabled": false }, { "key": "refresh", "value": "", "description": "Refresh. Optional. ", "disabled": true }, { "key": "approveMatches", "value": "", "description": "Approve matches. Required. Limits: min:1, max:100.", "disabled": false } ] }, "description": "Index for lead document. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "POST /workspaces/{workspace}/documents/uploads", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/documents/uploads", "description": "Initiate for lead document. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "PUT /workspaces/{workspace}/documents/assignment", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/documents/assignment", "description": "Assign for lead document. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "POST /workspaces/{workspace}/documents/matches", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/documents/matches", "description": "Matches for lead document. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "PUT /workspaces/{workspace}/documents/matches/approve", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/documents/matches/approve", "description": "Approve matches for lead document. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "POST /workspaces/{workspace}/documents/{document}/complete", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/documents/{{document}}/complete", "description": "Complete for lead document. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "DELETE /workspaces/{workspace}/documents/{document}/upload", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/documents/{{document}}/upload", "description": "Cancel for lead document. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "POST /workspaces/{workspace}/documents/{document}/download", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/documents/{{document}}/download", "description": "Download for lead document. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "POST /workspaces/{workspace}/documents/{document}/playback", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/documents/{{document}}/playback", "description": "Playback for lead document. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "PATCH /workspaces/{workspace}/documents/{document}", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/documents/{{document}}", "description": "Update for lead document. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE /workspaces/{workspace}/documents/{document}", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/documents/{{document}}", "description": "Destroy for lead document. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "POST /workspaces/{workspace}/documents/{document}/restore", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/workspaces/{{workspace}}/documents/{{document}}/restore", "description": "Restore for lead document. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "POST /leads/import", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/leads/import", "description": "Store for lead import. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /leads/export", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://crmapi.autoappy.com/leads/export", "protocol": "https", "host": [ "crmapi", "autoappy", "com" ], "path": [ "leads", "export" ], "query": [ { "key": "page", "value": "", "description": "Page. Optional. Limits: min:1.", "disabled": true }, { "key": "per_page", "value": "", "description": "Per page. Optional. Limits: min:1, max:100.", "disabled": true }, { "key": "search", "value": "", "description": "Search. Optional. Limits: max:255.", "disabled": true }, { "key": "pipeline_id", "value": "", "description": "Pipeline id. Optional. ", "disabled": true }, { "key": "lead_stage_id", "value": "", "description": "Lead stage id. Optional. Limits: min:1.", "disabled": true }, { "key": "stage_ids", "value": "", "description": "Stage ids. Optional. Limits: max:100.", "disabled": true }, { "key": "node_ids", "value": "", "description": "Node ids. Optional. Limits: max:100.", "disabled": true }, { "key": "assigned_user_id", "value": "", "description": "Assigned user id. Optional. ", "disabled": true }, { "key": "assigned_to", "value": "", "description": "Assigned to. Optional. Limits: max:100.", "disabled": true }, { "key": "lead_ids", "value": "", "description": "Lead ids. Optional. Limits: max:500.", "disabled": true }, { "key": "source", "value": "", "description": "Source. Optional. Limits: max:255.", "disabled": true }, { "key": "custom_filters", "value": "", "description": "Custom filters. Optional. Limits: max:25.", "disabled": true }, { "key": "custom_sort", "value": "", "description": "Custom sort. Optional. Limits: max:100.", "disabled": true }, { "key": "created_from", "value": "", "description": "Created from. Optional. ", "disabled": true }, { "key": "created_to", "value": "", "description": "Created to. Optional. ", "disabled": true }, { "key": "updated_from", "value": "", "description": "Updated from. Optional. ", "disabled": true }, { "key": "updated_to", "value": "", "description": "Updated to. Optional. ", "disabled": true }, { "key": "stage_changed_from", "value": "", "description": "Stage changed from. Optional. ", "disabled": true }, { "key": "stage_changed_to", "value": "", "description": "Stage changed to. Optional. ", "disabled": true }, { "key": "sort_by", "value": "", "description": "Sort by. Optional. ", "disabled": true }, { "key": "sort_direction", "value": "", "description": "Sort direction. Optional. ", "disabled": true } ] }, "description": "Export for lead. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /leads", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://crmapi.autoappy.com/leads", "protocol": "https", "host": [ "crmapi", "autoappy", "com" ], "path": [ "leads" ], "query": [ { "key": "page", "value": "", "description": "", "disabled": true }, { "key": "per_page", "value": "", "description": "", "disabled": true }, { "key": "search", "value": "", "description": "", "disabled": true }, { "key": "pipeline_id", "value": "", "description": "", "disabled": true }, { "key": "lead_stage_id", "value": "", "description": "", "disabled": true }, { "key": "source", "value": "", "description": "", "disabled": true }, { "key": "assigned_user_id", "value": "", "description": "", "disabled": true }, { "key": "stage_ids", "value": "", "description": "Stage ids. Optional. Limits: max:100.", "disabled": true }, { "key": "node_ids", "value": "", "description": "Node ids. Optional. Limits: max:100.", "disabled": true }, { "key": "assigned_to", "value": "", "description": "Assigned to. Optional. Limits: max:100.", "disabled": true }, { "key": "lead_ids", "value": "", "description": "Lead ids. Optional. Limits: max:500.", "disabled": true }, { "key": "custom_filters", "value": "", "description": "Custom filters. Optional. Limits: max:25.", "disabled": true }, { "key": "custom_sort", "value": "", "description": "Custom sort. Optional. Limits: max:100.", "disabled": true }, { "key": "created_from", "value": "", "description": "Created from. Optional. ", "disabled": true }, { "key": "created_to", "value": "", "description": "Created to. Optional. ", "disabled": true }, { "key": "updated_from", "value": "", "description": "Updated from. Optional. ", "disabled": true }, { "key": "updated_to", "value": "", "description": "Updated to. Optional. ", "disabled": true }, { "key": "stage_changed_from", "value": "", "description": "Stage changed from. Optional. ", "disabled": true }, { "key": "stage_changed_to", "value": "", "description": "Stage changed to. Optional. ", "disabled": true }, { "key": "sort_by", "value": "", "description": "Sort by. Optional. ", "disabled": true }, { "key": "sort_direction", "value": "", "description": "Sort direction. Optional. ", "disabled": true } ] }, "description": "\n\nLookup `lead_id`: read `data[].id` as the value and `data[].name` as the label. Use identifiers only within their authorised workspace." } }, { "name": "POST /leads", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/leads", "description": "", "body": { "mode": "raw", "raw": "{\n \"name\": \"Example customer\",\n \"email\": \"customer@example.invalid\",\n \"custom_fields\": {}\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /leads/{lead}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/leads/{{lead}}", "description": "" } }, { "name": "PUT /leads/{lead}", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/leads/{{lead}}", "description": "Partial update; lead_stage_id/stage_changed_at prohibited. Use lead-workflow APIs to move stages.", "body": { "mode": "raw", "raw": "{\n \"company\": \"Example Ltd\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "PATCH /leads/{lead}", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/leads/{{lead}}", "description": "Update for lead. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE /leads/{lead}", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/leads/{{lead}}", "description": "Destroy for lead. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "GET /analytics/lead-summary", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://crmapi.autoappy.com/analytics/lead-summary", "protocol": "https", "host": [ "crmapi", "autoappy", "com" ], "path": [ "analytics", "lead-summary" ], "query": [ { "key": "pipeline_id", "value": "", "description": "Pipeline id. Optional. ", "disabled": true }, { "key": "call_preset", "value": "", "description": "Call preset. Optional. ", "disabled": true }, { "key": "custom_start", "value": "", "description": "Custom start. Optional. ", "disabled": true }, { "key": "custom_end", "value": "", "description": "Custom end. Optional. ", "disabled": true } ] }, "description": "Summary for lead analytics. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /analytics/crm-overview", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://crmapi.autoappy.com/analytics/crm-overview", "protocol": "https", "host": [ "crmapi", "autoappy", "com" ], "path": [ "analytics", "crm-overview" ], "query": [ { "key": "pipeline_id", "value": "", "description": "Pipeline id. Optional. ", "disabled": true }, { "key": "days", "value": "", "description": "Days. Optional. ", "disabled": true }, { "key": "mode", "value": "", "description": "Mode. Optional. ", "disabled": true } ] }, "description": "Overview for crm analytics. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /lead-activities", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://crmapi.autoappy.com/lead-activities", "protocol": "https", "host": [ "crmapi", "autoappy", "com" ], "path": [ "lead-activities" ], "query": [ { "key": "lead_id", "value": "", "description": "Lead id. Optional. Limits: min:1.", "disabled": true }, { "key": "type", "value": "", "description": "Type. Optional. ", "disabled": true }, { "key": "status", "value": "", "description": "Status. Optional. ", "disabled": true }, { "key": "page", "value": "", "description": "Page. Optional. Limits: min:1.", "disabled": true }, { "key": "per_page", "value": "", "description": "Per page. Optional. Limits: min:1, max:100.", "disabled": true } ] }, "description": "Index for lead activity. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "POST /lead-activities", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/lead-activities", "description": "Records activity only; does not send a message. Defaults to COMPLETED when status is omitted. Current lead access and activity policy apply.", "body": { "mode": "raw", "raw": "{\n \"lead_id\": 1,\n \"type\": \"FOLLOWUP\",\n \"status\": \"PENDING\",\n \"note\": \"Call tomorrow\",\n \"scheduled_at\": \"2026-09-23T10:00:00Z\"\n}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /lead-activities/{leadActivity}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/lead-activities/{{leadActivity}}", "description": "Show for lead activity. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "PUT /lead-activities/{leadActivity}", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/lead-activities/{{leadActivity}}", "description": "Update for lead activity. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "PATCH /lead-activities/{leadActivity}", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/lead-activities/{{leadActivity}}", "description": "Update for lead activity. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE /lead-activities/{leadActivity}", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/lead-activities/{{leadActivity}}", "description": "Destroy for lead activity. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "PATCH /lead-activities/{leadActivity}/complete", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/lead-activities/{{leadActivity}}/complete", "description": "" } }, { "name": "GET /leads/{lead}/timeline", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://crmapi.autoappy.com/leads/{{lead}}/timeline", "protocol": "https", "host": [ "crmapi", "autoappy", "com" ], "path": [ "leads", "{{lead}}", "timeline" ], "query": [ { "key": "lead_id", "value": "", "description": "Lead id. Optional. Limits: min:1.", "disabled": true }, { "key": "type", "value": "", "description": "Type. Optional. ", "disabled": true }, { "key": "status", "value": "", "description": "Status. Optional. ", "disabled": true }, { "key": "page", "value": "", "description": "Page. Optional. Limits: min:1.", "disabled": true }, { "key": "per_page", "value": "", "description": "Per page. Optional. Limits: min:1, max:100.", "disabled": true } ] }, "description": "Timeline for lead activity. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "POST /lead-workflow/start", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/lead-workflow/start", "description": "Start for lead workflow. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /lead-workflow/workflow/stages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/lead-workflow/workflow/stages", "description": "Workflow stages for lead workflow. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /lead-workflow/{leadId}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/lead-workflow/{{leadId}}", "description": "Current for lead workflow. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "POST /lead-workflow/{leadId}/complete-node", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/lead-workflow/{{leadId}}/complete-node", "description": "Complete node for lead workflow. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "POST /lead-workflow/{leadId}/skip-node", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/lead-workflow/{{leadId}}/skip-node", "description": "Skip node for lead workflow. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "POST /lead-workflow/{leadId}/move", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/lead-workflow/{{leadId}}/move", "description": "Move for lead workflow. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /lead-workflow/{leadId}/available-transitions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/lead-workflow/{{leadId}}/available-transitions", "description": "Available transitions for lead workflow. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /lead-workflow/{leadId}/history", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/lead-workflow/{{leadId}}/history", "description": "History for lead workflow. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /lead-workflow/{leadId}/workflow/current", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/lead-workflow/{{leadId}}/workflow/current", "description": "Workflow current for lead workflow. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /lead-workflow/{leadId}/workflow/options", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/lead-workflow/{{leadId}}/workflow/options", "description": "Workflow options for lead workflow. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "PUT /lead-workflow/{leadId}/workflow/update-current", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/lead-workflow/{{leadId}}/workflow/update-current", "description": "Update current for lead workflow. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /leads/{lead}/owners", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/leads/{{lead}}/owners", "description": "Index for lead owner. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "PUT /leads/{lead}/owners", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/leads/{{lead}}/owners", "description": "Sync for lead owner. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE /leads/{lead}/owners/{user}", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/leads/{{lead}}/owners/{{user}}", "description": "Destroy for lead owner. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "POST /admin/pipelines/import", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/import", "description": "Store for pipeline import. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "POST /admin/pipelines/import/google-sheet", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/import/google-sheet", "description": "Google sheet for pipeline import. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /admin/pipelines/import/{pipeline}/export", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/import/{{pipeline}}/export", "description": "Export for pipeline import. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "PUT /admin/pipelines/import/{pipeline}", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/import/{{pipeline}}", "description": "Update for pipeline import. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /admin/pipelines/workflow", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://crmapi.autoappy.com/admin/pipelines/workflow", "protocol": "https", "host": [ "crmapi", "autoappy", "com" ], "path": [ "admin", "pipelines", "workflow" ], "query": [ { "key": "pipeline_id", "value": "", "description": "Pipeline id. Required. ", "disabled": false } ] }, "description": "Index for workflow builder. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "GET /admin/pipelines/pipelines", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/pipelines", "description": "\n\nLookup `pipeline_id`: read `data[].id` as the value and `data[].name` as the label. Use identifiers only within their authorised workspace." } }, { "name": "POST /admin/pipelines/pipelines", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/pipelines", "description": "Store for pipeline. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /admin/pipelines/pipelines/{id}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/pipelines/{{id}}", "description": "Show for pipeline. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "PUT /admin/pipelines/pipelines/{id}", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/pipelines/{{id}}", "description": "Update for pipeline. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE /admin/pipelines/pipelines/{id}", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/pipelines/{{id}}", "description": "Destroy for pipeline. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "GET /admin/pipelines/stages", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://crmapi.autoappy.com/admin/pipelines/stages", "protocol": "https", "host": [ "crmapi", "autoappy", "com" ], "path": [ "admin", "pipelines", "stages" ], "query": [ { "key": "pipeline_id", "value": "", "description": "", "disabled": true } ] }, "description": "\n\nLookup `lead_stage_id`: read `data[].id` as the value and `data[].name` as the label. Use identifiers only within their authorised workspace." } }, { "name": "POST /admin/pipelines/stages", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/stages", "description": "Store for lead stage. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "PUT /admin/pipelines/stages/reorder", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/stages/reorder", "description": "Reorder for lead stage. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /admin/pipelines/stages/{id}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/stages/{{id}}", "description": "Show for lead stage. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "PUT /admin/pipelines/stages/{id}", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/stages/{{id}}", "description": "Update for lead stage. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE /admin/pipelines/stages/{id}", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/stages/{{id}}", "description": "Destroy for lead stage. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "GET /admin/pipelines/nodes", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/nodes", "description": "Index for stage node. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "POST /admin/pipelines/nodes", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/nodes", "description": "Store for stage node. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "PUT /admin/pipelines/nodes/reorder", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/nodes/reorder", "description": "Reorder for stage node. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "GET /admin/pipelines/nodes/{id}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/nodes/{{id}}", "description": "Show for stage node. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "PUT /admin/pipelines/nodes/{id}", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/nodes/{{id}}", "description": "Update for stage node. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE /admin/pipelines/nodes/{id}", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/nodes/{{id}}", "description": "Destroy for stage node. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "GET /admin/pipelines/transitions", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/transitions", "description": "Index for node transition. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "POST /admin/pipelines/transitions", "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/transitions", "description": "Store for node transition. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "GET /admin/pipelines/transitions/{id}", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/transitions/{{id}}", "description": "Show for node transition. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. " } }, { "name": "PUT /admin/pipelines/transitions/{id}", "request": { "method": "PUT", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/transitions/{{id}}", "description": "Update for node transition. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } } }, { "name": "DELETE /admin/pipelines/transitions/{id}", "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/admin/pipelines/transitions/{{id}}", "description": "Destroy for node transition. Application API key (Bearer) with the matching application permission and workspace access. Resource access is checked by the server. A write changes application data; do not replay an uncertain request." } }, { "name": "GET /workspaces/{workspace}/lead-fields/schema", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://crmapi.autoappy.com/workspaces/{{workspace}}/lead-fields/schema", "protocol": "https", "host": [ "crmapi", "autoappy", "com" ], "path": [ "workspaces", "{{workspace}}", "lead-fields", "schema" ], "query": [ { "key": "pipeline_id", "value": "", "description": "", "disabled": true } ] }, "description": "Read enabled starter columns for the selected pipeline. Omit disabled starters from lead writes. Read custom fields separately with the same pipeline_id." } }, { "name": "Fill missing lead details", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": { "raw": "https://crmapi.autoappy.com/leads/enrich", "protocol": "https", "host": [ "crmapi", "autoappy", "com" ], "path": [ "leads", "enrich" ] }, "body": { "mode": "raw", "raw": "{\n \"intake_event_key\": \"website:1518\",\n \"revenue\": \"100000\",\n \"additional_details\": [\n {\n \"key\": \"WhatsApp setup\",\n \"value\": \"WhatsApp Business app\"\n },\n {\n \"key\": \"Goals\",\n \"value\": \"Follow-ups and CRM updates\"\n }\n ]\n}" }, "description": "Use for an optional second form or later questionnaire. Resolves an exact lead by ID or original enquiry reference; never searches by phone and never creates a lead. Fills empty fields only, preserving nonempty values, ownership and pipeline stage. Empty scalar/custom answers are ignored; false and zero are meaningful. Repeated submissions converge without overwriting. Existing field validation and update permissions apply. A missing original intake returns 409; complete or repair intake before retrying. This endpoint does not send messages. It does not provide historical answer revisions; use an activity for an immutable form submission record." } }, { "name": "CRM activity context: read", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" }, { "key": "X-Workspace-ID", "value": "{{local_workspace_id}}" } ], "url": "https://crmapi.autoappy.com/lead-activities/{{activity_id}}/follow-up-context", "description": "Read the activity first. Set context_token from that response. Review 409 conflicts; never replay an uncertain mutation automatically." } }, { "name": "CRM activity context: reschedule", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" }, { "key": "X-Workspace-ID", "value": "{{local_workspace_id}}" } ], "url": "https://crmapi.autoappy.com/lead-activities/{{activity_id}}/follow-up-context", "description": "Read the activity first. Set context_token from that response. Review 409 conflicts; never replay an uncertain mutation automatically.", "body": { "mode": "raw", "raw": "{\n \"operation\": \"reschedule\",\n \"context_token\": \"{{context_token}}\",\n \"scheduled_at\": \"2026-10-02T15:30:00+05:30\"\n}" } } }, { "name": "CRM activity context: complete", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" }, { "key": "X-Workspace-ID", "value": "{{local_workspace_id}}" } ], "url": "https://crmapi.autoappy.com/lead-activities/{{activity_id}}/follow-up-context", "description": "Read the activity first. Set context_token from that response. Review 409 conflicts; never replay an uncertain mutation automatically.", "body": { "mode": "raw", "raw": "{\n \"operation\": \"complete\",\n \"context_token\": \"{{context_token}}\"\n}" } } }, { "name": "CRM activity context: cancel", "request": { "method": "PATCH", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "Content-Type", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" }, { "key": "X-Workspace-ID", "value": "{{local_workspace_id}}" } ], "url": "https://crmapi.autoappy.com/lead-activities/{{activity_id}}/follow-up-context", "description": "Read the activity first. Set context_token from that response. Review 409 conflicts; never replay an uncertain mutation automatically.", "body": { "mode": "raw", "raw": "{\n \"operation\": \"cancel\",\n \"context_token\": \"{{context_token}}\"\n}" } } }, { "name": "Read activity reminder plans", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "key": "X-AutoAppy-Workspace", "value": "{{organisation_id}}" } ], "url": "https://crmapi.autoappy.com/lead-activities/{{activity_id}}/reminders?page=1", "description": "Read-only, on-demand summary. No plans are created and no messages are sent. Requires the signed-in actor\u2019s access; CRM checks activity visibility before forwarding that actor\u2019s token. Central membership, main-product entitlement and plan ownership are enforced. No connector credential fallback. Empty data is not an organisation-wide assurance that no reminders exist. Open or refresh explicitly; do not poll this endpoint." } } ] }