Skip to main content

Class AddContactRequest

Properties

Field/Tag NameValueRequiredNotes
custServProviderIdYPartner Id
entity_idYMerchant Id
request_emailYRegistered at ProfitStars; email format
contact_typeOwner Director Officer Primary Contact Secondary Contact ComplianceY
contact_nameY
contact_titleY
contact_bus_phoneY
contact_bus_phone_extN
contact_bus_faxN
contact_emailN
contact_pinN
contact_address_same_as_entity'0' = False '1' = TrueY
contact_address_1NIf 'contact_address_same_as_entity ' = TRUE, then submitted value will be ignored
contact_address_2NIf 'contact_address_same_as_entity ' = TRUE, then submitted value will be ignored
contact_cityNIf 'contact_address_same_as_entity ' = TRUE, then submitted value will be ignored
contact_state_or_regionNIf 'contact_address_same_as_entity ' = TRUE, then submitted value will be ignored
contact_postal_codeNIf 'contact_address_same_as_entity ' = TRUE, then submitted value will be ignored
contact_enabledY
date_of_birthNYYYY-MM-DD
ssnNFormat: ###-##-####
dl_stateNRequired if ' dl_number ' is populated
dl_numberNRequired if ' dl_state ' is populated
residential_address_1N
residential_address_2N
residential_cityN
residential_state_or_regionN
residential_state_postal_codeN
subjectNtext(255)
descriptionNtext (long)
case_reasonUpdate Business InformationN

Example AddContactRequest

Input Method: XML

<xml>
<request_email>none@example.com</request_email>
<custServProviderId>######</custServProviderId>
<entity_id>######</entity_id>
<contact_type>Officer</contact_type>
<contact_name>John Doe</contact_name>
<contact_title>CEO</contact_title>
<contact_bus_phone>999-999-9999</contact_bus_phone>
<contact_bus_phone_ext>9999</contact_bus_phone_ext>
<contact_bus_fax>999-999-9999</contact_bus_fax>
<contact_email>none@example.com</contact_email>
<contact_pin>9999</contact_pin>
<contact_address_same_as_entity>0</contact_address_same_as_entity>
<contact_address_1>123 Main</contact_address_1>
<contact_address_2>STE 999</contact_address_2>
<contact_city>Dallas</contact_city>
<contact_state_or_region>TX</contact_state_or_region>
<contact_postal_code>75201</contact_postal_code>
<contact_enabled>1</contact_enabled>
<date_of_birth>1975-05-05</date_of_birth>
<ssn>###-##-####</ssn>
<dl_state>TX</dl_state>
<dl_number>99999999</dl_number>
<residential_address_1>456 Main</residential_address_1>
<residential_address_2></residential_address_2>
<residential_city>Dallas</residential_city>
<residential_state_or_region>TX</residential_state_or_region>
<residential_state_postal_code>75201</residential_state_postal_code>
<subject></subject>
<description></description>
<case_reason></case_reason>
</xml>

Input Method: JSON

{ 
"custServProviderId": "######",
"request_email": "none@example.com",
"entity_id": "######",
"contact_type": "Officer",
"contact_name": "John Doe",
"contact_title": "CEO",
"contact_bus_phone": "999-999-9999",
"contact_bus_phone_ext": "9999",
"contact_bus_fax": "999-999-9999",
"contact_email": "none@example.com",
"contact_pin": "9999",
"contact_address_same_as_entity": "0",
"contact_address_1": "123 Main",
"contact_address_2": "STE 999",
"contact_city": "Dallas",
"contact_state_or_region": "TX",
"contact_postal_code": "75201",
"contact_enabled": "1",
"date_of_birth": "1975-05-05",
"ssn": "###-##-####",
"dl_state": "TX",
"dl_number": "9999999",
"residential_address_1": "456 Main",
"residential_address_2": "",
"residential_city": "Dallas",
"residential_state_or_region": "TX",
"residential_state_postal_code": "75201",
"subject": "",
"description": "",
"case_reason": ""
}