POST {apiVersion}/Names/NewLead

Allow the submittion of a new lead. This action will create a new name record and also add records to all the associated tables

Request Information

URI Parameters

NameDescriptionTypeAdditional information
apiVersion

Required routing parameter defining which version of the API to call. Currently use "v1" for all API requests.

string

None.

Body Parameters

NewLead
NameDescriptionTypeAdditional information
ID

GUID identifying this name. Do not specify a value when using POST to create new Names as the database will automatically create a new ID when creating a new Name record.

 globally unique identifier

None.
FirstName

Individual Name's First Name.

 string

Max length: 30
MiddleName

Individual Name's Middle Name.

 string

Max length: 20
LastName

Individual Name's Last Name

 string

Max length: 60
FullName

Individual Full Name

 string

Max length: 200
CompanyName

Organization Name

 string

Max length: 100
Subject

Submission Subject

 string

Max length: 200
PhoneNumber

Contact Phone Number

 string

Max length: 30
EmailAddress

Contact Email Address

 string

Max length: 200
Comment

Addition comment sent by new lead

 string

None.
SubmissionURL

Lead source URL

 string

None.
IntegrationSource

Name of the integration source, i.e. Zapier

 string

None.
WhenChangedDateTime

Date\Time that the database record was last changed.

 date

None.
WhoChanged

Initials of the user who last changed this record.

 string

None.
WhenAddedDateTime

Date\Time that the database record was added.

 date

None.
WhoAdded

Initials of the user who created this record.

 string

None.

Request Formats

application/json, text/json, application/hal+json

Sample: 
{
  "WhenChangedDateTime": "2025-01-17T20:59:02-08:00",
  "WhoChanged": "sample string 1",
  "WhenAddedDateTime": "2025-01-17T20:59:02-08:00",
  "WhoAdded": "sample string 2",
  "ID": "9357b74d-ea9d-45be-801b-0eb5ca1ae9d2",
  "FirstName": "sample string 1",
  "MiddleName": "sample string 2",
  "LastName": "sample string 3",
  "FullName": "sample string 4",
  "CompanyName": "sample string 5",
  "Subject": "sample string 6",
  "PhoneNumber": "sample string 7",
  "EmailAddress": "sample string 8",
  "Comment": "sample string 9",
  "SubmissionURL": "sample string 10",
  "IntegrationSource": "sample string 11",
  "_links": {
    "self": {
      "href": "sample string 13"
    },
    "sample string 1": {
      "href": "sample string 2",
      "title": "sample string 3",
      "type": "sample string 4",
      "deprecation": "sample string 5",
      "name": "sample string 6",
      "profile": "sample string 7",
      "hreflang": "sample string 8"
    }
  },
  "_embedded": null
}

Response Information

Resource Description

IHttpActionResult

None.