Skip to content
Pitch2SaleDevelopers
Open the app
Early access: these pages are being written and reviewed. Facts in the header boxes come straight from the product.

Submit the column mapping and run a lead import

POST
/api/v1/leads/import/{jobId}/map
curl --request POST \
--url https://api.pitch2sale.com/api/v1/leads/import/example/map \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "column_mappings": [ { "csv_column": "example", "crm_field": "example", "custom_field_id": null } ], "duplicate_strategy": "skip", "default_status_id": null, "default_owner_id": null }'

The import runs in the background; poll the status endpoint.

jobId
required
string
Media typeapplication/json
object
column_mappings
required
Array<object>
>= 1 items <= 200 items
object
csv_column
required
string
>= 1 characters <= 500 characters
crm_field
required
Any of:
string
<= 100 characters
custom_field_id
string | null
duplicate_strategy
string
default: skip
Allowed values: skip update create_new
default_status_id
Any of:
string
/^[0-9a-fA-F]{24}$/
default_owner_id
Any of:
string
/^[0-9a-fA-F]{24}$/

OK

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
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}

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
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}

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
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}

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
Examplegenerated
{
"error": "example",
"code": "example",
"message": "example",
"details": [
{
"field": "example",
"message": "example",
"code": "example"
}
]
}