Create Business Migration User

dashboard_create_business_migration_user

Create Business Migration User

Creates a business migration user in the system

Headers

Authorization
Type: string
required

Bearer token for admin authorization, who is making a call on behalf of the customer. Send the API key in the following format: "Authorization: Bearer BUSINESS_ADMIN_KEY_GOES_HERE".
Accept
Type: string
required

Advertises which content types the client is able to understand
Content-Type
Type: string
required

Set this header to application/json.

Body

application/json

address_line1
Type: string

Address of the user
birthday
Type: stringFormat: date

Date of birth of the user, in YYYY-MM-DD format
challenge_progress
Type: array object[]
city
Type: string

City where the user lives
email
Type: string

Email address of the user that will be added to the migration data. Migration can be based on this value as well.
fb_uid
Type: string

Facebook ID that identifies the user
first_name
Type: string

First name of the user
gift_cards
Type: array object[]
initial_points
Type: integerFormat: int32

Number of points that will be added to the migrated points from the incumbent loyalty program
last_name
Type: string

Last name of the user
loyalty_cards
Type: array Loyalty Cards (Array Object)[]

Details of the loyalty cards migrated for the user
marketing_email_subscription
Type: boolean

Whether the user has subscribed to receive marketing emails or not

Responses

200
Type: object
address_line1
Type: string

Address of the user

birthday
Type: stringFormat: date

Date of birth of the user, in YYYY-MM-DD format

challenge_progress
Type: array object[]
city
Type: string

City where the user lives

email
Type: string

Email address of the user that will be added to the migration data. Migration can be based on this value as well.

fb_uid
Type: string

Facebook ID that identifies the user

first_name
Type: string

First name of the user

gift_cards
Type: array object[]
gifted_value
Type: integer

Value of points gifted to the user at the time of migration. This is the product of original_points and rate_of_conversion. This does not include the initial points.

initial_points
Type: integer

Number of points that will be added to the migrated points from the incumbent loyalty program

last_name
Type: string

Last name of the user

loyalty_cards
Type: array Loyalty Cards (Array Object)[]

Details of the loyalty cards migrated for the user

marketing_email_subscription
Type: boolean

Whether the user has subscribed to receive marketing emails or not

marketing_pn_subscription
Type: boolean

Whether the user has subscribed to marketing push notifications or not

migrated_redeemables
Type: array object[]
migrated_rewards
Type: integer

Currency value of rewards that will be migrated from the incumbent loyalty program

migrated_rewards_expiration_date
Type: stringFormat: date

Expiration date of the currency value of rewards that will be migrated from the incumbent loyalty program. Note: This expiration date will be applicable only on the currency value passed in the migrated_rewards parameter.

migration_user_id
Type: integer

Unique ID assigned to the user by Punchh at the time of migration

name
Type: string

Name of the loyalty program of the business

original_membership_no
Type: integer

Membership number of the user as per the incumbent loyalty program. Migration can be based on this value as well.

original_phone
Type: integer

Phone number of the user. This value may contain special characters (e.g., hyphen, etc.).

original_points
Type: numberFormat: float

Number of points that will be migrated from the incumbent loyalty program

phone
Type: integer

Phone number of the user. This is used as the unique identifier for migration of the user. This should be a 10-digit value without special characters (e.g., hyphen, etc.).

preferred_location
Type: integer

Favorite location ID of the user

registration_date
Type: string

Registration date of the loyalty program, in ISO 8601 YYYY-MM-DDTHH:mm:SSZ format

state
Type: string

State where the user lives

street_address
Type: string

Address of the user

user_relations
Type: array object[]
zip_code
Type: string

Zip code where the user lives
401
Type: object
error
Type: string

post/api2/dashboard/migration_users

Show Schema

{
  "address_line1": "string",
  "birthday": "2025-12-19",
  "city": "string",
  "email": "string",
  "first_name": "string",
  "gifted_value": 1,
  "initial_points": 1,
  "last_name": "string",
  "marketing_email_subscription": true,
  "marketing_pn_subscription": true,
  "migrated_redeemables": [
    {
      "redeemable_id": 1,
      "rewards_count": 1
    }
  ],
  "migrated_rewards": 1,
  "migrated_rewards_expiration_date": "2025-12-19",
  "name": "string",
  "original_membership_no": 1,
  "original_phone": 1,
  "original_points": 1,
  "phone": 1,
  "preferred_location": 1,
  "registration_date": "string",
  "state": "string",
  "street_address": "string",
  "user_relations": [
    {
      "name": "string",
      "relation": "string",
      "birthday": "2025-12-19"
    }
  ],
  "zip_code": "string",
  "gift_cards": [
    {
      "card_number": "string",
      "card_design_id": "string",
      "epin": "string"
    }
  ],
  "challenge_progress": [
    {
      "challenge_campaign_id": 1,
      "progress_count": 1
    }
  ],
  "migration_user_id": 1,
  "fb_uid": "string",
  "loyalty_cards": [
    {
      "card_number": "string",
      "status": "string",
      "card_signup_date": "2023-02-03"
    }
  ]
}