Apply a bulk action to up to 100 leads

POST

/api/v1/leads/bulk

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/leads/bulk \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "action": "assign_owner", "ids": [ "example" ], "params": { "owner_id": "example", "status_id": "example", "tag_ids": [ "example" ], "workflow_id": "example" } }'

Actions: assign_owner, change_status, add_tags, remove_tags, convert_to_client, apply_workflow, delete (delete also needs leads.delete). Per-lead visibility is checked; the action can be undone for 24 hours.

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

action

required

string

Allowed values: assign_owner change_status add_tags remove_tags convert_to_client apply_workflow delete

ids

required

Array<string>

>= 1 items <= 100 items

params

object

owner_id

string

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

status_id

string

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

tag_ids

Array<string>

>= 1 items <= 50 items

workflow_id

string

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

Responses

200

OK

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"
    }
  ]
}