Update a lead

PUT

/api/v1/leads/{id}

curl --request PUT \
  --url https://api.pitch2sale.com/api/v1/leads/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "status_id": "example", "owner_id": "example", "description": "example", "requirements": "example", "url": "", "address": { "street": "example", "city": "example", "state": "example", "zip": "example", "country": "example" }, "tags": [ "example" ], "source": "example", "custom_fields": { "additionalProperty": "example" }, "industry": "example", "industry_size": "solo", "lead_role": "example", "timezone": "example" }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

name

string

>= 1 characters <= 500 characters

status_id

string

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

owner_id

string

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

description

string

requirements

Any of:

string

string

<= 10000 characters

null

null

url

Any of:

string

string format: uri

string

string

address

object

street

string

city

string

state

string

zip

string

country

string

tags

Array<string>

source

Any of:

string

string

<= 100 characters

null

null

custom_fields

object

key

additional properties

industry

Any of:

string

string

<= 64 characters

null

null

industry_size

Any of:

string

string

Allowed values: solo small mid large

null

null

lead_role

Any of:

string

string

<= 64 characters

null

null

timezone

Any of:

string

string

<= 64 characters

null

null

Responses

200

The updated lead

Media typeapplication/json

object

lead

required

object

_id

required

string

name

required

string

key

additional properties

any

Example^generated

{
  "lead": {
    "_id": "example",
    "name": "example"
  }
}

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