Leads

Capture Lead

post/api/v1/leads

Request

  • Base URL: https://www.endlesstravelplans.com
  • URL: https://www.endlesstravelplans.com/api/v1/leads
  • Auth: none required

Request body

emailstring required

The lead's email.

toolstring nullable

The originating tool.

sourcestring nullable

Where the capture happened.

magnetstring nullable

Must not be greater than 50 characters.

utm_sourcestring nullable

Must not be greater than 255 characters.

utm_mediumstring nullable

Must not be greater than 255 characters.

utm_campaignstring nullable

Must not be greater than 255 characters.

referrerstring nullable

Must not be greater than 255 characters.

record_typestring nullable

Artifact to link.

record_idinteger nullable

Artifact id (must belong to the caller).

consentboolean

Must be accepted.

timezonestring nullable

Must not be greater than 64 characters.

consent_rulestring nullable

The client showed the opt-in box only in the EU/UK (decision #4).

Example request

{
  "email": "traveler@example.com",
  "tool": "itinerary",
  "source": "exit_intent",
  "magnet": "y",
  "utm_source": "v",
  "utm_medium": "d",
  "utm_campaign": "l",
  "referrer": "j",
  "record_type": "budget_calculator",
  "record_id": 42,
  "consent": true,
  "timezone": "Africa/Dakar",
  "consent_rule": "eu-uk"
}

Response

OR

Example response

{
  "message": "Thanks! We'll be in touch."
}

Changes

No recorded changes to this operation across all 1 revision of this API.