Create ingest endpoint

POST

/api/v1/ingest-endpoints

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/ingest-endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "source": "example", "mappings": [ { "from": "example", "to": "example" } ], "dedup_strategy": "create_new", "dedup_field": "email", "default_status_id": "example", "default_owner_id": "example", "external_id_path": "example", "signing_secret": "example" }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

name

required

string

>= 1 characters <= 200 characters

source

string

>= 1 characters <= 100 characters

mappings

Array<object>

<= 100 items

object

from

required

string

>= 1 characters <= 300 characters

to

required

string

>= 1 characters <= 300 characters /^(lead|contact|custom_field)\./

dedup_strategy

string

Allowed values: create_new update_existing skip

dedup_field

string

Allowed values: email phone email_or_phone name

default_status_id

Any of:

string

string

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

null

null

default_owner_id

Any of:

string

string

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

null

null

external_id_path

Any of:

string

string

<= 300 characters

null

null

signing_secret

Any of:

string

string

>= 8 characters <= 200 characters

null

null

Responses

201

Created

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

402

Feature not available on the organization plan

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