Back to top

API Documentation

Lead Channel

Overview

A LeadChannel represents an endpoint through which leads are captured and routed

Field Type Association Description
id uuid Internal identifier of the lead channel
brand uuid Brand to which this lead channel belongs
created_at number Timestamp of when this lead channel was created
updated_at number Timestamp of when this lead channel was last updated
deleted_at number Timestamp of when this lead channel was deleted (if applicable)
capture_number number Number of leads captured by this channel so far
last_capture_date number Timestamp of the most recent lead captured
mls string[] List of code names of relevant MLS to search for listings mentioned by incoming leads
is_default boolean Whether this lead channel is the default lead channel for the brand

Get Lead Channel of brand

Get Lead Channel of brand
GET/brands/:brand/leads/channels

brand (uuid) ID of the brand

Example URI

GET /brands/:brand/leads/channels
URI Parameters
HideShow
brand
string (required) Example: 7f9ebf54-3545-42ad-9dc5-115ea8ac5afd
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "bb515791-edbd-4999-9b3d-099b89ddf1fa",
      "name": "Default Route",
      "brand": "7f9ebf54-3545-42ad-9dc5-115ea8ac5afd",
      "capture_number": 0,
      "mls": null,
      "is_default": true,
      "type": "lead_channel",
      "created_at": 1765163563.53262,
      "updated_at": 1765163563.532624,
      "deleted_at": null,
      "last_capture_date": null,
      "rules_count": "1",
      "title": null
    },
    {
      "id": "a85ad5ac-0deb-4866-b108-4a4561d1b4e2",
      "name": null,
      "brand": "7f9ebf54-3545-42ad-9dc5-115ea8ac5afd",
      "capture_number": 0,
      "mls": null,
      "is_default": false,
      "type": "lead_channel",
      "created_at": 1765163563.624417,
      "updated_at": 1765163563.62442,
      "deleted_at": null,
      "last_capture_date": null,
      "rules_count": "1",
      "title": null
    }
  ],
  "info": {
    "count": 2,
    "total": 2
  }
}

Create a Lead Channel

Create a Lead Channel
POST/brands/:brand/leads/channels

Example URI

POST /brands/:brand/leads/channels
URI Parameters
HideShow
brand
string (required) Example: 7f9ebf54-3545-42ad-9dc5-115ea8ac5afd
Request
HideShow
Body
{
  "protocol": "JSON"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "a85ad5ac-0deb-4866-b108-4a4561d1b4e2",
    "name": null,
    "brand": "7f9ebf54-3545-42ad-9dc5-115ea8ac5afd",
    "capture_number": 0,
    "mls": null,
    "is_default": false,
    "type": "lead_channel",
    "created_at": 1765163563.624417,
    "updated_at": 1765163563.62442,
    "deleted_at": null,
    "last_capture_date": null,
    "rules_count": "1",
    "title": null
  }
}

Delete a Lead Channel

Delete a Lead Channel
DELETE/brands/:brand/leads/channels/:leadChannelId

Example URI

DELETE /brands/:brand/leads/channels/:leadChannelId
URI Parameters
HideShow
brand
string (required) Example: 7f9ebf54-3545-42ad-9dc5-115ea8ac5afd
channel
string (required) Example: a85ad5ac-0deb-4866-b108-4a4561d1b4e2
Request
HideShow
Body
{
  "brand": "fd9d7877-3510-44ce-87f4-ada242793762"
}
Response  204

Update a Lead Channel

Update a Lead Channel
PUT/brands/:brand/leads/channels/:leadChannelId

Example URI

PUT /brands/:brand/leads/channels/:leadChannelId
URI Parameters
HideShow
brand
string (required) Example: 7f9ebf54-3545-42ad-9dc5-115ea8ac5afd
channel
string (required) Example: a85ad5ac-0deb-4866-b108-4a4561d1b4e2
Request
HideShow
Body
{
  "name": "New Name"
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "a85ad5ac-0deb-4866-b108-4a4561d1b4e2",
    "name": "New Name",
    "brand": "7f9ebf54-3545-42ad-9dc5-115ea8ac5afd",
    "capture_number": 0,
    "mls": null,
    "is_default": false,
    "type": "lead_channel",
    "created_at": 1765163563.624417,
    "updated_at": 1765163562.878854,
    "deleted_at": null,
    "last_capture_date": null,
    "rules_count": "1",
    "title": null
  }
}

Rule

Overview

Rule

A LeadChannelRule determines how leads are routed based on specified conditions.

Field Type Association Description
id uuid Internal identifier of the lead routing rule
created_at number Timestamp of when this rule was created
updated_at number Timestamp of when this rule was last updated
created_by uuid User who created this rule
kind ‘AND’ | ‘OR’ Logical operator for combining conditions (AND or OR)
is_default boolean Whether this rule is the default rule for the channel
order number Order of this rule in the routing sequence
conditions uuid[] lead_channel_rule.conditions List of condition identifiers associated with this rule
flow uuid | null lead_channel_rule.flow Identifier of the flow to enroll leads into (if applicable)
target ‘Group’ | ‘User’ | ‘Brand’ Type of target entity this rule applies to
group uuid | null lead_channel_rule.group Identifier of the group (if target is ‘Group’)
user uuid | null lead_channel_rule.user Identifier of the user (if target is ‘User’)
brand uuid | null lead_channel_rule.brand Identifier of the brand (if target is ‘Brand’ or ‘User’)

RuleCondition

A LeadChannelRuleCondition specifies a single criterion used to evaluate and filter leads.

Field Type Association Description
id uuid Internal identifier of the condition
created_at number Timestamp of when this condition was created
order number Order of this condition in the rule’s conditions sequence
field string Field name to be evaluated
operator ‘eq’ | ‘any’ | ‘all’ | ‘gte’ | ‘lte’ Operator to be used for evaluation
value any Value against which the field will be evaluated
negated boolean Whether to negate the condition’s evaluation

Create a lead channel rule

Create a lead channel rule
POST/brands/:brand/leads/channels/:id/rules

Example URI

POST /brands/:brand/leads/channels/:id/rules
URI Parameters
HideShow
brand
string (required) Example: 7f9ebf54-3545-42ad-9dc5-115ea8ac5afd
channel
string (required) Example: a85ad5ac-0deb-4866-b108-4a4561d1b4e2
associations
string (required) Example: lead_channel_rule.conditions,lead_channel_rule.brand,lead_channel_rule.user
Request
HideShow
Body
{
  "target": "User",
  "kind": "AND",
  "order": 1,
  "flow": null,
  "user": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
  "brand": "7f9ebf54-3545-42ad-9dc5-115ea8ac5afd",
  "conditions": [
    {
      "field": "price",
      "operator": "gte",
      "value": 500000,
      "order": 1
    }
  ]
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "2a432b3c-2db9-4202-b8e6-bae1b8e8252a",
    "created_at": 1765163562.878854,
    "updated_at": 1765163562.878854,
    "deleted_at": null,
    "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "channel": "a85ad5ac-0deb-4866-b108-4a4561d1b4e2",
    "kind": "AND",
    "order": 1,
    "target": "User",
    "user": {
      "type": "user",
      "username": null,
      "first_name": "Unit",
      "last_name": "Test",
      "email": "[email protected]",
      "phone_number": "+4368120265807",
      "created_at": 1493115498.770362,
      "id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "address_id": null,
      "cover_image_url": null,
      "profile_image_url": null,
      "updated_at": 1493115498.770744,
      "user_status": "Active",
      "profile_image_thumbnail_url": null,
      "cover_image_thumbnail_url": null,
      "email_confirmed": true,
      "timezone": "America/Chicago",
      "user_type": "Admin",
      "deleted_at": null,
      "phone_confirmed": false,
      "is_shadow": false,
      "personal_room": null,
      "brand": null,
      "fake_email": false,
      "features": [
        "Deals"
      ],
      "last_seen_at": null,
      "email_signature": null,
      "daily_enabled": false,
      "email_quota": 30000,
      "website": null,
      "instagram": null,
      "twitter": null,
      "linkedin": null,
      "youtube": null,
      "facebook": null,
      "designation": null,
      "tiktok": null,
      "mfa_enabled": false,
      "xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "current_time": "9:12 PM - Sunday Dec 07, 2025",
      "push_allowed": true,
      "agents": null,
      "last_seen_type": null,
      "active_brand": "fd9d7877-3510-44ce-87f4-ada242793762",
      "display_name": "Unit Test",
      "abbreviated_display_name": "Unit",
      "online_state": "Offline",
      "has_password": true
    },
    "brand": {
      "id": "7f9ebf54-3545-42ad-9dc5-115ea8ac5afd",
      "created_at": 1765163562.965226,
      "updated_at": 1765163562.965226,
      "palette": null,
      "assets": null,
      "messages": null,
      "parent": null,
      "name": "LeadChannel",
      "deleted_at": null,
      "training": false,
      "brand_type": "Team",
      "parents": null,
      "type": "brand",
      "hostnames": null,
      "member_count": 1,
      "base_url": "https://irish.rechat.com"
    },
    "is_default": false,
    "conditions": [
      {
        "id": "639c0844-e45a-492a-a198-b683de3b8cf4",
        "created_at": 1765163562.878854,
        "rule": "2a432b3c-2db9-4202-b8e6-bae1b8e8252a",
        "order": 1,
        "field": "price",
        "operator": "gte",
        "value": 500000,
        "negated": false,
        "type": "lead_channel_rule_condition"
      }
    ],
    "type": "lead_channel_rule"
  }
}

Get rules for a lead channel

Get rules for a lead channel
GET/brands/:brand/leads/channels/:id/rules

Example URI

GET /brands/:brand/leads/channels/:id/rules
URI Parameters
HideShow
brand
string (required) Example: 7f9ebf54-3545-42ad-9dc5-115ea8ac5afd
channel
string (required) Example: a85ad5ac-0deb-4866-b108-4a4561d1b4e2
associations
string (required) Example: lead_channel_rule.conditions,lead_channel_rule.brand,lead_channel_rule.user
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "2a432b3c-2db9-4202-b8e6-bae1b8e8252a",
      "created_at": 1765163562.878854,
      "updated_at": 1765163562.878854,
      "deleted_at": null,
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "channel": "a85ad5ac-0deb-4866-b108-4a4561d1b4e2",
      "kind": "AND",
      "order": 1,
      "target": "User",
      "user": {
        "type": "user",
        "username": null,
        "first_name": "Unit",
        "last_name": "Test",
        "email": "[email protected]",
        "phone_number": "+4368120265807",
        "created_at": 1493115498.770362,
        "id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "address_id": null,
        "cover_image_url": null,
        "profile_image_url": null,
        "updated_at": 1493115498.770744,
        "user_status": "Active",
        "profile_image_thumbnail_url": null,
        "cover_image_thumbnail_url": null,
        "email_confirmed": true,
        "timezone": "America/Chicago",
        "user_type": "Admin",
        "deleted_at": null,
        "phone_confirmed": false,
        "is_shadow": false,
        "personal_room": null,
        "brand": null,
        "fake_email": false,
        "features": [
          "Deals"
        ],
        "last_seen_at": null,
        "email_signature": null,
        "daily_enabled": false,
        "email_quota": 30000,
        "website": null,
        "instagram": null,
        "twitter": null,
        "linkedin": null,
        "youtube": null,
        "facebook": null,
        "designation": null,
        "tiktok": null,
        "mfa_enabled": false,
        "xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "current_time": "9:12 PM - Sunday Dec 07, 2025",
        "push_allowed": true,
        "agents": null,
        "last_seen_type": null,
        "active_brand": "fd9d7877-3510-44ce-87f4-ada242793762",
        "display_name": "Unit Test",
        "abbreviated_display_name": "Unit",
        "online_state": "Offline",
        "has_password": true
      },
      "brand": {
        "id": "7f9ebf54-3545-42ad-9dc5-115ea8ac5afd",
        "created_at": 1765163562.965226,
        "updated_at": 1765163562.965226,
        "palette": null,
        "assets": null,
        "messages": null,
        "parent": null,
        "name": "LeadChannel",
        "deleted_at": null,
        "training": false,
        "brand_type": "Team",
        "parents": null,
        "type": "brand",
        "hostnames": null,
        "member_count": 1,
        "base_url": "https://irish.rechat.com"
      },
      "is_default": false,
      "conditions": [
        {
          "id": "639c0844-e45a-492a-a198-b683de3b8cf4",
          "created_at": 1765163562.878854,
          "rule": "2a432b3c-2db9-4202-b8e6-bae1b8e8252a",
          "order": 1,
          "field": "price",
          "operator": "gte",
          "value": 500000,
          "negated": false,
          "type": "lead_channel_rule_condition"
        }
      ],
      "type": "lead_channel_rule"
    },
    {
      "id": "10048352-efc9-42e3-8432-543d1ce52fd8",
      "created_at": 1765163562.878854,
      "updated_at": 1765163562.878854,
      "deleted_at": null,
      "created_by": null,
      "channel": "a85ad5ac-0deb-4866-b108-4a4561d1b4e2",
      "kind": "AND",
      "order": 32767,
      "target": "User",
      "user": {
        "type": "user",
        "username": null,
        "first_name": "Unit",
        "last_name": "Test",
        "email": "[email protected]",
        "phone_number": "+4368120265807",
        "created_at": 1493115498.770362,
        "id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "address_id": null,
        "cover_image_url": null,
        "profile_image_url": null,
        "updated_at": 1493115498.770744,
        "user_status": "Active",
        "profile_image_thumbnail_url": null,
        "cover_image_thumbnail_url": null,
        "email_confirmed": true,
        "timezone": "America/Chicago",
        "user_type": "Admin",
        "deleted_at": null,
        "phone_confirmed": false,
        "is_shadow": false,
        "personal_room": null,
        "brand": null,
        "fake_email": false,
        "features": [
          "Deals"
        ],
        "last_seen_at": null,
        "email_signature": null,
        "daily_enabled": false,
        "email_quota": 30000,
        "website": null,
        "instagram": null,
        "twitter": null,
        "linkedin": null,
        "youtube": null,
        "facebook": null,
        "designation": null,
        "tiktok": null,
        "mfa_enabled": false,
        "xpressdocs_user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
        "current_time": "9:12 PM - Sunday Dec 07, 2025",
        "push_allowed": true,
        "agents": null,
        "last_seen_type": null,
        "active_brand": "fd9d7877-3510-44ce-87f4-ada242793762",
        "display_name": "Unit Test",
        "abbreviated_display_name": "Unit",
        "online_state": "Offline",
        "has_password": true
      },
      "brand": {
        "id": "7f9ebf54-3545-42ad-9dc5-115ea8ac5afd",
        "created_at": 1765163562.965226,
        "updated_at": 1765163562.965226,
        "palette": null,
        "assets": null,
        "messages": null,
        "parent": null,
        "name": "LeadChannel",
        "deleted_at": null,
        "training": false,
        "brand_type": "Team",
        "parents": null,
        "type": "brand",
        "hostnames": null,
        "member_count": 1,
        "base_url": "https://irish.rechat.com"
      },
      "is_default": true,
      "conditions": null,
      "type": "lead_channel_rule"
    }
  ],
  "info": {
    "count": 2,
    "total": 0
  }
}

Reorder rules for a lead channel

Reorder rules for a lead channel
PUT/brands/:brand/leads/channels/:id/rules/sort

Example URI

PUT /brands/:brand/leads/channels/:id/rules/sort
URI Parameters
HideShow
brand
string (required) Example: 7f9ebf54-3545-42ad-9dc5-115ea8ac5afd
channel
string (required) Example: a85ad5ac-0deb-4866-b108-4a4561d1b4e2
Request
HideShow
Body
[
  {
    "id": "10048352-efc9-42e3-8432-543d1ce52fd8",
    "order": 1
  },
  {
    "id": "2a432b3c-2db9-4202-b8e6-bae1b8e8252a",
    "order": 2
  }
]
Response  200

Update a lead channel rule

Update a lead channel rule
PUT/brands/:brand/leads/channels/:id/rules/:rule

Example URI

PUT /brands/:brand/leads/channels/:id/rules/:rule
URI Parameters
HideShow
brand
string (required) Example: 7f9ebf54-3545-42ad-9dc5-115ea8ac5afd
channel
string (required) Example: a85ad5ac-0deb-4866-b108-4a4561d1b4e2
rule
string (required) Example: 2a432b3c-2db9-4202-b8e6-bae1b8e8252a
associations
string (required) Example: lead_channel_rule.conditions,lead_channel_rule.brand,lead_channel_rule.user
Request
HideShow
Body
{
  "target": "Brand",
  "kind": "OR",
  "order": 2,
  "flow": null,
  "user": null,
  "brand": "7f9ebf54-3545-42ad-9dc5-115ea8ac5afd",
  "conditions": [
    {
      "field": "postal_code",
      "operator": "any",
      "value": [
        "90210",
        "90211"
      ],
      "order": 1
    },
    {
      "field": "price",
      "operator": "lte",
      "value": 1000000,
      "order": 2
    }
  ]
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "2a432b3c-2db9-4202-b8e6-bae1b8e8252a",
    "created_at": 1765163562.878854,
    "updated_at": 1765163562.878854,
    "deleted_at": null,
    "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "channel": "a85ad5ac-0deb-4866-b108-4a4561d1b4e2",
    "kind": "OR",
    "order": 2,
    "target": "Brand",
    "user": null,
    "brand": {
      "id": "7f9ebf54-3545-42ad-9dc5-115ea8ac5afd",
      "created_at": 1765163562.965226,
      "updated_at": 1765163562.965226,
      "palette": null,
      "assets": null,
      "messages": null,
      "parent": null,
      "name": "LeadChannel",
      "deleted_at": null,
      "training": false,
      "brand_type": "Team",
      "parents": null,
      "type": "brand",
      "hostnames": null,
      "member_count": 1,
      "base_url": "https://irish.rechat.com"
    },
    "is_default": false,
    "conditions": [
      {
        "id": "7e548a27-09ce-46f2-8efd-34194aaf3111",
        "created_at": 1765163562.878854,
        "rule": "2a432b3c-2db9-4202-b8e6-bae1b8e8252a",
        "order": 1,
        "field": "postal_code",
        "operator": "any",
        "value": [
          "90210",
          "90211"
        ],
        "negated": false,
        "type": "lead_channel_rule_condition"
      },
      {
        "id": "a4a2f5e2-b7ee-48ee-a27f-77fc743fc1eb",
        "created_at": 1765163562.878854,
        "rule": "2a432b3c-2db9-4202-b8e6-bae1b8e8252a",
        "order": 2,
        "field": "price",
        "operator": "lte",
        "value": 1000000,
        "negated": false,
        "type": "lead_channel_rule_condition"
      }
    ],
    "type": "lead_channel_rule"
  }
}

Delete a lead channel rule

Delete a lead channel rule
DELETE/brands/:brand/leads/channels/:id/rules/:rule

Example URI

DELETE /brands/:brand/leads/channels/:id/rules/:rule
URI Parameters
HideShow
brand
string (required) Example: 7f9ebf54-3545-42ad-9dc5-115ea8ac5afd
channel
string (required) Example: a85ad5ac-0deb-4866-b108-4a4561d1b4e2
rule
string (required) Example: 2a432b3c-2db9-4202-b8e6-bae1b8e8252a
Response  204

Get Lead Routing Groups of brand

Get Lead Routing Groups of brand
GET/brands/:brand/leads/groups

Example URI

GET /brands/:brand/leads/groups
URI Parameters
HideShow
brand
string (required) Example: 7f9ebf54-3545-42ad-9dc5-115ea8ac5afd
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "3e530d03-a7aa-4664-bc4a-760d9accb816",
      "created_at": 1765163562.878854,
      "updated_at": 1765163562.878854,
      "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "brand": "7f9ebf54-3545-42ad-9dc5-115ea8ac5afd",
      "name": "Test Group",
      "description": null,
      "distribution": "RoundRobin",
      "type": "lead_routing_group"
    }
  ],
  "info": {
    "count": 1,
    "total": 0
  }
}

Create a Lead Routing Group

Create a Lead Routing Group
POST/brands/:brand/leads/groups

Example URI

POST /brands/:brand/leads/groups
URI Parameters
HideShow
brand
string (required) Example: 7f9ebf54-3545-42ad-9dc5-115ea8ac5afd
Request
HideShow
Body
{
  "name": "Test Group",
  "brand": "7f9ebf54-3545-42ad-9dc5-115ea8ac5afd",
  "distribution": "RoundRobin",
  "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
  "members": [
    {
      "user": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "order": 1,
      "brand": "7f9ebf54-3545-42ad-9dc5-115ea8ac5afd"
    }
  ]
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "3e530d03-a7aa-4664-bc4a-760d9accb816",
    "created_at": 1765163562.878854,
    "updated_at": 1765163562.878854,
    "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "brand": "7f9ebf54-3545-42ad-9dc5-115ea8ac5afd",
    "name": "Test Group",
    "description": null,
    "distribution": "RoundRobin",
    "type": "lead_routing_group"
  }
}

Update a Lead Routing Group

Update a Lead Routing Group
PATCH/brands/:brand/leads/groups/:group

Example URI

PATCH /brands/:brand/leads/groups/:group
URI Parameters
HideShow
brand
string (required) Example: 7f9ebf54-3545-42ad-9dc5-115ea8ac5afd
group
string (required) Example: 3e530d03-a7aa-4664-bc4a-760d9accb816
Request
HideShow
Body
{
  "name": "Test Group Updated",
  "distribution": "FirstToClaim",
  "members": [
    {
      "user": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "order": 2,
      "brand": "7f9ebf54-3545-42ad-9dc5-115ea8ac5afd"
    }
  ]
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "3e530d03-a7aa-4664-bc4a-760d9accb816",
    "created_at": 1765163562.878854,
    "updated_at": 1765163562.878854,
    "created_by": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
    "brand": "7f9ebf54-3545-42ad-9dc5-115ea8ac5afd",
    "name": "Test Group Updated",
    "description": null,
    "distribution": "FirstToClaim",
    "type": "lead_routing_group"
  }
}

Delete a Lead Routing Group

Delete a Lead Routing Group
DELETE/brands/:brand/leads/groups/:group

Example URI

DELETE /brands/:brand/leads/groups/:group
URI Parameters
HideShow
brand
string (required) Example: 7f9ebf54-3545-42ad-9dc5-115ea8ac5afd
group
string (required) Example: 3e530d03-a7aa-4664-bc4a-760d9accb816
Response  204

Lead Capture

Overview

Capture a lead using a known lead channel ID

Capture a lead using a known lead channel ID
POST/leads

Example URI

POST /leads
Request
HideShow
Body
{
  "metadata": {
    "lead_channel": "86397a27-a1bf-4e59-8dac-9ff4cef14056"
  },
  "lead": {
    "first_name": "Test",
    "last_name": "User",
    "email": "[email protected]",
    "source_type": "Website"
  }
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "59608559-6f46-42b5-a2c5-7331168794e6",
    "contact": "0cd18906-e38a-46f1-a5f1-836bc847ef9b",
    "lead_channel": "86397a27-a1bf-4e59-8dac-9ff4cef14056",
    "raw_payload": {
      "first_name": "Test",
      "last_name": "User",
      "email": "[email protected]",
      "source_type": "Website"
    },
    "parsed_payload": {
      "first_name": "Test",
      "last_name": "User",
      "email": "[email protected]",
      "source_type": "Website"
    },
    "source_type": "Website",
    "created_at": 1765163556.855
  }
}

Capture a lead using an email campaign email ID

Capture a lead using an email campaign email ID
POST/leads

Example URI

POST /leads
Request
HideShow
Body
{
  "metadata": {
    "email_campaign_email": "4e43144b-8262-46ca-bef2-73d72c9d5f71"
  },
  "lead": {
    "first_name": "Test",
    "last_name": "Recipient",
    "email": "[email protected]",
    "source_type": "Email Campaign"
  }
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": {
    "id": "dffe8761-078a-431a-a04a-bae6f1cd9b7f",
    "contact": "b14c1170-55ee-427a-b10c-1b578648f2c9",
    "lead_channel": "86397a27-a1bf-4e59-8dac-9ff4cef14056",
    "raw_payload": {
      "first_name": "Test",
      "last_name": "Recipient",
      "email": "[email protected]",
      "source_type": "Email Campaign"
    },
    "parsed_payload": {
      "first_name": "Test",
      "last_name": "Recipient",
      "email": "[email protected]",
      "source_type": "Email Campaign"
    },
    "source_type": "Email Campaign",
    "created_at": 1765163558.519
  }
}

Filter contacts by lead channel

Filter contacts by lead channel
POST/contacts/filter

Example URI

POST /contacts/filter
Request
HideShow
Body
{
  "lead_channels": [
    "23ba726c-1d38-41ff-98cf-7f4bdb2836cf"
  ]
}
Response  200
HideShow
Body
{
  "code": "OK",
  "data": [
    {
      "id": "7d830512-4d1d-42c8-be2d-6c7238ba6a71",
      "display_name": "Hossein Derakhshan",
      "partner_name": null,
      "brand": "7f9ebf54-3545-42ad-9dc5-115ea8ac5afd",
      "brand_id": "7f9ebf54-3545-42ad-9dc5-115ea8ac5afd",
      "user_id": "80a227b2-29a0-11e7-b636-e4a7a08e15d4",
      "sort_field": "Derakhshan Hossein",
      "last_touch": 1765163562.878854,
      "last_touch_action": null,
      "next_touch": null,
      "touch_freq": null,
      "ios_address_book_id": null,
      "android_address_book_id": null,
      "created_at": 1765163564.254037,
      "updated_at": 1765163562.878854,
      "deleted_at": null,
      "created_for": "lts_lead",
      "updated_for": "lts_lead",
      "deleted_for": null,
      "title": null,
      "first_name": "Hossein",
      "partner_first_name": null,
      "middle_name": null,
      "last_name": "Derakhshan",
      "partner_last_name": null,
      "marketing_name": null,
      "nickname": null,
      "email": "[email protected]",
      "primary_email": "[email protected]",
      "emails": [
        "[email protected]"
      ],
      "parked": false,
      "partner_email": null,
      "phone_number": "+905348632070",
      "primary_phone_number": "+905348632070",
      "phone_numbers": [
        "+905348632070"
      ],
      "company": null,
      "birthday": null,
      "profile_image_url": null,
      "cover_image_url": null,
      "job_title": null,
      "source_type": "Showing",
      "source": "Website",
      "website": null,
      "tags": [
        "Showing",
        "Lead"
      ],
      "address": [
        {
          "city": "Atlanta",
          "full": ", Atlanta GA",
          "type": "stdaddr",
          "line2": "Atlanta GA",
          "state": "GA"
        }
      ],
      "type": "contact"
    }
  ],
  "info": {
    "count": 1,
    "total": 1
  }
}

Generated by aglio on 08 Dec 2025