Sign in

v1

latestOpenAPI 3.0.12026-07-242871595.3 MB
CUSTOMERS

Create a customer

Creates customer record for a merchant. Note that the request body cannot be null.

post/v3/merchants/{mId}/customers

Path parameters

mIdstring required

Merchant identifier.

Query parameters

expandstring

Expandable fields to display additional nested information: [addresses, emailAddresses, phoneNumbers, cards, metadata]

Headers

User-Agentstring required

Identifies the application, operating system, vendor, and/or version of the requesting user agent. Format: <AppName>/<Version> <Comment>

Request body

idstring

Unique identifier.

firstNamestring

First name of the customer. Length: Maximum 64 characters

lastNamestring

Last name of the customer. Length: Maximum 64 characters

marketingAllowedboolean

Indicates whether the customer allows marketing communication from Clover. Note: This function is only allowed for Clover internal apps, and third-party apps should receive marketing opt-in from customers per their local laws and store consent in their own systems.

customerSinceinteger

Date since when the customer is associated with the merchant.

Response

Successful response. Customer record is created.

idstring

Unique identifier of the customer.

firstNamestring

First/given name of the customer. Length: Maximum 64 characters

lastNamestring

Last name/surname of the customer. Length: Maximum 64 characters

marketingAllowedboolean

Indicates whether the customer allows marketing communication from Clover. Note: This function is only allowed for Clover internal apps, and third-party apps should receive marketing opt-in from customers per their local laws and store consent in their own systems.

customerSinceinteger

Date of start of customer association with the merchant.