Page tree
Skip to end of metadata
Go to start of metadata

Get /web_form/{web_form_id} 

Provides the web_form matching web_form_id

Returns the unique web_form matching the web_form_Id

SalesSeek system can be integrated with any HTML web form for automatically create a new contact anytime a new user enter his data on that web form. This integration can be quickly configured in 2 steps:

  1. Adding the following HTML line into the same page the web form is:

    <script src="http://tstatic.salesseek.net/register.js?clientid={Client_ID}"></script> 

    where {Client_ID} is the SalesSeek's account unique name
     

  2. Provide the relation between the form fields and SalesSeek Contacts' fields to to the right match, this Web Form resource is intended to provide that match

 

Request URL

https://{client_id}.salesseek.net/api/web_form/1

Response Type

Response content type: JSON(Web_Form)

ModelExample of Response

Web_Form (JSON) {

mapping (Array[Web_Form_Mapping]): list of web form fields related to the corresponding SalesSeek Contact field,

source (Lead_Source): id for the specific lead source to be matched when a new contact registers using the web form,

* the lead source could be one the default Web Registration or any other custom lead source configured

}

Web_Form_Mapping (JSON) {

form_field_name (string): must match exactly the same input field name from the web form,

lead_field (string): must match exactly the same Lead field name from SalesSeek configuration

}

Lead_Source (JSON) {

id (string): unique identifier for this Lead Source,

name (string): Lead Source name to be shown

}

{
    mappings: [
		0: {
			form_field_name: "web_first_name",
			lead_field: "first_name"
		},
		1: {
			form_field_name: "web_last_name"
			lead_field: "last_name"
		},
		2: {
			form_field_name: "web_email"
			lead_field: "email"
		},
		3: {
			form_field_name: "web_phone"
			lead_field: "phone"
		},
		4: {
			form_field_name: "web_organization"
			lead_field: "organization_name"
		},
		5: {
			form_field_name: "web_url"
			lead_field: "27f9808d8fe31"
		}
	]
	source: {
		id: "6805235"
		name: "Web Registration"
	}
}

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
 web_form_idInYThe id of web_form to be requestedstring
responseOut-The requested web_formJSON

 

 


 

 

POST /web_form

Creates a new web form match

Creates a new web_form and Returns the resulting element 

Request URL

https://{client_id}.salesseek.net/api/web_form

Request Body
{
    mappings: [
		0: {
			form_field_name: "web_first_name",
			lead_field: "first_name"
		},
		1: {
			form_field_name: "web_last_name"
			lead_field: "last_name"
		},
		2: {
			form_field_name: "web_email"
			lead_field: "email"
		},
		3: {
			form_field_name: "web_phone"
			lead_field: "phone"
		},
		4: {
			form_field_name: "web_organization"
			lead_field: "organization_name"
		},
		5: {
			form_field_name: "web_url"
			lead_field: "27f9808d8fe31"
		}
	]
	source: {
		id: "6805235"
		name: "Web Registration"
	}
}

 

Response Type

Response content type: JSON (Web Form)

ModelExample of Response

Web_Form (JSON) {

mapping (Array[Web_Form_Mapping]): list of web form fields related to the corresponding SalesSeek Contact field,

source (Lead_Source): id for the specific lead source to be matched when a new contact registers using the web form,

* the lead source could be one the default Web Registration or any other custom lead source configured

}

Web_Form_Mapping (JSON) {

form_field_name (string): must match exactly the same input field name from the web form,

lead_field (string): must match exactly the same Lead field name from SalesSeek configuration

}

Lead_Source (JSON) {

id (string): unique identifier for this Lead Source,

name (string): Lead Source name to be shown

}

{
    mappings: [
		0: {
			form_field_name: "web_first_name",
			lead_field: "first_name"
		},
		1: {
			form_field_name: "web_last_name"
			lead_field: "last_name"
		},
		2: {
			form_field_name: "web_email"
			lead_field: "email"
		},
		3: {
			form_field_name: "web_phone"
			lead_field: "phone"
		},
		4: {
			form_field_name: "web_organization"
			lead_field: "organization_name"
		},
		5: {
			form_field_name: "web_url"
			lead_field: "27f9808d8fe31"
		}
	]
	source: {
		id: "6805235"
		name: "Web Registration"
	}
}

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
responseOut-The web form match created after the successful requestJSON

 

 


 

 

PATCH /web_form/{web_form_id}

Update a specific web_form by its ID

Updates a web_form by its {web_form_id} and Returns the resulting element. The fields updated are just the ones passed on the request body

 

Request URL

https://{client_id}.salesseek.net/api/web_form/1  

 

Request Body
{
	mappings: [
		0: {
			form_field_name: "web_first_name",
			lead_field: "first_name"
		},
		1: {
			form_field_name: "web_last_name"
			lead_field: "last_name"
		},
		2: {
			form_field_name: "web_email"
			lead_field: "email"
		},
		3: {
			form_field_name: "web_phone"
			lead_field: "phone"
		},
		4: {
			form_field_name: "web_organization"
			lead_field: "organization_name"
		},
		5: {
			form_field_name: "web_url"
			lead_field: "27f9808d8fe31"
		},
		6: {
			form_field_name: "web_who_reffered_you",
			lead_field: "6ef2fa34"
		}
	]
}

 

Response Type

Response content type: JSON(Web_Form)

ModelExample of Response

Web_Form (JSON) {

mapping (Array[Web_Form_Mapping]): list of web form fields related to the corresponding SalesSeek Contact field,

source (Lead_Source): id for the specific lead source to be matched when a new contact registers using the web form,

* the lead source could be one the default Web Registration or any other custom lead source configured

}

Web_Form_Mapping (JSON) {

form_field_name (string): must match exactly the same input field name from the web form,

lead_field (string): must match exactly the same Lead field name from SalesSeek configuration

}

Lead_Source (JSON) {

id (string): unique identifier for this Lead Source,

name (string): Lead Source name to be shown

}

{
    mappings: [
		0: {
			form_field_name: "web_first_name",
			lead_field: "first_name"
		},
		1: {
			form_field_name: "web_last_name"
			lead_field: "last_name"
		},
		2: {
			form_field_name: "web_email"
			lead_field: "email"
		},
		3: {
			form_field_name: "web_phone"
			lead_field: "phone"
		},
		4: {
			form_field_name: "web_organization"
			lead_field: "organization_name"
		},
		5: {
			form_field_name: "web_url"
			lead_field: "27f9808d8fe31"
		},
		6: {

			form_field_name: "web_who_reffered_you",
			lead_field: "6ef2fa34"
		}
	]
	source: {
		id: "6805235"
		name: "Web Registration"
	}
}

 

Parameters

ParameterIn / OutRequiredDescriptionParameter TypeData Type
web_form_idInYThe id of the web form to be updatedstring
 web_form InYThe subset of the web form fields to be updatedJSON
 response OutThe web form after the successful updateJSON
  • No labels