Skip to content

Update a Pipeline Target List
Stable

Request

Updates the details of an existing Target List.

Send a PUT request with the updated fields to modify a Target List's configuration; the response returns the updated Target List object.

About Target Lists

A Target List defines the devices a Pipeline Stage acts on, either through individual Targets or attached Device Groups; its configuration is managed separately from the Targets and Device Groups it contains, which have their own dedicated endpoints.

Security
pipelines_SCAPIAuthToken
Path
pipeline_idstringrequired

ID of the Pipeline

targetlist_idstringrequired

ID of the Target List

Bodyapplication/jsonrequired
pipeline_idstring
namestring
target_list_typestring
created_bynumber, (int32)
updated_bynumber, (int32)
created_atstring, (date-time)
updated_atstring, (date-time)
cURL
curl -i -X PUT \
  'https://api.esper.io/_mock/openapi/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "pipeline_id": "string",
    "name": "string",
    "target_list_type": "string",
    "created_by": 0,
    "updated_by": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }'

Responses

Updated Target List Information

Bodyapplication/json
codeinteger
messagestring
contentobject(pipelines_TargetList)
Response
{
  "code": 0,
  "message": "string",
  "content": {
    "id": "string",
    "pipeline_id": "string",
    "name": "string",
    "target_list_type": "string",
    "created_by": 0,
    "updated_by": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}