#Capture links

Capture links let you send a lead's data to Clickmax without relying on a form built inside the platform.

In practice, you get a capture URL and send it the data you want to save, such as name, email and phone number.

If you already have a landing page, an external form or an integration of your own, just use the capture link generated in Clickmax and send the lead's data to that URL. Clickmax receives the information and creates or updates the lead automatically.

#Sending example

The request has to use the POST method with the content in JSON format.

Example URL:

https://api.clickmax.dev/ingest/SEU_LINK_DE_CAPTURA

Example payload:

{
  "email": "[email protected]",
  "name": "Maria Silva",
  "telephone": "5511999999999",
  "document": "12345678900",
  "profession": "Analista",
  "city": "São Paulo",
  "state": "SP",
  "instagram": "mariasilva",
  "birthday": "1990-05-20",
  "address": {
    "street": "Av. Paulista",
    "number": "1000",
    "neighborhood": "Bela Vista",
    "city": "São Paulo",
    "state": "SP",
    "zipCode": "01310-100",
    "country": "BR"
  },
  "customFields": {
    "empresa": "Acme Inc",
    "orcamento": 50000
  },
  "utmSource": "facebook",
  "utmMedium": "cpc",
  "utmCampaign": "campanha-de-captacao",
  "utmContent": "criativo-a",
  "utmTerm": "gestao comercial"
}

Example with curl:

curl -X POST "https://api.clickmax.dev/ingest/SEU_LINK_DE_CAPTURA" \
  -H "Content-Type: application/json" \
  --data '{
    "email": "[email protected]",
    "name": "Maria Silva",
    "telephone": "5511999999999",
    "utmSource": "facebook",
    "utmMedium": "cpc",
    "utmCampaign": "campanha-de-captacao",
    "utmContent": "criativo-a",
    "utmTerm": "gestao comercial"
  }'

#The most common fields

#Custom fields

You can send values for your workspace's custom fields using the customFields object. Each key identifies a field and can be:

• the field's name (e.g. empresa),
• the label shown (e.g. Empresa), or
• the custom field's id.

Fields that are not found are silently ignored (the lead is still created). Custom fields are only written when the lead is created — if the lead already exists (same email or phone number), they are not overwritten.

#Things to watch out for

• send the phone number with digits only
• wherever possible, send at least a name, email or phone number so the lead is easier to identify

#Expected response

When the request is accepted, the response returns an identifier for the lead created:

{
  "leadId": "088a60ed-7fe6-4a96-b7dd-a91573fc3cdc"
}

#Quick recap

If you already have a page or form outside Clickmax, the capture link is the simplest way to get that data into the platform.