Create Loyalty Customer

post

https://yourwebhook.com/loyalty/customer

Purpose

Deliverect will call this endpoint to create a customer in the loyalty provider's platform.

Payload

Customer Attributes	Type	Required	Description
`firstName`	string	No	First name of the customer.
`lastName`	string	No	Last name of the customer.
`email`	string	Yes if used as unique identifier	The customer's email.
`phoneNumber`	string	Yes if used as unique identifier	The customer's phone email. Must be sent in E.164 international standard.
`dateOfBirth`	string	No	The provided date must be in ISO 8601 format. Example: 2025-05-22T22:55:59+12:00.
`accountId`	string	Yes	The merchant's account ID in Deliverect
`loyaltyProfileId`	string	Yes	The Id of the profile where the response configuration was stored
`locationId`	string	No	The location ID related to the merchant's account in Deliverect
`channelLinkId`	string	No	The channel link ID related to the location of the merchant's account in Deliverect

Response

⚠️

If the customer already exists on your platform, the endpoint should return a 409 status code.

Customer Attributes	Type	Required	Description
`firstName`	string	No	First name of the customer.
`lastName`	string	No	Last name of the customer.
`email`	string	Yes if used as unique identifier	The customer's email.
`phoneNumber`	string	Yes if used as unique identifier	The customer's phone email. Must be sent in E.164 international standard.
`dateOfBirth`	string	No	The provided date must be in ISO 8601 UTC format. Example: 2025-05-22T22:55:59+00:00.
`acceptedTCAt`	string	No	The date and time when the customer accepted the terms and conditions. Must be in ISO 8601 UTC format. Example: 2025-05-22T22:55:59+00:00.
`balance`	integer	No	The point balance of the customer.
`tier`	Object	No	See tier object description bellow.

Tier Attributes	Type	Required	Description
`name`	string	Yes	The name of the Tier
`description`	string	No	A description for the Tier
`media`	Object	No	See media object description bellow.

Media attributes	Type	Required	Description
`url`	string	Yes	A video or image URL that can be displayed along the tier information.
`type`	string	Yes	Valid options: `image` `video`

Body Params

string

required

email of the end customer

phoneNumber

string

phone number of the end customer in E164 format.

firstName

string

first name of the end customer

lastName

string

last name of the end customer

dateOfBirth

date

date of birth of the end customer in ISO format

accountId

string

The deliverect customer account id

loyaltyProfileId

string

The Id of the profile where the response configuration was stored

locationId

string

The location ID related to the merchant's account in Deliverect

channelLinkId

string

The channel link ID related to the location of the merchant's account in Deliverect

Headers

User-Agent

string

Defaults to Deliverect/{version}

X-Server-Authorization-HMAC-SHA256

string

Defaults to {signature}

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Purpose

Payload

Response

201201

409409