Create a contact on a lead

POST

/api/v1/contacts

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "lead_id": "example", "first_name": "example", "last_name": "example", "email": "", "phone": "example", "title": "example", "preferred_language": "", "is_primary": true, "custom_fields": { "additionalProperty": "example" } }'

Authorizations

• bearerJwt
• personalAccessToken
  write:contacts
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

lead_id

required

string

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

first_name

required

string

>= 1 characters <= 100 characters

last_name

required

string

>= 1 characters <= 100 characters

email

Any of:

string

string format: email

string

string

phone

string

title

string

preferred_language

Any of:

string

string

<= 10 characters

string

string

is_primary

boolean

custom_fields

object

key

additional properties

Responses

201

The new contact

Media typeapplication/json

object

contact

required

object

_id

required

string

lead_id

required

string

first_name

required

string

last_name

required

string

email

required

string | null

phone

required

string | null

key

additional properties

any

Example^generated

{
  "contact": {
    "_id": "example",
    "lead_id": "example",
    "first_name": "example",
    "last_name": "example",
    "email": "example",
    "phone": "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"
    }
  ]
}