Developer Portal

WebForm API

Capturing Leads can be done server-side through our WebForm API.
Below is a overview of the calls that can be made and the responses that can be received. For any other information or questions, please contact support.

WebForm Calls
All WebForm calls need to be in POST and made against the following URL:
https://api.nucleuscrm.net/webforms

Parameter
Type
Description
appkey*
string
Application key for identification.
authkey*
string
WebForm access key for authentication.
name*
string
Lead name, descriptive name, customer name etc [max 64 chars]
description
string
Free text [max 512 chars]
phonework
integer
Number format. All non-numeric characters will be stripped. [max 15 chars]
phonemobile
integer
Number format. All non-numeric characters will be stripped. [max 15 chars]
phoneprivate
integer
Number format. All non-numeric characters will be stripped. [max 15 chars]
fax
integer
Number format. All non-numeric characters will be stripped. [max 15 chars]
billingaddress
string
Free text, multi-line [max 128 chars]
shippingaddress
string
Free text, multi-line [max 128 chars]
officeaddress
string
Free text, multi-line [max 128 chars]
emailwork
string
Free text [max 64 chars]
emailprivate
string
E-mail address format example@nucleuscrm.com [max 64 chars]
web
string
Free text, with leading http:// or https:// [max 128 chars]
twitter
string
Free text [max 64 chars]
facebook
string
Free text [max 64 chars]
 
* = required parameter


We use cookies for site operation and analytics to improve user experience. You can read more about cookie usage in our Privacy Policy.