Creates a External Member in our system.

Endpoint URL

http://api.clearvoicesurveys.com/api/v1/member/createexternalmember

Parameters

ExternalMemberId
string		 The identifier of this member in the external system it is from.

Required
EmailAddress
string		 EmailAddress for the member you will be creating.

Matching regular expression pattern: ^(?:[a-zA-Z0-9!#$%&'\*\+\-\/=\?\^_`\{\|\}~])+(?:\.([a-zA-Z0-9!#$%&'\*\+\-\/=\?\^_`\{\|\}~])+)*@(?<domain>(?:(?:(?:[a-zA-Z0-9]{1,63})|(?:[a-zA-Z0-9](?:[a-zA-Z0-9\-]){0,61}[a-zA-Z0-9]))\.)+(?i:com|net|org|edu|aero|asia|biz|cat|coop|gov|info|int|jobs|mil|mobi|museum|name|pro|tel|travel|xxx|ac|ad|ae|af|ag|ai|al|am|an|ao|aq|ar|as|at|au|aw|ax|az|ba|bb|bd|be|bf|bg|bh|bi|bj|bm|bn|bo|br|bs|bt|bv|bw|by|bz|ca|cc|cd|cf|cg|ch|ci|ck|cl|cm|cn|co|cr|cs|cu|cv|cx|cy|cz|de|dj|dk|dm|do|dz|ec|ee|eg|eh|er|es|et|eu|fi|fj|fk|fm|fo|fr|ga|gb|gd|ge|gf|gg|gh|gi|gl|gm|gn|gp|gq|gr|gs|gt|gu|gw|gy|hk|hm|hn|hr|ht|hu|id|ie|il|im|in|io|iq|ir|is|it|je|jm|jo|jp|ke|kg|kh|ki|km|kn|kp|kr|kw|ky|kz|la|lb|lc|li|lk|lr|ls|lt|lu|lv|ly|ma|mc|md|me|mg|mh|mk|ml|mm|mn|mo|mp|mq|mr|ms|mt|mu|mv|mw|mx|my|mz|na|nc|ne|nf|ng|ni|nl|no|np|nr|nu|nz|om|pa|pe|pf|pg|ph|pk|pl|pm|pn|pr|ps|pt|pw|py|qa|re|ro|rs|ru|rw|sa|sb|sc|sd|se|sg|sh|si|sj|sk|sl|sm|sn|so|sr|st|su|sv|sy|sz|tc|td|tf|tg|th|tj|tk|tl|tm|tn|to|tp|tr|tt|tv|tw|tz|ua|ug|uk|um|us|uy|uz|va|vc|ve|vg|vi|vn|vu|wf|ws|ye|yt|yu|za|zm|zr|zw))$
Title
string		 The members Title. This is not actually stored in our system but is used to help verify a persons gender.
FirstName
string		 The members FirstName.

Required
LastName
string		 The members LastName.
MiddleName
string		 The members MiddleName
Gender
string		 The members gender (Male | Female)

Required
DateOfBirth
date		 Date the member was born.
Password
string		 Member's password that will be used for panel website login.
Address1
string		 First line of the members home address.
Address2
string		 Second line of the members home address.
City
string		 City of the members home address.
StateAbbrv
string		 State Abbreviation of the members home address.
ZipCode
string		 ZipCode of the members home address.
Country
string		 Country of the members home address.
LanguagePreference
string		 Language preferred by the member. Current supported values for this field are: en-us, french, fr, or fr-ca. If nothing is provided this will default to en-us.
Campaign
string		 Campaign the user to be created was sourced from.
AdGroup
string		 AdGroup the user to be created was sourced from.
Ad
string		 Ad the user to be created was sourced from.
IpAddress
string		 The members primary IpAddress.
ChildBirthDate
date		 Members child's birthdate.
RegistrationQueryString
string		 Registration query string associated with member's registration. Used for tracking where the user to be created was sourced from.

Example Request Data

{
  "ExternalMemberId": "sample string 1",
  "EmailAddress": "sample string 2",
  "Title": "sample string 3",
  "FirstName": "sample string 4",
  "LastName": "sample string 5",
  "MiddleName": "sample string 6",
  "Gender": "sample string 7",
  "DateOfBirth": "2025-12-12T19:44:36.6536105-05:00",
  "Password": "sample string 8",
  "Address1": "sample string 9",
  "Address2": "sample string 10",
  "City": "sample string 11",
  "StateAbbrv": "sample string 12",
  "ZipCode": "sample string 13",
  "Country": "sample string 14",
  "LanguagePreference": "sample string 15",
  "Campaign": "sample string 16",
  "AdGroup": "sample string 17",
  "Ad": "sample string 18",
  "IpAddress": "sample string 19",
  "ChildBirthDate": "2025-12-12T19:44:36.6536105-05:00",
  "RegistrationQueryString": "sample string 20"
}

Response Description

MemberGuid
string		 ClearVoice's unique identifier for a member.
ExternalMemberId
string		 Id of this member in a external system.

Example Response

{
  "MemberGuid": "sample string 1",
  "ExternalMemberId": "sample string 2"
}