Model

Lead lead {
    "_id": {
        "autogenerated": "true"
    },
    "seq": { 
        "type": "Number",
        "default": 0
    },
    "organization_name": {
        "type": "string"
    },
    "firstname": {
        "type": "string",
        "required": "true"
    },
    "lastname": {
        "type": "string",
        "required": "true"
    },
    "email": {
        "type": "string",
        "required": "true",
        "trim": "true",
        "lowercase": "true"
    },
    "phone_number": {
        "type": "string",
        "required": "true",
        "trim": "true"
    },
    "address": {
        "type": "string",
        "required": "true"
    },
    "city": {
        "type": "string",
        "required": "true",
        "trim": "true"
    },
    "state": {
        "type": "string",
        "trim": "true"
    },
    "country": {
        "type": "string",
        "required": "true",
        "trim": "true"   
    },
    "zip_code": {
        "type": "string",
        "required": "true",
        "trim": "true"
    },
    "tax_identification_number": {
        "type": "string"
    },
    "vat_id": {
        "type": "string"
    },
    "notes": {
        "type": "string"
    },
    "products": [{
        "type": "string"
    }],
    "products_obj": [{
        "product_id": {
            "ref": "Product._ObjectId"
        },
        "name": {
            "type": "string"
        },
        "options": {
            "type": "string"
        },
        "price": {
            "type": "number"
        },
        "quantity": {
            "type": "number"
        }
    }],
    "lifetime_value": {
        "type": "number",
        "default": 0
    },
    "last_order_value": {
        "type": "number"
    },
    "services": [{
        "ref": "Service._ObjectId"
    }],
    "stripe_id": {
        "type": "string"
    },
    "createdAt": {
        "autogenerated": "true"
    },
    "updatedAt": {
        "autogenerated": "true"
    }
}

Methods

Create new

POST /leads?ionic=true req.body required

method: 'POST'
{
    url: 'https://{{your-builderly-domain}}/leads?ionic=true',
    headers,
    json: true,
    body: lead
}

Responses Success - status 201

{ order.id }

Error - status 400

{
    error_message
}

Retrieve multiple

GET /leads

method: 'GET'
{
    url: 'https://{{your-builderly-domain}}/leads',
    headers: {
        'Authorization': 'Bearer ' + token
    },
    json: true,
    body: {}
}

Responses Success - status 200

[leads]

Error - status 500

{
    error_message
}

• Example usages: /leads - Get all leads

Retrieve single

GET /leads/:id

method: 'GET'
{
    url: 'https://{{your-builderly-domain}}/leads/{{lead._id}}',
    headers: {},
    json: true,
    body: {}
}

Responses Success - status 200

{ lead }

Not found - status 404

{}

Error - status 500

{
    error_message
}

• Example usages: /leads/:id - Retrives a specific lead

Update single

PATCH /leads/:id?

method: 'PATCH'
{
    url: 'https://{{your-builderly-domain}}/leads/{{lead._id}}',
    headers: {
        'Authorization': 'Bearer ' + token
    },
    json: true,
    body: lead
}

Responses Success - status 200

{ lead }

Error - status 400

{
    error_message
}

Not found - status 404

{}

Delete single

DELETE /leads/:id

method: 'DELETE'
{
    url: 'https://{{your-builderly-domain}}/leads/{{lead._id}}',
    headers: {
        'Authorization': 'Bearer ' + token
    },
    json: true,
    body: {}
}

Responses Success - status 200

{ lead }

Not found - status 404

{}

Error - status 500

{
    error_message
}