Create Member

Creates a new member.

Request

POST /user/v1/member

Path Parameters

No parameters

Query Parameters

No parameters

Payload Properties

identifiers dictionary : required

A dictionary containing unique identifiers for the member.

key string : required

The unique type identifier. Possible values can be found in the Member Identifier Type Dictionary. At a minimum, aclientmemberid is required.

value string : required

The unique member identifier.

type string : required

The type of member. Possible values can be found in the Member Type Dictionary.

groupId string : optional

The unique identifier of the group the member belongs to. This is required when the type is primary. It is otherwise ignored.

serviceOfferingId string : required

The unique identifier of the service offering that should be assigned to the member.

primaryMemberId string : optional

The unique identifier of the primary member on the account. This is required when the type is NOT primary. It is otherwise ignored.

firstName string : required

The member's first name.

lastName string : required

The member's last name.

gender string : required

The gender of the member. Possible values can be found in the Gender Type Dictionary.

dateOfBirth date : optional

The member's date of birth.

mobileNumber string : optional

The member's mobile phone number. Value will be in E-164 format.

emailAddress string : optional

The member's email address.

homePostalAddressLine1 string : optional

The first line of the address.

homePostalAddressLine2 string : optional

The second line of the address.

homePostalAddressCity string : optional

The city.

homePostalAddressState string : optional

The USPS 2 character state abbreviation.

homePostalAddressZipCode string : optional

The USPS zip code.

homePostalAddressCountryCode string : optional

The country code is in ISO 3166-1 format.

Example

{
	"identifiers": {
		"clientmemberid": "d6d9c46b6b2d4c12bca09e46d7f4c938"
	},
	"groupId": "grp_bcbeed73f9a544e28f6714b63e6ee510",
	"serviceOfferingId": "srvo_efb154ed229f4d0b8017f4390d385f23",
	"type": "primary",
	"primaryMemberId": null,
	"firstName": "John",
	"lastName": "Doe",
	"gender": "M",
	"dateOfBirth": "1970-01-01",
	"emailAddress": "[email protected]",
	"mobileNumber": "+15551234567",
	"homePostalAddressLine1": "555 Nowhere Ln",
	"homePostalAddressLine2": "Apt 12",
	"homePostalAddressCity": "Dallas",
	"homePostalAddressState": "TX",
	"homePostalAddressZipCode": "75063",
	"homePostalAddressCountryCode": "US"
}

Updated 7 months ago