Skip to main content
PATCH
Update Prospect List

Authorizations

X-API-Key
string
header
required

API Key for authentication

Path Parameters

id
string
required

Body

application/json
id
string<uuid>
required

Prospect list id to update.

name
string
required

New prospect list name.

Minimum string length: 1
campaignId
string<uuid>
required

Resulting parent campaign ID. Keeping the current ID only renames the list. Changing it moves the list and prospects to a non-deleted Prospects campaign in the same team, requiring an active plan and an available prospect-list slot there. Existing visible prospects are capacity-neutral; a change of owner can return a different list ID.

Response

status
string
required

Response status

Allowed value: "success"
data
object
required
message
string
required

Success message

Example:

"Operation completed successfully"