Skip to main content

Create user profile

Create user profile

Request Body REQUIRED

The user profile

SiteId int32

The ID of the site associated with the user.

Email string

The email address of the user.

FirstName string

The first name of the user.

LastName string

The last name of the user.

PhoneNr string

The phone number of the user.

MobilePhoneNr string

The mobile phone number of the user.

Company string

The company the user is associated with.

UserTypeId int32

UserTypeId of the user. 1 = Private, 2 = Company.

MemberId int32

The member ID of the user. Obsolote. Use CustomerGroupId instead.

CustomerGroupId int32

The Customer Group Id of the user.

Address string

The address of the user.

Address2 string

The second line of the user's address.

Address3 string

The third line of the user's address.

DoorCode string

The door code for the user's address.

PersonalId string

The personal ID of the user.

Birthyear string

The birth year of the user.

Zip string

The zip code of the user's address.

City string

The city of the user's address.

CareOf string

The care of (c/o) address of the user.

Country string

The country of the user's address. Can be a country code or a country name.

State string

The state of the user's address.

CountryId int32

The country ID of the user's address.

GenderType int32

Possible values: [0, 1, 2]

The gender of the user. Enum type with the following values: Unspecified=0, Female=1, Male=2.
0 = Unspecified
1 = Female
2 = Male

Password string

The password of the user.

Newsletter boolean

Decides whether the user should be subscribed to the newsletter.

MetaData string

Free-text field for any additional data that should be stored with the user.

Responses
200

The created user profile.

Schema OPTIONAL
Resource object OPTIONAL
UserId int32 OPTIONAL

The ID of the user.

SiteId int32 OPTIONAL

The ID of the site associated with the user.

Email string OPTIONAL

The email address of the user.

FirstName string OPTIONAL

The first name of the user.

LastName string OPTIONAL

The last name of the user.

PhoneNr string OPTIONAL

The phone number of the user.

MobilePhoneNr string OPTIONAL

The mobile phone number of the user.

Company string OPTIONAL

The company the user is associated with.

Address string OPTIONAL

The address of the user.

Address2 string OPTIONAL

The second line of the user's address.

Address3 string OPTIONAL

The third line of the user's address.

DoorCode string OPTIONAL

The door code for the user's address.

PersonalId string OPTIONAL

The personal ID of the user.

Birthyear string OPTIONAL

The birth year of the user.

Zip string OPTIONAL

The zip code of the user's address.

City string OPTIONAL

The city of the user's address.

CareOf string OPTIONAL

The care of (c/o) address of the user.

Country string OPTIONAL

The country of the user's address.

State string OPTIONAL

The state of the user's address.

CustomerGroupId int32 OPTIONAL

The id of the customer group that the customer belongs to.

CustomerGroupName string OPTIONAL

The name of the customer group that the customer belongs to.

MemberId int32 OPTIONAL

The member ID of the user. Obsolete. Use CustomerGroupId instead.

MemberType string OPTIONAL

The member type of the user. Obsolete. Use CustomerGroupName instead.

CountryId int32 OPTIONAL

The country ID of the user's address.

UserTypeId int32 OPTIONAL

UserTypeId of the user. 1 = Private, 2 = Company.

GenderType int32 OPTIONAL

Possible values: [0, 1, 2]

The gender of the user. Enum type with the following values: Unspecified=0, Female=1, Male=2.
0 = Unspecified
1 = Female
2 = Male

MemberDiscount int32 OPTIONAL

The member discount of the user.

Newsletter boolean OPTIONAL

Decides whether the user should be subscribed to the newsletter.

Blacklisted boolean OPTIONAL

Indicates whether the user is blacklisted.

Active boolean OPTIONAL

Indicates whether the user is active.

CreatedOn date-time OPTIONAL

The date and time when the user was created.

UpdatedOn date-time OPTIONAL

The date and time when the user was last updated.

MetaData string OPTIONAL

Metadata associated with the user.

BlacklistedOn date-time OPTIONAL

The date and time when the user was blacklisted.

BlacklistReason string OPTIONAL

The reason for blacklisting the user.

Message string OPTIONAL

A status message for the action taken.

Details string[] OPTIONAL

Any validation messages for the data on the current action.

400

Bad request.

Schema OPTIONAL
Message string OPTIONAL

A status message for the action taken.

Details string[] OPTIONAL

Any validation messages for the data on the current action.