Lauded Docs

# Customers

Customers ported from your application.

# Create A Customer

POST https://api.lauded.io/api/client/customers

curl https://api.lauded.io/api/client/customers \
 -H "Authorization: Bearer eyJ0eXA3asdk..." \
-d title="mr" \
-d first_name="Rylee" \
-d last_name="Wilkinson" \
-d email="dibbert.gillian@example.org" \
-d phone_number="+5836233758078" \
-d custom_data=[{"payments_finished": false}]

# Parameters

title string|in:['mr', 'mrs', 'miss', 'dr']

The title of the customer.

first_name required|string

The first name of the customer.

last_name required|string

The last name of the customer.

email required|string

The email of the customer.

phone_number string

The phone number of the customer.

external_id string|optional|unique

The external id of the customer.

custom_data optional|array

An optional custom data to be saved with the customer.

# Returns

A json with data property that contains array of customer objects. 

{
    "id": 1,
    "first_name": "Rylee",
    "last_name": "Wilkinson",
    "email": "dibbert.gillian@example.org",
    "phone_number": "+5836233758078",
    "custom_data": {"payments_finished": false},
    "external_id": "2WiUFW1EgH"
}

# Update A Customer

PUT https://api.lauded.io/api/client/customers

curl https://api.lauded.io/api/client/customers \
 -H "Authorization: Bearer eyJ0eXA3asdk..." \
-d title="mr" \
-d first_name="Rylee" \
-d last_name="Wilkinson" \
-d email="dibbert.gillian@example.org" \
-d phone_number="+5836233758078" \
-d custom_data=[{"payments_finished": false}]

# Parameters

title string|in:['mr', 'mrs', 'miss', 'dr']

The title of the customer.

first_name required|string

The first name of the customer.

last_name required|string

The last name of the customer.

email required|string

The email of the customer.

phone_number string

The phone number of the customer.

# Returns

A json with data property that contains array of customer objects. 

{
    "id": 1,
    "first_name": "Rylee",
    "last_name": "Wilkinson",
    "email": "dibbert.gillian@example.org",
    "phone_number": "+5836233758078",
    "custom_data": {"payments_finished": false},
    "external_id": "2WiUFW1EgH"
}

# Delete A Customer

DELETE https://api.lauded.io/api/client/customers/{external_id}

curl https://api.lauded.io/api/client/customers/{external_id} \
 -H "Authorization: Bearer eyJ0eXA3asdk..."

# Parameters

external_id required|string

The external id of the customer

# Returns

{
    "success": "boolean"
}

← Reviews →