API Documentation

Add new lead

Method:
POST

‍Endpoint:
https://xjjl-fsea-0smf.f2.xano.io/api:-rEW9niB/lead

Header:
X-Api-Key = [your api key]

Schema:

{
  "email": "string",
  "first_name": "string",
  "last_name": "string",
  "phone": "string",
  "company_name": "string",
  "source": "string",
  "employee": "string",
  "channel_id": 0
  "properties": [
      {
         "value": "string",
         "property_definition_id": 0 
       }
  ]
}

• 200
  Success!
  ‍
  Schema:
  ‍
  

  {
    "id": 0,
    "created_at": "now",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "phone": "string",
    "company_name": "string",
    "source": "string",
    "employee": "string",
    "status": "New",
    "channels_id": 0,
    "properties": [
          {
              "value": "string",
              "property_definitions_id": 0,
              "_property_name": {
                  "name": "string"
              }
          }
      ]
  }

• 400
  Input Error. Check the request payload for issues.
  
• 401
  Unauthorized
  
• 403
  Access denied. Additional privileges are needed access the requested resource.
  
• 404
  Not Found. The requested resource does not exist.
  
• 429
  Rate Limited. Too many requests.
  
• 500
  Unexpected error
  

Get leads from channel

Method:
GET

‍Endpoint:
https://xjjl-fsea-0smf.f2.xano.io/api:-rEW9niB/leads
‍
Header:
X-Api-Key = [your api key]

Schema:

{
  "channel_id": 0
}

• 200
  Success!
  ‍
  Schema:
  ‍
  

  {
    "lead": [
      {
        "id": 0,
        "created_at": "now",
        "email": "string",
        "first_name": "string",
        "last_name": "string",
        "phone": "string",
        "company_name": "string",
        "source": "string",
        "employee": "string",
        "status": "New",
        "notes": "string",
        "channels_id": 0,
        "_properties": [
             {
                "value": "string",
                "property_definitions_id": 0,
                "_property_name": {
                    "name": "string"
                }
            }
         ]
      }
    ]
  }

• 400
  Input Error. Check the request payload for issues.
  
• 401
  Unauthorized
  
• 403
  Access denied. Additional privileges are needed access the requested resource.
  
• 404
  Not Found. The requested resource does not exist.
  
• 429
  Rate Limited. Too many requests.
  
• 500
  Unexpected error
  

Update lead status

Method:
POST

‍Endpoint:
https://xjjl-fsea-0smf.f2.xano.io/api:-rEW9niB/update_status
‍
Header:
X-Api-Key = [your api key]

Schema:

{
  "lead_id": 0,
  "status": "string"
}

• 200
  Success!
  ‍
  Schema:
  ‍
  

  {
    "id": 0,
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "phone": "string",
    "company_name": "string",
    "status": "string"
  }

• 400
  Input Error. Check the request payload for issues.
  
• 401
  Unauthorized
  
• 403
  Access denied. Additional privileges are needed access the requested resource.
  
• 404
  Not Found. The requested resource does not exist.
  
• 429
  Rate Limited. Too many requests.
  
• 500
  Unexpected error