Submit Lead Form - Plugixa CRM

POST /plugixa-crm/v1/lead-capture/{id}

Submit a lead capture form from your own front end or another site. This is the endpoint the plugin’s own form posts to.

Public: no sign-in. The form must exist and be active, and the Web forms app must be on. Requests are limited to 10 an hour per IP address, across all forms.

Content type decides the answer. With Content-Type: application/json you get JSON. Anything else, such as a plain HTML form post, gets a 303 redirect instead, to the form’s success page or back to source_url.

A duplicate is reported as a success. When the form checks for duplicates and a lead with the same e-mail exists, nothing is created and the response is the normal success.

Note. Every request that passes the honeypot counts toward the rate limit, including ones then refused for missing fields.

Request

POST https://your-site.example/wp-json/plugixa-crm/v1/lead-capture/3

Path parameters

Request body

Content type: application/json, or application/x-www-form-urlencoded for a plain HTML form

Only fields the form offers are read; everything else is dropped. Fields the form marks required must be filled, choice fields must hold one of their options, and at least one of first_name, last_name and account_name is needed.

The lead is created with status new, the form’s source and the form’s owner. When the form uses double opt-in, the lead is only created once the visitor clicks the link in the confirmation e-mail, unless the form is set to create it first.

{
  "first_name": "Ada",
  "last_name": "Lovelace",
  "account_name": "Analytical Engines Ltd",
  "email": "ada@analytical.example",
  "description": "We would like a demo.",
  "source_url": "https://your-site.example/contact"
}

Responses

200 OK. The submission was accepted.

{
  "success": true,
  "data": {
    "submitted": true,
    "message": "Thanks, we will be in touch.",
    "redirect_url": "https://your-site.example/thank-you"
  }
}

A form-encoded request gets 303 See Other instead, with Location set to the form’s success page, else source_url, with plugixa-crm-lead=sent added; on an error, back to source_url with plugixa-crm-lead=error.

Errors

Plus the errors every endpoint can return.

Examples

curl -s -X POST "https://your-site.example/wp-json/plugixa-crm/v1/lead-capture/3" \
  -H "Content-Type: application/json" \
  -d '{"first_name":"Ada","last_name":"Lovelace","account_name":"Analytical Engines Ltd","email":"ada@analytical.example","description":"We would like a demo.","source_url":"https://your-site.example/contact"}'

<?php
$ch = curl_init('https://your-site.example/wp-json/plugixa-crm/v1/lead-capture/3');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST  => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER     => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS     => json_encode([
        'first_name'   => 'Ada',
        'last_name'    => 'Lovelace',
        'account_name' => 'Analytical Engines Ltd',
        'email'        => 'ada@analytical.example',
        'description'  => 'We would like a demo.',
        'source_url'   => 'https://your-site.example/contact',
    ]),
]);
$response = json_decode(curl_exec($ch), true);
curl_close($ch);

const response = await fetch('https://your-site.example/wp-json/plugixa-crm/v1/lead-capture/3', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    first_name: 'Ada',
    last_name: 'Lovelace',
    account_name: 'Analytical Engines Ltd',
    email: 'ada@analytical.example',
    description: 'We would like a demo.',
    source_url: 'https://your-site.example/contact',
  }),
});
const { data } = await response.json();