<- Loyalty API

Loyalty API

Create loyalty account

POST

 /v2/loyalty/accounts

Creates a loyalty account.

To create a loyalty account, you must provide the program_id and a mapping with the phone_number of the buyer.

Permissions:LOYALTY_WRITE

Guide

Create loyalty account

Try in API Explorer
Link to section

Request body

Example code

Link to section

loyalty_account

Required

The loyalty account to create.

Show attributes
Link to section

idempotency_key

string

Required

A unique string that identifies this CreateLoyaltyAccount request. Keys can be any valid string, but must be unique for every request.

Min Length
1
Max Length
128
Link to section

Response fields

Link to section

errors

Any errors that occurred during the request.

Show attributes
Link to section

loyalty_account

The newly created loyalty account.

Show attributes

Error descriptions