POST api/user/registration

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
FirstName	string	Required
LastName	string	Required
Email	string	Required Matching regular expression pattern: ^([\w-\.]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)\|(([\w-]+\.)+))([a-zA-Z]{2,4}\|[0-9]{1,3})(\]?)$
Password	string	Required
Phone	string	Required
PhoneCode	string	Required
BusinessName	string	Required
UserName	string	None.
Address	string	None.
City	string	None.
State	string	None.
ZipCode	string	None.
Country	string	None.
AdsObjectId	string	None.
UserVerifiedTypes	Collection of integer	None.
AppKey	globally unique identifier	None.
ReturnUrl	string	None.

Request Formats

application/json, text/json

Sample:

{
  "FirstName": "sample string 1",
  "LastName": "sample string 2",
  "Email": "sample string 3",
  "Password": "sample string 4",
  "Phone": "sample string 5",
  "PhoneCode": "sample string 6",
  "BusinessName": "sample string 7",
  "UserName": "sample string 8",
  "Address": "sample string 9",
  "City": "sample string 10",
  "State": "sample string 11",
  "ZipCode": "sample string 12",
  "Country": "sample string 13",
  "AdsObjectId": "sample string 14",
  "UserVerifiedTypes": [
    1,
    2
  ],
  "AppKey": "d3f4783b-7763-4ead-8fec-89111ec152fd",
  "ReturnUrl": "sample string 15"
}

application/xml, text/xml

Sample:

<CreateUserRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/">
  <Address>sample string 9</Address>
  <AdsObjectId>sample string 14</AdsObjectId>
  <AppKey>d3f4783b-7763-4ead-8fec-89111ec152fd</AppKey>
  <BusinessName>sample string 7</BusinessName>
  <City>sample string 10</City>
  <Country>sample string 13</Country>
  <Email>sample string 3</Email>
  <FirstName>sample string 1</FirstName>
  <LastName>sample string 2</LastName>
  <Password>sample string 4</Password>
  <Phone>sample string 5</Phone>
  <PhoneCode>sample string 6</PhoneCode>
  <ReturnUrl>sample string 15</ReturnUrl>
  <State>sample string 11</State>
  <UserName>sample string 8</UserName>
  <UserVerifiedTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </UserVerifiedTypes>
  <ZipCode>sample string 12</ZipCode>
</CreateUserRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

LoginResponseMobile

Name	Description	Type	Additional information
IsLoginSuccess	IsLoginSuccess	boolean	None.
Message		string	None.
AccessToken		string	None.
Name		string	None.
Email		string	None.
Status		string	None.
CreateInteractionUrl		string	None.
RegisterUrl		string	None.
ForgotPasswordUrl		string	None.
CompanyName		string	None.
ShowOnBoarding		boolean	None.
AppPlan		AppPlan	None.
AppMenu		DataTable	None.
AppInfo		DataTable	None.
AutoSignUp		boolean	None.
CreateFirstInteraction		boolean	None.
AllowEditInteraction		boolean	None.
AllowAddInteraction		boolean	None.
AllowDeleteAccount		boolean	None.
WhatInteractionVideo		string	None.
CreateMeetingUrl		string	None.
STPServiceUrl		string	None.
STPServiceKey		string	None.
STPAppKey		string	None.
UserInfo		UserInfo	None.
ProfileImageUrl		string	None.
AccountId		globally unique identifier	None.
ContactId		globally unique identifier	None.
AuthResponse		AuthResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "IsLoginSuccess": true,
  "Message": "sample string 2",
  "AccessToken": "sample string 3",
  "Name": "sample string 4",
  "Email": "sample string 5",
  "Status": "sample string 6",
  "CreateInteractionUrl": "sample string 7",
  "RegisterUrl": "sample string 8",
  "ForgotPasswordUrl": "sample string 9",
  "CompanyName": "sample string 10",
  "ShowOnBoarding": true,
  "AppPlan": {
    "PlanName": "sample string 1",
    "Status": "sample string 2",
    "StatusColor": "sample string 3"
  },
  "AppMenu": null,
  "AppInfo": [],
  "AutoSignUp": true,
  "CreateFirstInteraction": true,
  "AllowEditInteraction": true,
  "AllowAddInteraction": true,
  "AllowDeleteAccount": true,
  "WhatInteractionVideo": "sample string 17",
  "CreateMeetingUrl": "sample string 18",
  "STPServiceUrl": "sample string 19",
  "STPServiceKey": "sample string 20",
  "STPAppKey": "sample string 21",
  "UserInfo": {
    "AppAccessKey": "sample string 1",
    "AdsObjKey": "sample string 2",
    "ContactKey": 1,
    "ContactId": "sample string 3",
    "AdsObjId": "sample string 4",
    "ContactFirstName": "sample string 5",
    "ContactLastName": "sample string 6",
    "ContactStatusId": {},
    "ContactAddressLine1": "sample string 8",
    "ContactCity": "sample string 9",
    "ContactState": "sample string 10",
    "ContactZipCode": "sample string 11",
    "ContactCountry": "sample string 12",
    "ContactEmail": "sample string 13",
    "ContactPhone": "sample string 14",
    "ContactUserTypeId": 1,
    "CMPRoleId": 1,
    "SpectrumRoleId": 1,
    "XYZReviewsRoleId": 1,
    "VSPRoleId": 1,
    "ContactCreatedOn": "2025-11-01T23:57:34.4464929+00:00",
    "ContactModifiedOn": "2025-11-01T23:57:34.4464929+00:00",
    "ContactFullName": "sample string 15",
    "IsMobileVerified": true,
    "AccountKey": 1,
    "AccountId": "sample string 16",
    "AccountName": "sample string 17",
    "CableCompanyId": {},
    "AccountAddressLine1": "sample string 19",
    "AccountCity": "sample string 20",
    "AccountState": "sample string 21",
    "AccountZipCode": "sample string 22",
    "AccountCountry": "sample string 23",
    "AccountEmail": "sample string 24",
    "AccountPhone": "sample string 25",
    "AccountTypeId": 1,
    "Website": {},
    "PrimaryContactId": {},
    "FBUrl": {},
    "GooglePlaceId": {},
    "MySiteUrl": {},
    "IsSpectrumAvailable": 1,
    "IsVSPAvailable": 1,
    "IsWirelessAvailable": 1,
    "IsXyzPaysAvailable": 1,
    "IsXyzReviewsAvailable": 1,
    "SpectrumAccountStatus": 1,
    "SpectrumTrendId": 1,
    "XyzReviewsOrderDate": "2025-11-01T23:57:34.4464929+00:00",
    "XyzReviewsOrderId": "sample string 31",
    "AccountCreatedOn": "2025-11-01T23:57:34.4464929+00:00",
    "ACCountModifiedOn": "2025-11-01T23:57:34.4464929+00:00",
    "CMPCreatedOn": "2025-11-01T23:57:34.4464929+00:00",
    "IsXYZReviewsAccount": true,
    "IsCRMAvailable": true,
    "XYZReviewsProductName": "sample string 32",
    "XYZReviewsPaymentMethod": "sample string 33",
    "SubscriptionEndDate": "2025-11-01T23:57:34.4464929+00:00",
    "SubscriptionCancelDate": "2025-11-01T23:57:34.4464929+00:00",
    "Subscriptionprice": 1.0,
    "XYZRetailerId": {},
    "PassKey": "sample string 35",
    "B2CRole": "sample string 36"
  },
  "ProfileImageUrl": "sample string 22",
  "AccountId": "3ae02abd-51a9-4928-bdc5-6b8386a5cc41",
  "ContactId": "682d1c2e-7317-46de-9675-512abfcfd45e",
  "AuthResponse": {
    "Id": "sample string 1",
    "Token": "sample string 2",
    "RefreshToken": "sample string 3"
  }
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.