Customer

Customer Properties

Field	Description
created_at	When a Customer was created on the Malomo Platform.
email	Customer's email address.
first_name	Customer's first name.
id	Unique identifier for a Customer.
last_name	Customer's last name.
phone_number	Customer's phone number.
updated_at	When a Customer was last updated.

Create a Customer

POST https://api.gomalomo.com/customers

Request Body

Name	Type	Description
email	string	Customer's email address
first_name	string	Customer's first name
last_name	string	Customer's last name
phone_number	string	Customer's phone number

200

{
  "created_at": "2019-01-30T13:30:00Z",
  "email": "[email protected]",
  "first_name": "Johnny",
  "id": "a0a877c6-4164-4e8a-8179-48f8d4752b4e",
  "last_name": "Rose",
  "phone_number": "555-555-5555",
  "updated_at": "2019-01-30T13:30:00Z"
}

Retrieve a Customer

GET https://api.gomalomo.com/customers/:id

Path Parameters

Name	Type	Description
id	string	Unique identifier of the desired customer

200

{
  "created_at": "2019-01-30T13:30:00Z",
  "email": "[email protected]",
  "first_name": "Johnny",
  "id": "a0a877c6-4164-4e8a-8179-48f8d4752b4e",
  "last_name": "Rose",
  "phone_number": "555-555-5555",
  "updated_at": "2019-01-30T13:30:00Z"
}

Retrieve a List of Customers

GET https://api.gomalomo.com/customers

Query Parameters

Name	Type	Description
prev	string	Retrieve customers after a given cursor.
next	string	Retrieve customers before a given cursor.

200

[
  {
    "created_at": "2019-01-30T13:30:00Z",
    "email": "[email protected]",
    "first_name": "Johnny",
    "id": "a0a877c6-4164-4e8a-8179-48f8d4752b4e"
    "last_name": "Rose",
    "phone_number": "555-555-5555",
    "updated_at": "2019-01-30T13:30:00Z"
  }
]

Update a Customer

PUT https://api.gomalomo.com/customers/:id

Path Parameters

Name	Type	Description
id	string	Unique identifier of the customer to update

Request Body

Name	Type	Description
email	string	Customer's email address
first_name	string	Customer's first name
last_name	string	Customer's last name
phone_number	string	Customer's phone number

200

{
  "created_at": "2019-01-30T13:30:00Z",
  "email": "[email protected]",
  "first_name": "Johnny",
  "id": "a0a877c6-4164-4e8a-8179-48f8d4752b4e",
  "last_name": "Rose",
  "phone_number": "555-555-5555",
  "updated_at": "2019-01-30T13:30:00Z"
}

Delete a Customer

DELETE https://api.gomalomo.com/customers/:id

Path Parameters

Name	Type	Description
id	string	Unique identifier of the customer to delete

204

Retrieve a List of Customer Events

GET https://api.gomalomo.com/customers/:customer_id/events

Path Parameters

Name	Type	Description
customer_id	string	Unique id of the Customer to retrieve events for.

Query Parameters

Name	Type	Description
prev	string	Retrieve events before a given cursor.
next	string	Retrieve events after a given cursor.

200

[
  {
    "created_at": "2019-01-30T13:30:00Z",
    "id": "1a3c1090-efd1-11eb-9a03-0242ac130003",
    "label": "Order #1000 fulfilled",
    "link_back_url": "https://goodest-boi.myshopify.com/admin/orders/5555555555555",
    "properties": {
      "shopify_order": {
        "id": "5555555555555"
      }
    },
    "timestamp": 1548855000
    "type": "ShopifyOrderFulfilled",
    "updated_at": "2019-01-30T13:30:00Z",
  }
]