Skip to main content

API: Mark Record as Complete

To mark a record as complete in a workflow, send a POST request to https://system.2xsolutions.ai/api/complete-record/. The record will not be called again in that workflow. The payload should be sent…

NCOL Support
Updated by NCOL Support

To mark a record as complete in a workflow, send a POST request to https://system.2xsolutions.ai/api/complete-record/. The record will not be called again in that workflow.

The payload should be sent as follows:

{
"api_key": "...",
"workflow_key": "A1B2C3"
"record_phone_number": "9876543210"
}

record_phone_number should be exactly 10 digits long. Do not include the "+1" country code.

The success response will be:

{
message: 'Successfully marked record as completed.'
}

If the record is already complete in the workflow, the response will be:

{
message: 'Record is already completed.'
}

The system will return a status 400 if the record is not found in the workflow or if there was an issue with the payload.

Mark as Complete Across Workflows

By omitting the workflow_key , you can mark a record as complete across all of your company's workflows.

Multiple Phone Numbers

You can also add multiple records in one call using the bulk version of this API route. The URL is /api/bulk-complete-record/. The payload takes an array of phone numbers:

{
"api_key": "...",
"workflow_key": "A1B2C3",
"record_phone_numbers": [
"9876543210",
"9876543211",
...
]
}

Any phone numbers that cannot be marked as complete will be ignored. There is currently a limit of 1,000 records per call.

How did we do?

API: Add Record to Workflow

API: Resume Completed Record

Contact