PATCH api/loyalty2/member/v2

Patches member. NOTE: Will only update optional properties that are not omitted and hold valid data.

Request Information

URI Parameters

None.

Body Parameters

The member to patch.

PublicAPI.Models.MemberV2PatchModel
NameDescriptionTypeAdditional information
Id

The unique Id of the Loyalty member.

integer

Required

Range: inclusive between 1 and 2147483647

CustomerNumber

The original or patched customer number of the member. Note: Must be UNIQUE within a club (if passed-in)!

integer

Required

Range: inclusive between 1 and 9,22337203685478E+18

EngineId

The Id of the Loyalty engine, to which the member shall be assigned. See "...api/loyalty2/engine/club/engines" for fetching all engines of a club. Also see "...Help/ResourceModel?modelName=EngineTypeIdentifier" to understand the type identifiers of engines.

integer

Required

Range: inclusive between 1 and 2147483647

CreationShopId

Shop id of creation shop.

integer

Range: inclusive between 0 and 999999

FirstName

First name

string

Max length: 450

LastName

Last name

string

Max length: 450

Address

Address

string

Max length: 500

PostalCode

Postal code

string

Max length: 50

City

City

string

Max length: 500

Country

Country

string

Max length: 500

Gender

Gender

string

Max length: 1

Valid values: "M","F",null

DateOfBirth

Non-UTC date of birth. Date only.

date

None.

Email

Email

string

Max length: 200

Phone

Phone number

string

Max length: 50

MarketingChoiceCode

0 = Receive nothing 1 = Receive by both email and mobile 2 = Receive by email only 3 = Receive by mobile only

integer

None.

Notes

Additional notes

string

Max length: -1

IsActive

(Not)active identifier

boolean

None.

SignedUp

The sign-up date and time of the member in Coordinated Universal Time (UTC)

date

None.

DefaultShop

Default store

integer

None.

SocialSecurityNr

Social and serurity number

string

None.

TermsConditionsApproved

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": 1,
  "CustomerNumber": 2,
  "EngineId": 3,
  "CreationShopId": 4,
  "FirstName": "sample string 5",
  "LastName": "sample string 6",
  "Address": "sample string 7",
  "PostalCode": "sample string 8",
  "City": "sample string 9",
  "Country": "sample string 10",
  "Gender": "sample string 11",
  "DateOfBirth": "2025-05-04T05:12:10.6597274+02:00",
  "Email": "sample string 12",
  "Phone": "sample string 13",
  "MarketingChoiceCode": 1,
  "Notes": "sample string 14",
  "IsActive": true,
  "SignedUp": "2025-05-04T05:12:10.6597274+02:00",
  "DefaultShop": 1,
  "SocialSecurityNr": "sample string 15",
  "TermsConditionsApproved": true
}

application/xml, text/xml

Sample:
<MemberV2PatchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PublicAPI.Models">
  <Address>sample string 7</Address>
  <City>sample string 9</City>
  <Country>sample string 10</Country>
  <CreationShopId>4</CreationShopId>
  <CustomerNumber>2</CustomerNumber>
  <DateOfBirth>2025-05-04T05:12:10.6597274+02:00</DateOfBirth>
  <DefaultShop>1</DefaultShop>
  <Email>sample string 12</Email>
  <EngineId>3</EngineId>
  <FirstName>sample string 5</FirstName>
  <Gender>sample string 11</Gender>
  <Id>1</Id>
  <IsActive>true</IsActive>
  <LastName>sample string 6</LastName>
  <MarketingChoiceCode>1</MarketingChoiceCode>
  <Notes>sample string 14</Notes>
  <Phone>sample string 13</Phone>
  <PostalCode>sample string 8</PostalCode>
  <SignedUp>2025-05-04T05:12:10.6597274+02:00</SignedUp>
  <SocialSecurityNr>sample string 15</SocialSecurityNr>
  <TermsConditionsApproved>true</TermsConditionsApproved>
</MemberV2PatchModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'MemberV2PatchModel'.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample:
true

application/xml, text/xml

Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>