Retrieve a Profile
Will retrieve the profile object
GET
/v1/{access-token}/profile
use \FormSynergy\Init as FS;
$api = FS::Api();
$api->Get('profile')
->Where([
'profileid' => $profileid
])
->As('GetProfile');
{
"profileid": "profile-3be1fa342a520cbdf28aa43ab8edefee",
"email": "myemail@demo.interactionapi.com",
"address": "333 Example Street",
"city": "Los Angeles",
"companyname": "Company Name",
"state": "CA",
"zip": "90000",
"phone": "000 000 0000",
"lname": "Polo",
"fname": "Marco",
"resellerid": "reseller-3be1fa342a520cbdf28aa43ab8edefee",
"country": "United States"
}
Update a Profile
GET
/v1/{access-token}/profile
use \FormSynergy\Init as FS;
$api = FS::Api();
$api->Get('profile')
->Where([
'profileid' => $profileid
])->Update([
'companyname' => 'XYZ Company'
])
->As('UpdateProfile');
{
"companyname": "XYZ Company"
}
Attributes
profileid
string
Unique identifier for the profile object.
resellerid
string
Unique identifier for the reseller object.
email
string
Email address associated with the profile.
phone
string
Phone number associated with the profile.
companyname
string
Company name associated with the profile.
fname
string
Account owner's first name.
lname
string
Account owner's last name.
country
string
Account owner's billing country.
state
string
Account owner's billing state.
city
string
Account owner's billing city.
zip
string
Account owner's billing postal code.
address
string
Account owner's billing address.