Assign or remove one tag on up to 200 leads

POST

/api/v1/leads/bulk/tags

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/leads/bulk/tags \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "tag_id": "example", "lead_ids": [ "example" ], "action": "assign" }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

tag_id

required

string

/^[0-9a-fA-F]{24}$/

lead_ids

required

Array<string>

>= 1 items <= 200 items

action

required

string

Allowed values: assign remove

Responses

200

Number of leads changed

Media typeapplication/json

object

updated

required

number

Example^generated

{
  "updated": 1
}

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}