Skip to main content
PATCH
Update Target Input Data

Path Parameters

target_id
string
required

The ID of the target whose input_data to update.

Body

application/json
input_data
Input Data · object
required

Fields to merge into the target's input_data. Only the keys present here are updated; existing keys not included are left unchanged.

only_if_not_started
boolean
default:true

When true (default), the edit is rejected with 409 if the target has already started executing — i.e. a call has been placed, or it has left the Pending/Scheduled staging states. A Scheduled target with no calls yet is still editable. Set false to edit regardless.

Response

Successful Response

id
string
required
target_url
string
required
organization_id
string
required
campaign_id
string
required
created_at
string<date-time>
required
execution_minutes
integer | null
required
input_data
Input Data · object
required
output_data
Output Data · object
required
status
enum<string>
required
Available options:
Pending,
Scheduled,
In Progress,
Post-processing,
Finished,
Failed,
Waiting,
SMS Scheduled
resolution
required
Available options:
retrieved,
not_retrieved
category
required
Available options:
GOOD,
NO_RESPONSE,
TRANSFER,
TRANSFER_FAILED,
VOICEMAIL,
SERVICE_NOT_AVAILABLE,
HUMAN_ONLY,
AFTER_HOURS,
CLOSED_FOR_HOLIDAYS,
IVR_LOOP,
INPUT_DATA_ISSUE,
WRONG_PHONE_NUMBER,
NOT_FOUND,
UNPROCESSABLE_BY_PHONE,
DISCONNECTED,
NOT_ALL_DATA_POINTS_RETRIEVED,
MEMBER_CONSENT_REQUIRED,
SLA_EXPIRED,
PAYOR_NOT_SUPPORTED,
NO_OPERATING_HOURS,
INVALID_PHONE_NUMBER
subcategory
required
Available options:
PROVIDER,
MEMBER,
FACILITY,
REQUEST,
OTHER
call_log_ids
integer[] | null
required
last_call_date
string<date-time> | null
required
phone_number
string | null
required
payor_api_data
Payor Api Data · object | null
required
external_id
string | null
required
pre_call_ehr_ids
Pre Call Ehr Ids · object | null
updated_at
string<date-time> | null
retries
integer | null
scheduled_time
string<date-time> | null
categorization
Categorization · object | null
outcome
string | null
statistics
Statistics · object | null