Skip to main content
PUT
/
api
/
v1
/
customer-groups
/
{customerGroupId}
/
add-customer
cURL
curl --request PUT \
  --url https://api-staging.getmeadow.com/api/v1/customer-groups/{customerGroupId}/add-customer \
  --header 'Content-Type: application/json' \
  --header 'X-Client-Key: <api-key>' \
  --header 'X-Consumer-Key: <api-key>' \
  --data '
{
  "emailOrPhone": "<string>"
}
'
{
  "id": 123,
  "hashId": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "joinedAt": "<string>",
  "updatedAt": "<string>",
  "birthday": "<string>",
  "sex": "<string>",
  "zip": "<string>",
  "licenseExpiry": "<string>",
  "marketingOptIn": true,
  "marketingOptInAt": "<string>",
  "customerGroups": [
    "<string>"
  ],
  "loyalty": {
    "pointsAmount": 123
  },
  "mostRecentAddress": {
    "street1": "<string>",
    "street2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>"
  },
  "medicalExpiration": "<string>"
}

Authorizations

​
X-Consumer-Key
string
header
required

The key assigned to your company and provided via Meadow

​
X-Client-Key
string
header
required

The key generated and provided by our mutual client

Path Parameters

​
customerGroupId
integer<int64>
required

ID of the customer group to add this customer to

Body

application/json
​
emailOrPhone
string
required

Either an email address or a phone number of the customer to add to the group

Response

Add customer to group response

​
id
number

The id for the customer

​
hashId
string

An ID used to display to the customer and dispensary instead of the id number

​
firstName
string

The first name of the customer

​
lastName
string

The last name of the customer

​
email
string | null

The email of the customer

​
phone
string | null

The phone of the customer

​
joinedAt
string

The date the customer joined the dispensary

​
updatedAt
string

The date this customer was last updated

​
birthday
string | null

The birthday of the customer in YYYY-MM-DD

​
sex
string | null

One of male, female, tertiary

​
zip
string | null

The postal code of the customer

​
licenseExpiry
string | null

The expiration date of this customer’s drivers license or null if it is not recorded.

​
marketingOptIn
boolean

Whether this customer is opted in to receive marketing

​
marketingOptInAt
string | null

When this customer opted in to marketing or null

​
customerGroups
string[]

An array of Strings for the names of the customer groups this customer is a part of (Example: Veterans, Seniors, etc.)

​
loyalty
object

Information about the loyalty of the customer

​
mostRecentAddress
object

The most recent address used for a delivery order or null if one does not exist

​
medicalExpiration
string | null

The expiration date of this customer’s medical recommendation or null if they are an adult use customer