Call Imports
Edit dataset / tag assignments (and schema, pre-import) on a batch.
dataset = "" clears the label; tag_ids = [] removes all tag
assignments. Fields omitted from the body are left untouched.
schema_id is only honoured while the batch is in
uploaded / mapped state — once rows have been materialised
the schema is locked. Changing the schema resets any persisted
mapping (the user must re-MAP) and rewinds status to uploaded.
AuthorizationBearer <token>
JWT access token. Use: Authorization: Bearer .
In: header
Path Parameters
call_import_id*Call Import Id
Format
uuidHeader Parameters
X-API-Key?string|null
X-EFFICIENTAI-API-KEY?string|null
X-Workspace-Id?string|null
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Partial update of a call-import batch.
Response Body
application/json
application/json
curl -X PATCH "https://example.com/api/v1/call-imports/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6", "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9", "provider": "string", "telephony_integration_id": "50fbd5e3-6c05-4c13-a603-21ee107c9692", "original_filename": "string", "sheet_name": "string", "dataset": "string", "tags": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "color": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "schema_id": "9c37f32d-8308-4815-9b0d-83fa3c1b25f9", "parameter_mapping": { "property1": "string", "property2": "string" }, "column_mapping": { "property1": "string", "property2": "string" }, "extra_columns": [ "string" ], "custom_column_mapping": { "property1": "string", "property2": "string" }, "skipped_columns": [ "string" ], "source_row_skips": [ { "source_row": 0, "reason": "string", "message": "string" } ], "source_s3_key": "string", "source_format": "string", "source_size_bytes": 0, "source_content_type": "string", "available_sheets": [ { "name": "string", "headers": [ "string" ], "row_count": 0 } ], "total_rows": 0, "completed_rows": 0, "failed_rows": 0, "status": "pending", "error_message": "string", "latest_evaluation_status": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "created_by_email": "string", "last_updated_by_email": "string"}Community & contact
- Found a bug or have a feature request? Open a GitHub issue.
- Join our Discord for faster replies!