Resource
Customers
People who rent from you. Look up by email, sync new bookings from external tools, or update contact info.
The customer object
idstring (uuid) | Unique identifier. |
objectstring | Always `"customer"`. |
full_namestring | Customer's full name. |
emailstring | Email address. |
phonestring | Phone (E.164). |
preferred_languagestring | BCP 47 tag (`en`, `zh`). |
source_channelstring | Acquisition channel. |
is_returningboolean | Has rented before. |
total_rentalsinteger | Lifetime rental count. |
overall_scorenumber | Renvo trust score (0–100). |
created_atstring (iso8601) | Creation time. |
Webhook events
Subscribe to receive notifications when customer resources change:
customer.createdcustomer.updatedEndpoints
GET
/v1/customersscope: readList customers
Query parameters
emailstring | Exact-match filter. |
limitinteger | Default 20. Max 100. |
starting_afterstring | Cursor. |
Request
curl -X GET 'https://userenvo.com/api/v1/customers' \
-H 'Authorization: Bearer rv_live_…'Response
{
"object": "list",
"has_more": false,
"next_cursor": null,
"data": [
{
"object": "customer",
"id": "cu_…",
"full_name": "Jane Doe",
"email": "jane@example.com"
}
]
}GET
/v1/customers/{id}scope: readRetrieve a customer
Path parameters
idrequiredstring | Customer id. |
Request
curl -X GET 'https://userenvo.com/api/v1/customers/a4d2e1c0-9b…' \
-H 'Authorization: Bearer rv_live_…'Response
{
"object": "customer",
"id": "cu_…",
"full_name": "Jane Doe"
}POST
/v1/customersscope: read_writeCreate a customer
Body parameters
full_namerequiredstring | Customer name. |
emailstring | Email address. |
phonestring | E.164 phone. |
preferred_languagestring | BCP 47 (default `en`). |
source_channelstring | Acquisition channel. |
Request
curl -X POST 'https://userenvo.com/api/v1/customers' \
-H 'Authorization: Bearer rv_live_…' \
-H 'Content-Type: application/json' \
-d '{
"full_name": "<full_name>",
"email": "<email>",
"phone": "<phone>"
}'Response
{
"object": "customer",
"id": "cu_…",
"full_name": "Jane Doe"
}PATCH
/v1/customers/{id}scope: read_writeUpdate a customer
Path parameters
idrequiredstring | Customer id. |
Body parameters
emailstring | New email. |
phonestring | New phone. |
notesstring | Internal notes. |
Request
curl -X PATCH 'https://userenvo.com/api/v1/customers/a4d2e1c0-9b…' \
-H 'Authorization: Bearer rv_live_…' \
-H 'Content-Type: application/json' \
-d '{
"email": "<email>",
"phone": "<phone>",
"notes": "<notes>"
}'Response
{
"object": "customer",
"id": "cu_…",
"email": "new@example.com"
}