Imports or updates members.

curl --request POST \
  --url https://{host}/member/v1/members/import \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "memberId": "<string>",
    "isActive": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phone": "<string>",
    "birthdate": "2023-11-07T05:31:56Z",
    "address": {
      "zipCode": "<string>",
      "city": "<string>",
      "addressLine1": "<string>",
      "addressLine2": "<string>",
      "region": "<string>",
      "countryCode": "<string>"
    },
    "genderId": "<string>",
    "selectedStoreId": "<string>",
    "loyaltyProgram": "<string>",
    "isEmployee": true,
    "nationality": "<string>",
    "metadata": {},
    "deceased": true,
    "homeTelephone": "<string>",
    "isMembershipFeePaid": true,
    "customProperties": {}
  }
]
'

import requests

url = "https://{host}/member/v1/members/import"

payload = [
    {
        "memberId": "<string>",
        "isActive": True,
        "createdAt": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "phone": "<string>",
        "birthdate": "2023-11-07T05:31:56Z",
        "address": {
            "zipCode": "<string>",
            "city": "<string>",
            "addressLine1": "<string>",
            "addressLine2": "<string>",
            "region": "<string>",
            "countryCode": "<string>"
        },
        "genderId": "<string>",
        "selectedStoreId": "<string>",
        "loyaltyProgram": "<string>",
        "isEmployee": True,
        "nationality": "<string>",
        "metadata": {},
        "deceased": True,
        "homeTelephone": "<string>",
        "isMembershipFeePaid": True,
        "customProperties": {}
    }
]
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      memberId: '<string>',
      isActive: true,
      createdAt: '2023-11-07T05:31:56Z',
      email: '<string>',
      firstName: '<string>',
      lastName: '<string>',
      phone: '<string>',
      birthdate: '2023-11-07T05:31:56Z',
      address: {
        zipCode: '<string>',
        city: '<string>',
        addressLine1: '<string>',
        addressLine2: '<string>',
        region: '<string>',
        countryCode: '<string>'
      },
      genderId: '<string>',
      selectedStoreId: '<string>',
      loyaltyProgram: '<string>',
      isEmployee: true,
      nationality: '<string>',
      metadata: {},
      deceased: true,
      homeTelephone: '<string>',
      isMembershipFeePaid: true,
      customProperties: {}
    }
  ])
};

fetch('https://{host}/member/v1/members/import', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/member/v1/members/import",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'memberId' => '<string>',
        'isActive' => true,
        'createdAt' => '2023-11-07T05:31:56Z',
        'email' => '<string>',
        'firstName' => '<string>',
        'lastName' => '<string>',
        'phone' => '<string>',
        'birthdate' => '2023-11-07T05:31:56Z',
        'address' => [
                'zipCode' => '<string>',
                'city' => '<string>',
                'addressLine1' => '<string>',
                'addressLine2' => '<string>',
                'region' => '<string>',
                'countryCode' => '<string>'
        ],
        'genderId' => '<string>',
        'selectedStoreId' => '<string>',
        'loyaltyProgram' => '<string>',
        'isEmployee' => true,
        'nationality' => '<string>',
        'metadata' => [
                
        ],
        'deceased' => true,
        'homeTelephone' => '<string>',
        'isMembershipFeePaid' => true,
        'customProperties' => [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/member/v1/members/import"

	payload := strings.NewReader("[\n  {\n    \"memberId\": \"<string>\",\n    \"isActive\": true,\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"email\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"birthdate\": \"2023-11-07T05:31:56Z\",\n    \"address\": {\n      \"zipCode\": \"<string>\",\n      \"city\": \"<string>\",\n      \"addressLine1\": \"<string>\",\n      \"addressLine2\": \"<string>\",\n      \"region\": \"<string>\",\n      \"countryCode\": \"<string>\"\n    },\n    \"genderId\": \"<string>\",\n    \"selectedStoreId\": \"<string>\",\n    \"loyaltyProgram\": \"<string>\",\n    \"isEmployee\": true,\n    \"nationality\": \"<string>\",\n    \"metadata\": {},\n    \"deceased\": true,\n    \"homeTelephone\": \"<string>\",\n    \"isMembershipFeePaid\": true,\n    \"customProperties\": {}\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/member/v1/members/import")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"memberId\": \"<string>\",\n    \"isActive\": true,\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"email\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"birthdate\": \"2023-11-07T05:31:56Z\",\n    \"address\": {\n      \"zipCode\": \"<string>\",\n      \"city\": \"<string>\",\n      \"addressLine1\": \"<string>\",\n      \"addressLine2\": \"<string>\",\n      \"region\": \"<string>\",\n      \"countryCode\": \"<string>\"\n    },\n    \"genderId\": \"<string>\",\n    \"selectedStoreId\": \"<string>\",\n    \"loyaltyProgram\": \"<string>\",\n    \"isEmployee\": true,\n    \"nationality\": \"<string>\",\n    \"metadata\": {},\n    \"deceased\": true,\n    \"homeTelephone\": \"<string>\",\n    \"isMembershipFeePaid\": true,\n    \"customProperties\": {}\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/member/v1/members/import")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"memberId\": \"<string>\",\n    \"isActive\": true,\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"email\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"birthdate\": \"2023-11-07T05:31:56Z\",\n    \"address\": {\n      \"zipCode\": \"<string>\",\n      \"city\": \"<string>\",\n      \"addressLine1\": \"<string>\",\n      \"addressLine2\": \"<string>\",\n      \"region\": \"<string>\",\n      \"countryCode\": \"<string>\"\n    },\n    \"genderId\": \"<string>\",\n    \"selectedStoreId\": \"<string>\",\n    \"loyaltyProgram\": \"<string>\",\n    \"isEmployee\": true,\n    \"nationality\": \"<string>\",\n    \"metadata\": {},\n    \"deceased\": true,\n    \"homeTelephone\": \"<string>\",\n    \"isMembershipFeePaid\": true,\n    \"customProperties\": {}\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "importedCount": 123,
  "updatedCount": 123,
  "skipped": [
    {
      "memberId": "<string>",
      "reason": "<string>"
    }
  ]
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

POST

members

import

Imports or updates members.

curl --request POST \
  --url https://{host}/member/v1/members/import \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
[
  {
    "memberId": "<string>",
    "isActive": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "phone": "<string>",
    "birthdate": "2023-11-07T05:31:56Z",
    "address": {
      "zipCode": "<string>",
      "city": "<string>",
      "addressLine1": "<string>",
      "addressLine2": "<string>",
      "region": "<string>",
      "countryCode": "<string>"
    },
    "genderId": "<string>",
    "selectedStoreId": "<string>",
    "loyaltyProgram": "<string>",
    "isEmployee": true,
    "nationality": "<string>",
    "metadata": {},
    "deceased": true,
    "homeTelephone": "<string>",
    "isMembershipFeePaid": true,
    "customProperties": {}
  }
]
'

import requests

url = "https://{host}/member/v1/members/import"

payload = [
    {
        "memberId": "<string>",
        "isActive": True,
        "createdAt": "2023-11-07T05:31:56Z",
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "phone": "<string>",
        "birthdate": "2023-11-07T05:31:56Z",
        "address": {
            "zipCode": "<string>",
            "city": "<string>",
            "addressLine1": "<string>",
            "addressLine2": "<string>",
            "region": "<string>",
            "countryCode": "<string>"
        },
        "genderId": "<string>",
        "selectedStoreId": "<string>",
        "loyaltyProgram": "<string>",
        "isEmployee": True,
        "nationality": "<string>",
        "metadata": {},
        "deceased": True,
        "homeTelephone": "<string>",
        "isMembershipFeePaid": True,
        "customProperties": {}
    }
]
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify([
    {
      memberId: '<string>',
      isActive: true,
      createdAt: '2023-11-07T05:31:56Z',
      email: '<string>',
      firstName: '<string>',
      lastName: '<string>',
      phone: '<string>',
      birthdate: '2023-11-07T05:31:56Z',
      address: {
        zipCode: '<string>',
        city: '<string>',
        addressLine1: '<string>',
        addressLine2: '<string>',
        region: '<string>',
        countryCode: '<string>'
      },
      genderId: '<string>',
      selectedStoreId: '<string>',
      loyaltyProgram: '<string>',
      isEmployee: true,
      nationality: '<string>',
      metadata: {},
      deceased: true,
      homeTelephone: '<string>',
      isMembershipFeePaid: true,
      customProperties: {}
    }
  ])
};

fetch('https://{host}/member/v1/members/import', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{host}/member/v1/members/import",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    [
        'memberId' => '<string>',
        'isActive' => true,
        'createdAt' => '2023-11-07T05:31:56Z',
        'email' => '<string>',
        'firstName' => '<string>',
        'lastName' => '<string>',
        'phone' => '<string>',
        'birthdate' => '2023-11-07T05:31:56Z',
        'address' => [
                'zipCode' => '<string>',
                'city' => '<string>',
                'addressLine1' => '<string>',
                'addressLine2' => '<string>',
                'region' => '<string>',
                'countryCode' => '<string>'
        ],
        'genderId' => '<string>',
        'selectedStoreId' => '<string>',
        'loyaltyProgram' => '<string>',
        'isEmployee' => true,
        'nationality' => '<string>',
        'metadata' => [
                
        ],
        'deceased' => true,
        'homeTelephone' => '<string>',
        'isMembershipFeePaid' => true,
        'customProperties' => [
                
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{host}/member/v1/members/import"

	payload := strings.NewReader("[\n  {\n    \"memberId\": \"<string>\",\n    \"isActive\": true,\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"email\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"birthdate\": \"2023-11-07T05:31:56Z\",\n    \"address\": {\n      \"zipCode\": \"<string>\",\n      \"city\": \"<string>\",\n      \"addressLine1\": \"<string>\",\n      \"addressLine2\": \"<string>\",\n      \"region\": \"<string>\",\n      \"countryCode\": \"<string>\"\n    },\n    \"genderId\": \"<string>\",\n    \"selectedStoreId\": \"<string>\",\n    \"loyaltyProgram\": \"<string>\",\n    \"isEmployee\": true,\n    \"nationality\": \"<string>\",\n    \"metadata\": {},\n    \"deceased\": true,\n    \"homeTelephone\": \"<string>\",\n    \"isMembershipFeePaid\": true,\n    \"customProperties\": {}\n  }\n]")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{host}/member/v1/members/import")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("[\n  {\n    \"memberId\": \"<string>\",\n    \"isActive\": true,\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"email\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"birthdate\": \"2023-11-07T05:31:56Z\",\n    \"address\": {\n      \"zipCode\": \"<string>\",\n      \"city\": \"<string>\",\n      \"addressLine1\": \"<string>\",\n      \"addressLine2\": \"<string>\",\n      \"region\": \"<string>\",\n      \"countryCode\": \"<string>\"\n    },\n    \"genderId\": \"<string>\",\n    \"selectedStoreId\": \"<string>\",\n    \"loyaltyProgram\": \"<string>\",\n    \"isEmployee\": true,\n    \"nationality\": \"<string>\",\n    \"metadata\": {},\n    \"deceased\": true,\n    \"homeTelephone\": \"<string>\",\n    \"isMembershipFeePaid\": true,\n    \"customProperties\": {}\n  }\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/member/v1/members/import")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "[\n  {\n    \"memberId\": \"<string>\",\n    \"isActive\": true,\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"email\": \"<string>\",\n    \"firstName\": \"<string>\",\n    \"lastName\": \"<string>\",\n    \"phone\": \"<string>\",\n    \"birthdate\": \"2023-11-07T05:31:56Z\",\n    \"address\": {\n      \"zipCode\": \"<string>\",\n      \"city\": \"<string>\",\n      \"addressLine1\": \"<string>\",\n      \"addressLine2\": \"<string>\",\n      \"region\": \"<string>\",\n      \"countryCode\": \"<string>\"\n    },\n    \"genderId\": \"<string>\",\n    \"selectedStoreId\": \"<string>\",\n    \"loyaltyProgram\": \"<string>\",\n    \"isEmployee\": true,\n    \"nationality\": \"<string>\",\n    \"metadata\": {},\n    \"deceased\": true,\n    \"homeTelephone\": \"<string>\",\n    \"isMembershipFeePaid\": true,\n    \"customProperties\": {}\n  }\n]"

response = http.request(request)
puts response.read_body

{
  "importedCount": 123,
  "updatedCount": 123,
  "skipped": [
    {
      "memberId": "<string>",
      "reason": "<string>"
    }
  ]
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

{
  "name": "<string>",
  "message": "<string>",
  "details": null
}

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Body

Members to import or update

Minimum array length: 1

memberId

string

required

Member ID

Required string length: 1 - 36

isActive

boolean

required

Indicates whether the member account is active

createdAt

string<date-time>

required

Date and time when the member account was created in ISO 8601 format (e.g., "2012-03-19T07:22Z")

string | null

Member's email address

Maximum string length: 256

firstName

string | null

Member's first name

Maximum string length: 64

lastName

string | null

Member's last name

Maximum string length: 64

phone

string | null

Member's phone number

Maximum string length: 32

birthdate

string<date-time> | null

Member's birthdate in ISO 8601 format (e.g., "2012-03-19T07:22Z")

address

object

Show child attributes

genderId

string | null

Member's gender identifier

selectedStoreId

string | null

ID of the member's preferred store

Maximum string length: 64

loyaltyProgram

string | null

Loyalty program or tier (e.g., Silver, Gold, Freemium)

Maximum string length: 64

isEmployee

boolean

Indicates whether the member is an employee

nationality

string | null

Member's nationality

Maximum string length: 64

metadata

object | null

Additional metadata associated with the member

Show child attributes

deceased

boolean | null

Indicates whether the member is deceased

homeTelephone

string | null

Member's home telephone number

Maximum string length: 32

isMembershipFeePaid

boolean | null

Indicates whether the membership fee has been paid

customProperties

object | null

Custom typed properties to assign to the member

Show child attributes

Response

importedCount

integer<int32>

updatedCount

integer<int32>

skipped

object[] | null

Show child attributes

Last modified on August 10, 2026

⌘I