Sign in
Targets

Update Target Input Data

patch/api/v1/targets/{target_id}

Path parameters

target_idstring required

The ID of the target whose input_data to update.

The ID of the target whose input_data to update.

Request body

input_dataobject 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_startedboolean

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

idstring required
target_urlstring required
organization_idstring required
campaign_idstring required
created_atstring date-time required
execution_minutesinteger nullable required
input_dataobject required
output_dataobject required
status'Pending' | 'Scheduled' | 'In Progress' | 'Post-processing' | 'Finished' | 'Failed' | 'Waiting' | 'SMS Scheduled' required
call_log_idsinteger[] nullable required
last_call_datestring date-time nullable required
phone_numberstring nullable required
fax_linksstring[] nullable required
payor_api_dataobject nullable required
external_idstring nullable required
pre_call_ehr_idsobject nullable
updated_atstring date-time nullable
retriesinteger nullable
scheduled_timestring date-time nullable
categorizationobject nullable
outcomestring nullable
statisticsobject nullable

Changes

Changed in 9 of the 12 revisions of this API.77

  • 1a91aac903bf1See the full diff
    • ○

      added the optional property pre_call_ehr_ids to the response with the 200 status

      response-optional-property-added

  • 672ca50a92151See the full diff
    • ○

      added VoicemailSubCategory to the subcategory response property anyOf list for the response status 200

      response-property-any-of-added

  • 097c341c485311See the full diff
    • ●

      added the new CALLBACK_REQUESTED enum value to the category/anyOf[subschema #6: PatientBillingCallCategory]/ response property for the response status 200

      response-property-enum-value-added

    • ○

      removed the CALLBACK_SCHEDULED enum value from the category/anyOf[subschema #6: PatientBillingCallCategory]/ response property for the response status 200

      response-property-enum-value-removed

  • 05ba38c3e3351See the full diff
    • ○

      added BillingUnresolvedSubCategory to the subcategory response property anyOf list for the response status 200

      response-property-any-of-added

  • 638858cf310d2See the full diff
    • ○

      added BillingResolvedSubCategory to the subcategory response property anyOf list for the response status 200

      response-property-any-of-added

    • ○

      added PatientBillingCallCategory to the category response property anyOf list for the response status 200

      response-property-any-of-added

  • 93bd5b9524ee4See the full diff
    • ●

      added the new INVALID_PHONE_NUMBER enum value to the category/anyOf[subschema #1: PayorCallCategory]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new INVALID_PHONE_NUMBER enum value to the category/anyOf[subschema #2: PatientCallCategory]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new INVALID_PHONE_NUMBER enum value to the category/anyOf[subschema #3: ProviderCallCategory]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new INVALID_PHONE_NUMBER enum value to the subcategory/anyOf[subschema #8: PayorCallCategory]/ response property for the response status 200

      response-property-enum-value-added

  • 9b3b66c4a7201See the full diff
    • ○

      removed the To review enum value from the status response property for the response status 200

      response-property-enum-value-removed

  • bd124844fd9f1See the full diff
    • ●

      added the new AUTOMATICALLY_BYPASSED enum value to the category/anyOf[subschema #5: PatientIncomingSchedulingCallCategory]/ response property for the response status 200

      response-property-enum-value-added

  • 465e175d4bd71See the full diff
    • ●

      added the new INSURANCE_REJECTED enum value to the subcategory/anyOf[subschema #2: TransferSubCategory]/ response property for the response status 200

      response-property-enum-value-added