Create a lead capture form

POST

/api/v1/forms

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/forms \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "description": "example", "fields": [ { "name": "example", "label": "example", "type": "text", "required": false, "placeholder": "example", "default_value": "example", "options": [ "example" ], "custom_field_id": "example", "order": 0, "validation_regex": "example", "validation_message": "example" } ], "dedup_strategy": "none", "assignment_strategy": "round_robin", "assigned_user_ids": [ "example" ], "default_status_id": "example", "default_source": "example", "default_tags": [ "example" ], "success_message": "example", "redirect_url": "https://example.com", "recaptcha_enabled": false, "is_active": true, "style": { "theme": "light", "primary_color": "example", "background_color": "example", "font_family": "example", "custom_css": "example" } }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

name

required

string

>= 1 characters <= 500 characters

description

string

<= 2000 characters

fields

required

Array<object>

>= 1 items

object

name

required

string

>= 1 characters <= 200 characters

label

required

string

>= 1 characters <= 500 characters

type

required

string

Allowed values: text email phone textarea number select multi_select checkbox radio date url hidden

required

boolean

placeholder

string

<= 500 characters

default_value

string

<= 1000 characters

options

Array<string>

custom_field_id

string

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

order

integer

0

validation_regex

string

<= 500 characters

validation_message

string

<= 500 characters

dedup_strategy

string

default: email

Allowed values: none email phone email_or_phone

assignment_strategy

string

default: none

Allowed values: round_robin fixed none

assigned_user_ids

Array<string>

default_status_id

string

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

default_source

string

<= 200 characters

default_tags

Array<string>

success_message

string

<= 2000 characters

redirect_url

string format: uri

recaptcha_enabled

boolean

is_active

boolean

default: true

style

object

theme

string

default: light

Allowed values: light dark custom

primary_color

string

<= 20 characters

background_color

string

<= 20 characters

font_family

string

<= 100 characters

custom_css

string

<= 10000 characters

Responses

201

The new form

Media typeapplication/json

object

form

required

object

_id

required

string

key

additional properties

any

Example^generated

{
  "form": {
    "_id": "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"
    }
  ]
}