Prospects / CLI
Remove prospect
Remove a prospect from a campaign.
pipeline remove-prospectDeterministic operationParameters
workspaceIdOptional · string- Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client.
prospectIdRequired · string- See the input schema for this field.
campaignIdRequired · string- See the input schema for this field.
pipeline remove-prospect \
--prospect-id "00000000-0000-4000-8000-000000000000" \
--campaign-id "00000000-0000-4000-8000-000000000000"Full input schema
{
"type": "object",
"properties": {
"workspaceId": {
"type": "string",
"minLength": 1,
"description": "Optional workspace ID or slug. Required when this credential can access multiple workspaces and no workspace was configured on the client."
},
"prospectId": {
"type": "string"
},
"campaignId": {
"type": "string"
}
},
"required": [
"prospectId",
"campaignId"
]
}