Creates a member

Licenses Required

Vista.Ocapi

Request

header Parameters

Connect-Region-Code

string

Region Code

Request Body schema:
application/json
required

Member to create

required	object (MemberCredentialsCreate) Represents the authentication credentials of a member being created
required	object (MemberClubMembership) Represents a member entity's membership of a club
	object (MemberPersonalDetails) Represents the personal details of a member
acceptedTermsAndConditions required	boolean Gets a value indicating whether the member accepted the terms and conditions
authenticationType	string (MemberAuthenticationType) Represents the different types of authentication that can be returned for a member Enum: "None" "Token" "Cookie"

Responses

200

Success

400

Request property is invalid or missing.

post/ocapi/v1/members

Request samples

Payload
curl
JavaScript
Node.js

{"credentials": {"username": "string",
"password": "string",
"pin": "string",
"email": "string"
},
"clubMembership": {"clubId": 0,
"clubLevelId": 0
},
"personalDetails": {"name": {"givenName": "string",
"familyName": "string",
"middleName": "string"
},
"contactDetails": {"phoneNumbers": [{"type": "Home",
"number": "string"
}
],
"address": {"line1": "60 Khyber Pass Road",
"suburb": "Grafton",
"city": "Auckland",
"state": null,
"postCode": "1023",
"country": "New Zealand"
},
"pushNotificationToken": {"id": "string",
"type": "Android"
}
},
"interestSubscriptions": [{"interestId": 0,
"interestContactMethodIds": [0
]
}
],
"preferences": {"sites": {"pickupSiteId": "string",
"primarySiteId": "string",
"preferredSiteIds": ["string"
]
},
"genres": {"preferredGenreIds": ["string"
]
},
"contact": {"contactMethods": ["Sms"
],
"mailerFrequency": "Never",
"allowThirdPartyContact": true
},
"customPreferences": [{"customPreferenceId": 0,
"customPreferenceOptionIds": [0
]
}
],
"languageTag": "en-US",
"allowThirdPartyProfiling": true
},
"birthDate": "2019-08-24T14:15:22Z",
"maritalStatus": "NotSpecified",
"gender": "NotSpecified",
"educationLevelId": 0,
"occupationId": 0,
"householdPersonCount": 0,
"nationalId": "string",
"externalId": "string"
},
"acceptedTermsAndConditions": true,
"authenticationType": "None"
}

Response samples

application/json

{"memberDetails": {"member": {"id": "string",
"hash": "string",
"membershipStartDate": "2019-08-24T14:15:22Z",
"credentials": {"email": "string",
"username": "string"
},
"clubMembership": {"clubId": 0,
"clubLevelId": 0
},
"personalDetails": {"name": {"givenName": "string",
"familyName": "string",
"middleName": "string"
},
"contactDetails": {"phoneNumbers": [{"type": "Home",
"number": "string"
}
],
"address": {"line1": "60 Khyber Pass Road",
"suburb": "Grafton",
"city": "Auckland",
"state": null,
"postCode": "1023",
"country": "New Zealand"
},
"pushNotificationToken": {"id": "string",
"type": "Android"
}
},
"interestSubscriptions": [{"interestId": 0,
"interestContactMethodIds": [0
]
}
],
"preferences": {"sites": {"pickupSiteId": "string",
"primarySiteId": "string",
"preferredSiteIds": ["string"
]
},
"genres": {"preferredGenreIds": ["string"
]
},
"contact": {"contactMethods": ["Sms"
],
"mailerFrequency": "Never",
"allowThirdPartyContact": true
},
"customPreferences": [{"customPreferenceId": 0,
"customPreferenceOptionIds": [null
]
}
],
"languageTag": "en-US",
"allowThirdPartyProfiling": true
},
"birthDate": "2019-08-24T14:15:22Z",
"maritalStatus": "NotSpecified",
"gender": "NotSpecified",
"educationLevelId": 0,
"occupationId": 0,
"householdPersonCount": 0,
"nationalId": "string",
"externalId": "string"
},
"cards": [{"cardNumber": "string",
"isPrimary": true
}
],
"balances": [{"balanceTypeId": 0,
"availableUnits": 0.1,
"expiries": [{"units": 0.1,
"expiresAt": "2019-08-24T14:15:22Z"
}
]
}
],
"photo": {"isUpdatable": true,
"canBeUpdatedAt": "2019-08-24T14:15:22Z",
"uriExpiresAt": "2019-08-24T14:15:22Z",
"uri": "http://example.com"
},
"subscriptions": {"current": {"subscriptionId": 0,
"status": "Active",
"startsAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"contractedTermEndsAt": "2019-08-24T14:15:22Z",
"billingDetails": {"isRecurring": true,
"reactivationPrice": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
},
"isUsingThirdPartyPaymentProvider": true,
"currentBillingPeriodStartsAt": "2019-08-24T14:15:22Z",
"nextBillingPeriodStartsAt": "2019-08-24T14:15:22Z",
"billingError": {"willBeRetried": true
},
"hasLastContractedPaymentBeenMade": true,
"hasNextBillingPeriodPriceAdjustment": true
},
"holdPeriod": {"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"isCancellationAllowed": true,
"cancelsAt": "2019-08-24T14:15:22Z"
},
"future": {"subscriptionId": 0,
"status": "Active",
"startsAt": "2019-08-24T14:15:22Z",
"expiresAt": "2019-08-24T14:15:22Z",
"contractedTermEndsAt": "2019-08-24T14:15:22Z",
"billingDetails": {"isRecurring": true,
"reactivationPrice": {"valueIncludingTax": 0.1,
"valueExcludingTax": 0.1,
"tax": 0.1
},
"isUsingThirdPartyPaymentProvider": true,
"currentBillingPeriodStartsAt": "2019-08-24T14:15:22Z",
"nextBillingPeriodStartsAt": "2019-08-24T14:15:22Z",
"billingError": {"willBeRetried": true
},
"hasLastContractedPaymentBeenMade": true,
"hasNextBillingPeriodPriceAdjustment": true
},
"holdPeriod": {"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z"
},
"isCancellationAllowed": true,
"cancelsAt": "2019-08-24T14:15:22Z"
},
"canPurchaseFutureSubscription": true,
"canPurchaseFutureSubscriptionAt": "2019-08-24T14:15:22Z"
},
"friends": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": {"givenName": "string",
"familyName": "string",
"middleName": "string"
},
"photo": {"uriExpiresAt": "2019-08-24T14:15:22Z",
"uri": "http://example.com"
},
"subscriptionSharing": {"friendCanUseMemberSubscription": true,
"friendSubscriptions": [{"subscriptionId": null
}
]
},
"createdAt": "2019-08-24T14:15:22Z"
}
]
},
"relatedData": {"balanceTypes": [{"id": 0,
"name": {"text": "string",
"translations": [{"languageTag": null,
"text": null
}
]
},
"isPrimary": true,
"unitName": "Points",
"paymentConversionRate": 0.1,
"unitDecimalPlaces": 0
}
],
"club": {"id": 0,
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
}
},
"clubLevel": {"id": 0,
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
},
"isExemptFromBookingFees": true
},
"customPreferences": [{"id": 0,
"name": {"text": "string",
"translations": [{"languageTag": null,
"text": null
}
]
},
"optionQuantityLimit": {"isUnlimited": true,
"maximum": 0,
"minimum": 0
},
"options": [{"id": 0,
"name": {"text": null,
"translations": [ ]
}
}
]
}
],
"educationLevel": {"id": 0,
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
}
},
"genres": [{"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": null,
"text": null
}
]
}
}
],
"interests": [{"id": 0,
"name": {"text": "string",
"translations": [{"languageTag": null,
"text": null
}
]
},
"displayPriority": 0
}
],
"interestContactMethods": [{"id": 0,
"name": {"text": "string",
"translations": [{"languageTag": null,
"text": null
}
]
}
}
],
"occupation": {"id": 0,
"name": {"text": "string",
"translations": [{"languageTag": "en-US",
"text": "string"
}
]
}
},
"sites": [{"location": {"latitude": 0.1,
"longitude": 0.1
},
"contactDetails": {"phoneNumbers": [{"type": null,
"number": null
}
],
"email": "string",
"address": {"line1": "60 Khyber Pass Road",
"line2": "Grafton",
"city": "Auckland 1023"
}
},
"ianaTimeZoneName": "America/New_York",
"id": "string",
"name": {"text": "string",
"translations": [{"languageTag": null,
"text": null
}
]
},
"hasSellableItems": true,
"allowedItemDeliveryMethods": ["CounterPickup"
]
}
],
"subscriptions": [{"id": 0,
"name": {"text": "string",
"translations": [{"languageTag": null,
"text": null
}
]
},
"clubId": 0,
"minimumTermInMonths": 0,
"minimumTermBeforeCanPurchaseFutureSubscriptionInMonths": 0
}
]
}
},
"authenticationToken": {"access_token": "string",
"token_type": "Bearer",
"expires_in": 0,
"refresh_token": "string"
}
}

Creates a member

Licenses Required

header Parameters

Request Body schema: application/jsontext/jsonapplication/*+jsonapplication/json-patch+jsonapplication/jsonrequired

Request Body schema:
application/json
required