Create Member

Create member with given properties.

Available properties and their validation rules are defined by Loyalty Club schema
(see: here).

Actual welcome messages sending depends on Loyalty Club and Product configuration.
For example, even if send_email_welcome_message:true param is provided, message may not be sent because either Product
or Loyalty has disabled welcome messages or Loyalty Club has no e-mails configured at all.

There is also a possibility to have multiple SMS welcome messages sent. The one that matches Product or default one will be sent.

Headers

Header name	Required?	Description
X-Subproduct-Name	no	Additional source/optin channel information

Body Parameters

Parameter	Type	Required?	Default	Description
properties	object	yes	none	JSON with properties for member
properties['language']	string	no	"default_language" from schema	Language used by user
properties['msisdn']	string	yes*	none	Unique member's msisdn as defined here) Example: `4740769126`.
properties['email']	string	yes*	none	Member's email
consents	object	no	{}	Member's consents (similar to Member's consents JSON model)
send_sms_welcome_message	boolean	no	true	Should SMS welcome message be sent to member?
send_email_welcome_message	boolean	no	true	Should email welcome be sent to member
password	string	depends**	none	Member's password. See: Member Password
registration_password	string	depends**	none	Password for registration for member MSISDN verification, see above
ignore_required_properties	boolean	no	false	When `true`, it allows to create a member without required properties (client must have `BL:Api:Members:Create` permit to use this parameter)
external_token	string	depends	none	External token send by provider of social authentication
external_token_type	string	depends	none	Type of external token values: apple, google
favorite_stores	integer[]	no	[]	IDs of member favorite stores. See Stores
~~sms_enabled~~***	boolean	no	true	Should SMS channel be enabled for member?
~~email_enabled~~***	boolean	no	true	Should email channel be enabled for member?
~~push_enabled~~***	boolean	no	true	Should push channel be enabled for member?

* At least one of those properties must be provided.
** At least one type of password is required. See below.
*** This field is deprecated. We advise not to use it.

Passwords

We require either Member Password or Registration Password (see below)
for member to be able to sign in future using OAuth flow.

Member Password

Member Passwords should be used only in setups where Member is not authenticated with
OTP.

Registration Password

In setups with OTP,
we require registration_password param that verifies specific member channel.

Is sent to user with Members > Send registration password

Response Body

Created member properties - see: Member model

Error Responses

Status	Description
`422`	validation errors JSON object.
`465`	`registration_password` or `password` param is missing
`466`	`registration_password` param is invalid
`468`	`external_token` param is invalid

Example

When successful, returns JSON structured like this:

{
  "id": 42,
  "properties": {
    "first_name": "Ola",
    "last_name": "Nordmann",
    "birthday": "1990-10-23",
    "interests": [
      "bikes_and_cars",
      "sportwear"
    ],
    "child_birth_years": [
      2010,
      2011,
      2011
    ],
    "language": "no"
  },
  "consents": {
    "consent1": { "status": true, "updated_at": "2018-12-14T21:57:20.063Z" },
    "consent2": { "status": false, "updated_at": "2018-10-25T21:57:43.738Z" }
  },
  "sms_status": "enabled",
  "email_status": "hard_bounced",
  "push_status": "disabled",
  "optin_channel": "webforms",
  "optin_subchannel": "campaign-10-2017",
  "created_at": "2017-01-19T10:07:08.336+01:00",
  "updated_at": "2017-04-03T09:35:19.313+02:00",
  "banned_until": "2137-04-03T09:35:19.313+02:00",
  "person_id": 99,
  "has_password": false,
  "subunit_ids": [1, 2],
  "has_push_token": false,
  "social_logins": [],
  "favorite_stores": []
}

When payload is invalid, validation errors like this are returned:

{
    "email": [
        {
            "property": "email",
            "error": "duplicated_email_in_community"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Ruby

Headers#

Body Parameters#

Passwords#

Member Password#

Registration Password#

Response Body#

Error Responses#

Example#

Request