POST Check Phone Number

Checks if a phone number for a customer for a specific brand already exists

Headers
  • X-Request-ID
    Type: string
    required

    Unique request identifier

  • Application
    Type: string
    required

    Application key

  • Accept
    Type: string
    required

    Accept header

  • API-version
    Type: string
    required

    Api version

  • Authorization
    Type: string
    required

    Authorization header

  • X-QB-Enabled
    enum
    required

    Header which if sent with value 'true' will allow usage of the query building feature in response (through the request's query params). It is mandatory for this part of the documentation.

    values
    • true
    • false
Body
application/json
  • phone_number
    Type: string
Responses
  • application/json
Request Example for post/customers/check-phone-number
curl https://api-public-demo.menu.app/api/customers/check-phone-number \
  --request POST \
  --header 'X-Request-ID: c10b4a70-6274-490d-80a0-03e7bb826937' \
  --header 'Application: ' \
  --header 'Accept: application/json' \
  --header 'API-version: 5.0.0' \
  --header 'Authorization: ' \
  --header 'X-QB-Enabled: true' \
  --header 'Content-Type: application/json' \
  --data '{
  "type_id": 3,
  "discount_id": 10005906790,
  "venue_id": "b8c2d108-3f22-11ed-936c-1a67b454859d"
}'
{
  "status": "OK",
  "code": 200,
  "data": {
    "redemption_code": "6073964"
  }
}