Skip to content

Update a target in the target list
Stable

Request

Updates a Target in a Pipeline Target List.

Updates the device_name and is_active fields of the specified Target record; this is a full-replacement update, so include both fields in the request. Not recommended for pipelines that are currently running.

About Targets A Target represents a single device entry within a Target List. Updating a Target most commonly toggles is_active to include or exclude that device from future pipeline runs without removing the record entirely.

Key Fields / Query Parameters

  • target_id — UUID of the Target to update
  • device_name — Updated display name for the device
  • is_active — Whether the Target should be included in pipeline runs
Security
pipelines_SCAPIAuthToken
Path
pipeline_idstring, (uuid)required

ID of the Pipeline

targetlist_idstring, (uuid)required

ID of the Target List

target_idstring, (uuid)required

ID of the Target

Bodyapplication/jsonrequired
device_namestring
is_activeboolean
cURL
curl -i -X PUT \
  'https://develop-api.esper.io/_mock/openapi/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/targets/{target_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "device_name": "string",
    "is_active": true
  }'

Responses

Updated Target from Target List

Bodyapplication/json
codeinteger
messagestring
contentobject(pipelines_Target)
Response
{
  "code": 0,
  "message": "string",
  "content": {
    "id": "string",
    "pipeline_id": "ec036e81-7903-4e4d-bbfa-ac8516341cf0",
    "device_id": "3bafab7b-4400-4bcf-8e6e-09f954699940",
    "device_name": "string",
    "device_alias": "string",
    "is_active": true,
    "created_by": 0,
    "updated_by": 0,
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}