Task

Cancel a task

Cancels a task that is not yet complete.

post/v1/projects/{project_id}/tasks/{id}/cancel

Request

  • Base URL: https://api.telerivet.com
  • URL: https://api.telerivet.com/v1/projects/{project_id}/tasks/{id}/cancel
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://telerivet.com/oauth/authorize, token URL https://api.telerivet.com/oauth/token)

Path parameters

project_idstring required

ID of the Project

idstring required

ID of the Task

Response

Successful response

idstring

ID of the task

task_typestring

The task type

task_paramsobject

Parameters applied to all matching rows (specific to task_type). See project.createTask.

filter_typestring

Type of filter defining the rows that the task is applied to

filter_paramsobject

Parameters defining the rows that the task is applied to (specific to filter_type). See project.createTask.

time_createdinteger

Time the task was created in Telerivet

time_activeinteger nullable

Time Telerivet started executing the task

time_completeinteger nullable

Time Telerivet finished executing the task

total_rowsinteger nullable

The total number of rows matching the filter (null if not known)

current_rowinteger nullable

The number of rows that have been processed so far

status'created' | 'queued' | 'active' | 'complete' | 'failed' | 'cancelled'

The current status of the task

error_messagestring nullable

Error message if the task failed

varsobject

Custom variables stored for this task. Variable names may be up to 32 characters in length and can contain the characters a-z, A-Z, 0-9, and _. Values may be strings, numbers, or boolean (true/false). String values may be up to 4096 bytes in length when encoded as UTF-8. Up to 100 variables are supported per object. Setting a variable to null will delete the variable.

table_idstring

ID of the data table this task is applied to (if applicable)

user_idstring

ID of the Telerivet user who created the task (if applicable)

project_idstring

ID of the project this task belongs to

Example response

{
  "id": "DE1189812e59c5c781",
  "task_type": "add_group_members",
  "filter_type": "query_contacts",
  "time_created": 1390348075,
  "time_active": 1390348076,
  "total_rows": 12000,
  "current_row": 3000,
  "status": "active",
  "user_id": "URba3e403e98f49735",
  "project_id": "PJ2ad0100821a98bea"
}

Changes

No recorded changes to this operation across all 1 revision of this API.