GEgetprosperapp
Targets

Update Target Input Data

Changed on
patch/api/v1/targets/{target_id}

Request

  • Base URL
    https://voice.getprosperapp.com (the document declares no server; this is the origin it was published from)
  • URL
    https://voice.getprosperapp.com/api/v1/targets/{target_id}
  • Auth
    none declared

Path parameters

target_idstring required

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

  • 66e5e745a31dRevision changes
    • info

      added to the response property anyOf list for the response status

  • dd21bc26a677Revision changes
    • warning

      added the new PATIENT_NOT_FOUND enum value to the / response property for the response status