Upload a CSV or XLSX file to start a lead import

POST

/api/v1/leads/import/upload

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/leads/import/upload \
  --header 'Authorization: Bearer <token>'

Creates an import job and returns detected columns; submit the column mapping next to run it.

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Responses

201

The import job

Media typeapplication/json

object

job_id

required

string

status

required

string

file_name

required

string

file_type

required

string

total_rows

required

number

key

additional properties

any

Example^generated

{
  "job_id": "example",
  "status": "example",
  "file_name": "example",
  "file_type": "example",
  "total_rows": 1
}

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