Storm LogoStorm Docs
Getting Started
Guides
Dialer
Messenger
REST API
Customers
Get CustomerList CustomersCreate CustomerUpdate Customer

Customers

All endpoints require basic authentication. Username is your vendor ID. Password is your API key.

Get Customer

Get a customer.

Request URL

GET
https://app.stormapp.com/api/customers/:id

Example Response

{
"id": "71948",
"stormId": "opi5izrkg9q4eqd793ngkd87ba5tbnqm",
"email": "george@vandelayindustries.com",
"firstName": "George",
"lastName": "Costanza",
"phone": "8444545111",
"address1": "2880 Broadway",
"city": "New York",
"state": "NY",
"zip": "10025",
"subscriptions": {
"multi": false
}
}

List Customers

List all customers.

Request URL

GET
https://app.stormapp.com/api/customers

Example Response

[
{
"id": "71948",
"stormId": "opi5izrkg9q4eqd793ngkd87ba5tbnqm",
"email": "george@vandelayindustries.com",
"firstName": "George",
"lastName": "Costanza",
"phone": "8444545111",
"address1": "2880 Broadway",
"city": "New York",
"state": "NY",
"zip": "10025",
"subscriptions": {
"single": false
}
}
]

Create Customer

Create a new customer.

Request URL

POST
https://app.stormapp.com/api/customers

Request Body

{
"id": "71948",
"email": "george@vandelayindustries.com",
"firstName": "George",
"lastName": "Costanza",
"phone": "8444545111",
"address1": "2880 Broadway",
"city": "New York",
"state": "NY",
"zip": "10025",
"subscriptions": {
"multi": true,
"sms": true
},
"test": false
}

Request Attributes

NameTypeRequiredDescription
idstringyesUnique ID (can be anything)
emailstringyesEmail address
firstNamestringyesFirst name
lastNamestringyesLast name
phonestringnoPhone number
address1stringnoAddress
citystringnoCity
statestringnoState
zipstringnoZip
subscriptionsobjectyesSubscriptions object
testboolnoInternal/testing account

Example Response

{
"success": true,
"stormId": "opi5izrkg9q4eqd793ngkd87ba5tbnqm"
}

Update Customer

Update an existing customer.

Request URL

POST
https://app.stormapp.com/api/customers/:id

Request Body

{
"subscriptions": {
"single": true,
"multi": false
}
}

Request Attributes

See Create Customer. All values can be updated except test.

Example Response

{
"success": true
}