sdkDeterministic

Update prospect tags

Name: Pipeline
Price: 99 USD

pipeline.updateProspectTags

Add/remove custom tags. Preserves unrelated and stage tags. Does not change stage.

Parameters

workspaceId

string

No description.

prospectIdrequired

string

No description.

addrequired

string[]

No description.

removerequired

string[]

No description.

idempotencyKeyrequired

string

No description.

Example

TypeScripttypescript

await pipeline.updateProspectTags({
  "prospectId": "00000000-0000-4000-8000-000000000000",
  "add": [
    "example"
  ],
  "remove": [
    "example"
  ],
  "idempotencyKey": "example"
})

Response

Success response schemajson schema

{
  "type": "object",
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "activityId": {
      "type": "string"
    }
  },
  "required": [
    "tags",
    "activityId"
  ]
}

Exceptions

PipelineError: Thrown for validation, authentication, JSON-RPC, HTTP, and network failures. Inspect code and data when present.