Lead Capture

This endpoint allows for creation of leads, i.e. automation of customer RFP forms.

Get Available RFP Form fields

First, learn about what fields are available on an individual lead form.

HTTP Request

GET https://stscloud.com/interfaces/lead_capture/rfp_forms/FORM_ID.json?username=USERNAME&key=API_KEY

Make sure to replace USERNAME with your STS Cloud username, and API_KEY with your API key.

Query Parameters

Parameter	Required	Description
FORM_ID	Yes	The 8-digit alphanumeric form permalink

Sample Response

[
  {
    "name": "title",
    "required": true,
    "position": 1,
    "label": "Name of your event",
    "hint": null
  },
  {
    "name": "start_date",
    "required": true,
    "position": 2,
    "label": "Event start date",
    "hint": null
  },
  {
    "name": "end_date",
    "required": true,
    "position": 3,
    "label": "Event end date",
    "hint": null
  },
  {
    "name": "alternate_dates",
    "required": false,
    "position": 4,
    "label": null,
    "hint": "If your dates are firm, leave this blank."
  },
  {
    "name": "number_of_attendees",
    "required": true,
    "position": 5,
    "label": "Expected number of attendees",
    "hint": null
  },
  {
    "name": "guest_room_requirements",
    "required": false,
    "position": 6,
    "label": null,
    "hint": "If you do not need guest rooms, leave this blank."
  },
  {
    "name": "function_space_requirements",
    "required": false,
    "position": 7,
    "label": null,
    "hint": "If you do not need function space, leave this blank."
  },
  {
    "name": "description",
    "required": false,
    "position": 8,
    "label": "Description and notes",
    "hint": "Provide a description of your event requirements and any other important information we should know."
  },
  {
    "name": "file",
    "required": false,
    "position": 9,
    "label": "Attachment",
    "hint": "If you have an existing agenda or event specs, please feel free to attach it here."
  },
  {
    "name": "customer_name",
    "required": false,
    "position": 10,
    "label": "Group name",
    "hint": "Your group, organization, or company name"
  },
  {
    "name": "customer_contact_name",
    "required": true,
    "position": 11,
    "label": "Contact name",
    "hint": null
  },
  {
    "name": "customer_contact_title",
    "required": false,
    "position": 12,
    "label": "Title",
    "hint": "If applicable"
  },
  {
    "name": "customer_contact_email",
    "required": true,
    "position": 13,
    "label": "Email Address",
    "hint": null
  },
  {
    "name": "customer_contact_phone",
    "required": true,
    "position": 14,
    "label": "Phone",
    "hint": null
  }
]

Create a Lead

HTTP Request

POST https://stscloud.com/interfaces/lead_capture/leads?username=USERNAME&key=API_KEY&rfp_form_id=FORM_ID

Make sure to replace USERNAME with your STS Cloud username, and API_KEY with your API key.

Query Parameters

Parameter	Required	Description
FORM_ID	Yes	The 8-digit alphanumeric form permalink

Sample Request (JSON)

Using the name of each field available in the RFP form, create the request. All fields marked as required must be present in the request.

{
  "title": "Acme Corp Event",
  "start_date": "2025-01-15",
  "end_date": "2025-01-16",
  "number_of_attendees": "50",
  "customer_contact_name": "Jane Doe",
  "customer_contact_email": "[email protected]",
  "customer_contact_phone": "312-555-1212"
}

Sample Response (Success)

{
  "success": true,
  "id": 9889880
}

The id may be used to provide the end-user with a link to the lead response form, e.g. https://stscloud.com/leads/9889880

Sample Response (Error When Missing Required Fields)

{
  "error": {
    "customer_contact_email": [
      "is a required field",
      "should be in the format [email protected]"
    ],
    "customer_contact_phone": [
      "is a required field"
    ]
  }
}