Refer2

Refers the given person inviting them to Bubblehouse. When they fulfil the conditions (typically making the first purchase), they and the referring user will get a reward (typically loyalty points or discount).

Kind	Write API call
Method	POST
URL	https://app.bubblehouse.com/api/v20230601/<shop>/Refer2
Authentication	Customer TokenShop Token

Input

• customer CustomerIdentity1 required if using a shop token

  A customer to operate upon, when using a shop token.

  If you're using a customer token and decide to pass this field (which we do not recommend), it must match the customer from the token.

• channel ReferralChannel1 required

  The method used to deliver the referral link (or code) to the target person or audience.

• destination string optional

  An email address for the email channel, omit or pass null otherwise.

Output

• referral Referral2 required

  The referral that has just been made.

API-wide Errors

Status	Error	Reason & Examples
400	missing_customer_identity	The customer identity ('customer' input parameter) has not been specified when using a shop token. You need to either specify a non-empty value for one of the customer identity fields, or use a customer token.
404	empty_customer_identity	All fields of the customer identity ('customer' input parameter) have been empty when using a shop token. You need to either specify a non-empty value for one of the customer identity fields, or use a customer token.
403	customer_identity_does_not_match_token	API call is using a customer token, but the customer identity in API params does not match the customer from the token.
404	no_customers_match_customer_identity	The customer identity ('customer' input parameter) does not match a known customer.
404	customer_identity_partially_mismatches_matched_customer	A customer has been matched by one of the fields of the customer identity ('customer' input parameter), but some non-empty fields do not match Bubblehouse data on that customer.

Global Errors

Status	Error	Reason & Examples
400	obsolete_global_api_version	The global API version you are trying to use is no longer supported.
400	inaccessible_global_api_version	The global API version you are trying to use is not enabled on your account.
401	invalid_token	The provided authentication token is invalid or has expired.
429	rate_limit_exceeded	Your usage is over the rate limit. Ensure that you're not making duplicate calls, and contact our team for a rate limit increase.
400	invalid_global_api_version	The global API version you are trying to use has never existed.