Create Members Import Request

Creates new members or updates existing ones (based on msisdn and e-mail identifiers).

There is a maximum number of members that can be sent in one request (1000). So, if you intend to import more than
that, you may want to identify all bulks with the same import_id and pass consequent request_number to each of them.

Body Parameters

Parameter	Required?	Default	Description	Type
import_id	no	auto-generated	When you're making more than one call you can consider adding it. Otherwise it will be auto-generated	String
request_number	no	-	A number that you can use for bulk identification in "Status" endpoint. It's up to you to provide it's uniqueness. Useless without specifying `import_id`	Integer
members	yes	-	Array with members payloads - See below	object[]
operation	no	`"create"`	Should members be created or updated	enum: ['create', 'update']
member_identifier_type	no	`"id"`	(for `"update"` operation) Which member property should be used to identify member for update	enum: ['id', 'email', 'msisdn']
multi_values_update_mode	no	`"replace"`	(for `"update"` operation) When "append" is given, multi-value member attributes (like arrays) are appended to existing ones. In other case, they're replaced	enum: ['update', 'append']

Members Array

General requirements:

all members must have unique identifiers (msisdn or email)

maximum number of items in array is 1000

Key	Required?	Default	Description	Type
properties	yes	-	JSON with properties for member (see: Member model	JSON Object
properties['msisdn']	yes*	none	Unique member's msisdn as defined here) Example: `4740769126`.	string
properties['email']	yes*	none	Member's email	string
password	no	null	Member’s password. Not required, but user may not be able to log in without this	String
sms_enabled	no	true	Should SMS channel be enabled for member?	Boolean
email_enabled	no	true	Should email channel be enabled for member?	Boolean
push_enabled	no	true	Should push channel be enabled for member?	Boolean
optin_channel	no	"import"**	Source of member	String
optin_subchannel	no	import's id**	Subsource of member	String
consents	no	{}	Members consents	See Member's consents JSON model

* At least one of those properties must be provided

** When those member attributes are missing on creation, defaults will be used. When on update, they won't be overwritten.

Response Body

Key	Description	Type
import_id	Identifier for import status checking (either provided by you or auto-generated)	String

Error Responses

Status	Reason	Description
`422`	Invalid payload	Returns error object - see below

Invalid Payload Error (JSON object)

When payload is invalid, an object is returned: {"error" => <reason>}

Possible reasons are:

Code	Description
`duplicated_emails`	At least two members in payload share same email
`duplicated_msisdns`	At least two members in payload share same msisdn
`members_size_incorrect`	Members number in payload exceeds maximum (1000)
`members_empty`	Payload is empty
`missing_identifier`	At least one member in payload misses required identifier (depends on Loyalty Club)
`invalid_operation`	Specified operation is not supported
`invalid_member_identifier_type`	Specified identifier type is invalid or unavailable in Loyalty Club

Example

When successful, returns JSON structured like this:

{
  "import_id": "a9a00143-6488-4d4f-87d4-29c2da02d678"
}

When input is invalid, returns the error object:

{
  "error": "duplicated_msisdns"
}

Request

Path Params

loyalty_club_slug

string

required

Example:

infinity-mall

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Create Members Import Request

Body Parameters#

Members Array#

Response Body#

Error Responses#

Invalid Payload Error (JSON object)#

Example#

Request

Request samples

Responses

Body Parameters

Members Array

Response Body

Error Responses

Invalid Payload Error (JSON object)

Example