Customers

Project customer records, nested outreach history, and lifecycle changes for integrations that sync people or dashboards.

List Customers

get

Retrieve project customers with optional search, tag, sort, facet filters, and calendar bounds on a chosen datetime column.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
date_fromstring · date · nullableOptional

Inclusive lower calendar date (YYYY-MM-DD) for the column chosen by date_key, defaulting to created_at when date_key is omitted.

date_keystring · enum · nullableOptional

Customer datetime column paired with date_from and date_to (defaults to created_at when omitted).

Possible values:
date_tostring · date · nullableOptional

Inclusive upper calendar date (YYYY-MM-DD) for the column chosen by date_key; must be on or after date_from when both bounds are provided.

emailstring · nullableOptional

Email address for the person or customer.

filterstring · enum · nullableOptional

Customer list facet aligned with console filters (excluding archived unless requested).

Possible values:
limitinteger · nullableOptional

Maximum number of records to return.

qstring · nullableOptional

Search query used to filter results.

sort_dirstring · enum · nullableOptional

Sort direction: asc or desc.

Possible values:
sort_keystring · enum · nullableOptional

Customer field to sort by.

Possible values:
tag_slugstring · nullableOptional

URL-friendly identifier for the customer tag.

Responses
chevron-right
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

get
/customers
200

Success

Create Customer

post

Create a customer record with contact, location, and tag details.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

Object containing response data for this resource.

first_namestringRequired

Customer first name.

last_namestringOptional

Customer last name.

emailstringOptional

Email address for the person or customer.

phonestringOptional

Phone number for the person or customer.

companystringOptional

Company or organization name associated with the customer.

has_subscriptionbooleanOptional

Whether the customer has an active subscription flag.

location_slugstringOptional

Slug of the location associated with the record.

signed_up_atstringOptional

Unix timestamp when the customer signed up.

notesstringOptional

Internal notes about the customer.

address1stringOptional

Primary street address line.

address2stringOptional

Secondary street address line, such as suite or apartment.

citystringOptional

City for the address.

statestringOptional

State, province, or region for the address.

postal_codestringOptional

Postal or ZIP code for the address.

tag_slugsstring[]Optional

Tag slugs to attach to the customer.

Responses
chevron-right
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

post
/customers
200

Success

Get Customer

get

Retrieve one customer belonging to the authenticated project with nested location and tags where present.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired

Unique numeric identifier for the customer.

Responses
chevron-right
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Application-level status code returned by More Good Reviews.

dataobjectOptional

Customer record with optional nested entities.

get
/customers/{id}
200

Success

Delete Customer

delete

Delete a customer from the authenticated project.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired

Unique numeric identifier for the customer.

Responses
chevron-right
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Application-level status code returned by More Good Reviews.

delete
/customers/{id}
200

Success

Archive Customer

put

Archive a customer and cancel any unsent outreach messages.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired

Unique numeric identifier for the customer.

Responses
chevron-right
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Application-level status code returned by More Good Reviews.

put
/customers/{id}/archive
200

Success

Unarchive Customer

put

Restore an archived customer so asks and integrations treat them as active again.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired

Unique numeric identifier for the customer.

Responses
chevron-right
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Application-level status code returned by More Good Reviews.

put
/customers/{id}/unarchive
200

Success

Update Customer Notes

put

Replace the internal notes stored on a customer.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired

Unique numeric identifier for the customer.

Body

Request body containing customer notes.

notesstring · max: 5000 · nullableOptional

Internal notes about the customer.

Responses
chevron-right
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Application-level status code returned by More Good Reviews.

put
/customers/{id}/notes
200

Success

Unsubscribe Customer

put

Unsubscribe a customer from future outreach and cancel unsent messages.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired

Unique numeric identifier for the customer.

Responses
chevron-right
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Application-level status code returned by More Good Reviews.

put
/customers/{id}/unsubscribe
200

Success

Resubscribe Customer

put

Clear message opt-out state so outreach can resume for this customer again.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired

Unique numeric identifier for the customer.

Responses
chevron-right
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Application-level status code returned by More Good Reviews.

put
/customers/{id}/resubscribe
200

Success

Cancel Customer Unsent Messages

put

Clear scheduled outreach for this customer without archiving or changing subscription state.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired

Unique numeric identifier for the customer.

Responses
chevron-right
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Application-level status code returned by More Good Reviews.

put
/customers/{id}/cancel-unsent-messages
200

Success

List Customer Charges

get

Paginated revenue-charge history for one customer after ingest from billing systems.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired

Unique numeric identifier for the customer.

Query parameters
limitinteger · nullableOptional

Maximum number of records to return per page.

Responses
chevron-right
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

get
/customers/{id}/charges
200

Success

List Customer Messages

get

Retrieve message history for one customer in the project.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired

Unique numeric identifier for this resource.

Query parameters
limitinteger · nullableOptional

Maximum number of records to return.

Responses
chevron-right
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

get
/customers/{id}/messages
200

Success

List Customer Reviews

get

Retrieve review history for one customer in the project.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired

Unique numeric identifier for this resource.

Query parameters
limitinteger · nullableOptional

Maximum number of records to return.

Responses
chevron-right
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Short code or application-level status code for this resource.

get
/customers/{id}/reviews
200

Success

Update Customer Tags

put

Replace the tag assignments for a customer using the provided slug list.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
idintegerRequired

Unique numeric identifier for the customer.

Body

Request body listing tag slugs to apply; omitting unrelated tags removes them from the customer.

tag_slugsstring[]Required

Tag slugs to assign; send an empty array to clear all tags from this customer.

Responses
chevron-right
200

Success

application/json

Object containing response data for this resource.

successbooleanOptional

Indicates whether the request completed successfully.

codeintegerOptional

Application-level status code returned by More Good Reviews.

put
/customers/{id}/tags
200

Success

Last updated