Create Lead API Response

This is an example of the JSON response returned when successfully creating or updating a lead through the API.

{
  "id": 107646230,
  "social_id": "36N38P",
  "rank": 268,
  "counter": 2,
  "lead_count": 1,
  "contest_score": 0,
  "contest_score_rank": 1,
  "contest_score_rank_relative_position": 0,
  "rank_relative_position": 267,
  "campaign_id": 135544,
  "list_id": 135544,
  "given_name": null,
  "first_name": null,
  "avatar": "https://www.gravatar.com/avatar/f620f4647fb816073c9152a284245e64?r=g&d=identicon&s=600",
  "when": "2025-07-15T14:29:23-04:00",
  "enhanced": true,
  "anonymous": false,
  "verified": false,
  "verified_email": false,
  "verified_phone_number": false,
  "waitlisted": true,
  "display_name": "me",
  "completed_actions": [],
  "social_url": "https://www.example.com/?kid=36N38P",
  "redirect_url": "https://example.com/thanks?kolid=36N38P",
  "thankyou_url": "https://example.com/thanks?kolid=36N38P",
  "status_url": "https://example.com/thanks?kolid=36N38P",
  "email": "me@example.com",
  "phone_number": null,
  "family_name": null,
  "custom_fields": {},
  "unsubscribe_url": {
    "default": "https://oo.kickoffpages.com/opt-out/...",
    "safe": "https://oo.kickoffpages.com/opt-out/..."
  },
  "uid": null,
  "parent_id": null,
  "opted_out": false,
  "utm": {},
  "tags": [],
  "referrals": 0,
  "unverified_leads": { "indirect": 0, "direct": 0 },
  "verified_leads": { "indirect": null, "direct": null },
  "influence": { "indirect": 0, "direct": 0 },
  "subscription_number": 268,
  "ip": "127.0.0.1",
  "referrer": null,
  "fraudulent": false
}

Field reference

• id: Lead id. For API-created leads, this can be the same public value as social_id.
• social_id: Public referral/social id used in kid referral links and social ids.
• rank: Lead rank/order in the campaign.
• rank_relative_position: Zero-based rank position.
• counter: Number of times this lead has been added or updated.
• lead_count: Campaign lead count including jump-start settings.
• campaign_id and list_id: The campaign/list id.
• contest_score, contest_score_rank, contest_score_rank_relative_position: Contest score fields.
• given_name and first_name: Lead first name.
• family_name: Lead last name.
• avatar: Lead avatar URL.
• when: Lead creation timestamp in ISO-8601 format.
• enhanced: Indicates the enhanced response format.
• anonymous: Whether the lead is anonymous.
• verified, verified_email, verified_phone_number: Verification status.
• waitlisted: Whether the lead is currently waitlisted.
• display_name: Display name based on campaign display settings. Without an API key, an email username is partly hidden (jan•••).
• completed_actions: Campaign action ids completed by the lead. Omitted when __skip_actions=1 is sent.
• social_url: Referral/social URL.
• redirect_url, thankyou_url, status_url: Lead status/thank-you URLs. Omitted when __skip_urls=1 is sent.
• phone_number_verification_url: Included when phone verification is available for the lead.
• email, phone_number, custom_fields, uid, parent_id, opted_out, sms_opted_out, utm, tags: PII and account-specific fields. Returned only when the request includes your API key. Without a key, custom_fields holds only the fields sent in that request.
• unsubscribe_url: Default and safe opt-out URLs. Omitted when __skip_urls=1 is sent.
• referrals: Direct referral count. Verification campaigns use verified conversions; other campaigns use direct conversions.
• unverified_leads, verified_leads, influence: Referral-count groups.
• subscription_number: Same value as rank.
• ip, referrer, fraudulent: Returned for authenticated requests.

Privacy and authentication

Email, phone number, last name, tags, UTM data, uid and opt-out links are returned only to requests that include your API key. Unauthenticated responses (for example from browser signups) include the public fields plus the custom fields sent in that request, and display_name partly hides the email username (jan•••) when the lead has no name.