PUT api/agent

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
agentId	integer	None.
memberType	DirectoryMemberType	None.
facebookId	string	Required
AccessToken	string	Required
CoverPhotoURL	string	None.
BrokerageURL	string	None.
PreferencesURL	string	None.
DateRegistered	date	None.
DateOfBirth	date	None.
Locale	string	None.
Gender	string	None.
profile_image	string	None.
profile_video	string	None.
firstName	string	Required
lastName	string	Required
email	string	Required
phone	string	None.
position_title	string	None.
year_licensed	integer	None.
license_type	string	None.
agent_type	string	None.
headline	string	None.
motto	string	None.
about	string	None.
services	string	None.
stateLicenseNumber	string	None.
website	string	None.
instagramUrl	string	None.
youtubeUrl	string	None.
googleUrl	string	None.
twitterUrl	string	None.
linkedinUrl	string	None.
pinterestUrl	string	None.
facebookUrl	string	None.
disclosures	string	None.
interests	string	None.
Score	integer	None.
SignupCompleted	date	None.
READBonusExpirationDate	date	None.
READReferrerPageName	string	None.
completedBasicProfile	boolean	None.
associationId	integer	None.
READReleaseViewDate	date	None.
READReferrerFbPageId	integer	None.
NRDSID	string	None.
mlsOrgId	string	None.
mlsAgentId	string	None.
mlsOfficeId	string	None.
mlsActive	string	None.
zips	Collection of string	None.
serviceAreas	Collection of ServiceAreaModel	None.
asapBalance	AsapBalanceModel	None.
budget	decimal number	None.
budgetUpdateDate	date	None.
balance	decimal number	None.
creditsBalance	decimal number	None.
budgetType	byte	None.
balanceRenewDay	byte	None.
asapActivationDate	date	None.
asapStatus	byte	None.
optimizeBids	boolean	None.
expertise	Collection of FocalAreaModel	None.
languages	Collection of Language	None.
credentials	Collection of CredentialModel	None.
association	AssociationModel	None.
displayRealtorIcon	boolean	None.
agentDirectoryPageId	string	None.
agentFeaturedlistingsPageId	string	None.
agentProfilePageId	string	None.
agentPropertySearchPageId	string	None.
updateIndex	string	None.
customURL	string	None.
awards	Collection of AgentAwardModel	None.
publications	Collection of AgentPublicationModel	None.
organizations	Collection of AgentOrganizationModel	None.
education	Collection of AgentEducationModel	None.
grantedFriendsPermission	boolean	None.
isSearchAllianceMember	boolean	None.
IsSearchAllianceInvited	boolean	None.
smsPhone	string	None.
enableSMS	boolean	None.
enableMyListingsSMS	boolean	None.
isSMSPhoneValidated	boolean	None.
isImpersonated	boolean	None.
additionalInformation	AgentDerivedModel	None.
mobileAppNotificationOn	boolean	None.
listingImportedDateTime	date	None.
homeSearchRegisteredDateTime	date	None.
appReauthorizeRequiredDate	date	None.
additionalTextForPosts	string	None.
accountInReview	boolean	None.
productServices	Collection of string	None.
saLeadChargeFailed	boolean	None.
readInviteOptIn	boolean	None.
agentSettings	Collection of AgentSetting	None.
verifiedAgent	boolean	None.
agentProfilePostMessage	string	None.
privacyPolicyUrl	string	None.
country	string	None.
hasReferredOtherAgents	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "agentId": 1,
  "memberType": 1,
  "facebookId": "sample string 2",
  "AccessToken": "sample string 3",
  "CoverPhotoURL": "sample string 4",
  "BrokerageURL": "sample string 5",
  "PreferencesURL": "sample string 6",
  "DateRegistered": "2024-12-21T16:21:04.6195539+00:00",
  "DateOfBirth": "2024-12-21T16:21:04.6195539+00:00",
  "Locale": "sample string 7",
  "Gender": "sample string 8",
  "profile_image": "sample string 9",
  "profile_video": "sample string 10",
  "firstName": "sample string 11",
  "lastName": "sample string 12",
  "email": "sample string 13",
  "phone": "sample string 14",
  "position_title": "sample string 15",
  "year_licensed": 1,
  "license_type": "sample string 16",
  "agent_type": "sample string 17",
  "headline": "sample string 18",
  "motto": "sample string 19",
  "about": "sample string 20",
  "services": "sample string 21",
  "stateLicenseNumber": "sample string 22",
  "website": "sample string 23",
  "instagramUrl": "sample string 24",
  "youtubeUrl": "sample string 25",
  "googleUrl": "sample string 26",
  "twitterUrl": "sample string 27",
  "linkedinUrl": "sample string 28",
  "pinterestUrl": "sample string 29",
  "facebookUrl": "sample string 30",
  "disclosures": "sample string 31",
  "interests": "sample string 32",
  "Score": 33,
  "SignupCompleted": "2024-12-21T16:21:04.6195539+00:00",
  "READBonusExpirationDate": "2024-12-21T16:21:04.6195539+00:00",
  "READReferrerPageName": "sample string 34",
  "completedBasicProfile": true,
  "associationId": 1,
  "READReleaseViewDate": "2024-12-21T16:21:04.6195539+00:00",
  "READReferrerFbPageId": 36,
  "NRDSID": "sample string 37",
  "mlsOrgId": "sample string 38",
  "mlsAgentId": "sample string 39",
  "mlsOfficeId": "sample string 40",
  "mlsActive": "sample string 41",
  "zips": [
    "sample string 1",
    "sample string 2"
  ],
  "serviceAreas": [
    {
      "GeoShape": {
        "coordinates": [
          1.1,
          2.1
        ],
        "radius": "sample string 1",
        "Type": "sample string 2"
      },
      "Center": null,
      "Bid": 1.0
    },
    {
      "GeoShape": {
        "coordinates": [
          1.1,
          2.1
        ],
        "radius": "sample string 1",
        "Type": "sample string 2"
      },
      "Center": null,
      "Bid": 1.0
    }
  ],
  "asapBalance": {
    "balance": 1.0,
    "creditsBalance": 1.0,
    "cashBalance": 1.0,
    "freeLeads": 64
  },
  "budget": 1.0,
  "budgetUpdateDate": "2024-12-21T16:21:04.6351294+00:00",
  "balance": 1.0,
  "creditsBalance": 1.0,
  "budgetType": 64,
  "balanceRenewDay": 64,
  "asapActivationDate": "2024-12-21T16:21:04.6351294+00:00",
  "asapStatus": 64,
  "optimizeBids": true,
  "expertise": [
    {
      "id": 1,
      "area": "sample string 2",
      "description": "sample string 3"
    },
    {
      "id": 1,
      "area": "sample string 2",
      "description": "sample string 3"
    }
  ],
  "languages": [
    {
      "LanguageId": 1,
      "Name": "sample string 2",
      "LanguageCode": "sample string 3",
      "Active": true
    },
    {
      "LanguageId": 1,
      "Name": "sample string 2",
      "LanguageCode": "sample string 3",
      "Active": true
    }
  ],
  "credentials": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Logo": "sample string 3"
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Logo": "sample string 3"
    }
  ],
  "association": {
    "address": "sample string 1",
    "associationName": "sample string 2",
    "city": "sample string 3",
    "contactEmail": "sample string 4",
    "contactName": "sample string 5",
    "email": "sample string 6",
    "id": 7,
    "logoLink": "sample string 8",
    "phoneNumber": "sample string 9",
    "stateCode": "sample string 10",
    "tagline": "sample string 11",
    "zip": "sample string 12"
  },
  "displayRealtorIcon": true,
  "agentDirectoryPageId": "sample string 43",
  "agentFeaturedlistingsPageId": "sample string 44",
  "agentProfilePageId": "sample string 45",
  "agentPropertySearchPageId": "sample string 46",
  "updateIndex": "sample string 47",
  "customURL": "sample string 48",
  "awards": [
    {
      "Id": 1,
      "Title": "sample string 2",
      "Description": "sample string 3",
      "Date": "2024-12-21T16:21:04.6351294+00:00",
      "AgentId": 5
    },
    {
      "Id": 1,
      "Title": "sample string 2",
      "Description": "sample string 3",
      "Date": "2024-12-21T16:21:04.6351294+00:00",
      "AgentId": 5
    }
  ],
  "publications": [
    {
      "Id": 1,
      "Publication": "sample string 2",
      "Title": "sample string 3",
      "Description": "sample string 4",
      "Url": "sample string 5",
      "Date": "2024-12-21T16:21:04.6351294+00:00",
      "AgentId": 7
    },
    {
      "Id": 1,
      "Publication": "sample string 2",
      "Title": "sample string 3",
      "Description": "sample string 4",
      "Url": "sample string 5",
      "Date": "2024-12-21T16:21:04.6351294+00:00",
      "AgentId": 7
    }
  ],
  "organizations": [
    {
      "Id": 1,
      "Title": "sample string 2",
      "Description": "sample string 3",
      "AgentId": 4
    },
    {
      "Id": 1,
      "Title": "sample string 2",
      "Description": "sample string 3",
      "AgentId": 4
    }
  ],
  "education": [
    {
      "Id": 1,
      "Name": "sample string 2",
      "Qualification": "sample string 3",
      "Year": 4,
      "Major": "sample string 5",
      "AgentId": 6
    },
    {
      "Id": 1,
      "Name": "sample string 2",
      "Qualification": "sample string 3",
      "Year": 4,
      "Major": "sample string 5",
      "AgentId": 6
    }
  ],
  "grantedFriendsPermission": true,
  "isSearchAllianceMember": true,
  "IsSearchAllianceInvited": true,
  "smsPhone": "sample string 51",
  "enableSMS": true,
  "enableMyListingsSMS": true,
  "isSMSPhoneValidated": true,
  "isImpersonated": true,
  "additionalInformation": {
    "lastLoggedIn": "2024-12-21T16:21:04.6351294+00:00",
    "memberSince": "2024-12-21T16:21:04.6351294+00:00",
    "idxAgentSince": "2024-12-21T16:21:04.6351294+00:00",
    "hasSearchAlliance": true
  },
  "mobileAppNotificationOn": true,
  "listingImportedDateTime": "2024-12-21T16:21:04.6351294+00:00",
  "homeSearchRegisteredDateTime": "2024-12-21T16:21:04.6351294+00:00",
  "appReauthorizeRequiredDate": "2024-12-21T16:21:04.6351294+00:00",
  "additionalTextForPosts": "sample string 53",
  "accountInReview": true,
  "productServices": [
    "sample string 1",
    "sample string 2"
  ],
  "saLeadChargeFailed": true,
  "readInviteOptIn": true,
  "agentSettings": [
    {
      "AgentId": 1,
      "Key": "sample string 2",
      "Value": "sample string 3",
      "IsPublic": true
    },
    {
      "AgentId": 1,
      "Key": "sample string 2",
      "Value": "sample string 3",
      "IsPublic": true
    }
  ],
  "verifiedAgent": true,
  "agentProfilePostMessage": "sample string 55",
  "privacyPolicyUrl": "sample string 56",
  "country": "sample string 57",
  "hasReferredOtherAgents": true
}

text/html

Sample:

{"agentId":1,"memberType":1,"facebookId":"sample string 2","AccessToken":"sample string 3","CoverPhotoURL":"sample string 4","BrokerageURL":"sample string 5","PreferencesURL":"sample string 6","DateRegistered":"2024-12-21T16:21:04.6195539+00:00","DateOfBirth":"2024-12-21T16:21:04.6195539+00:00","Locale":"sample string 7","Gender":"sample string 8","profile_image":"sample string 9","profile_video":"sample string 10","firstName":"sample string 11","lastName":"sample string 12","email":"sample string 13","phone":"sample string 14","position_title":"sample string 15","year_licensed":1,"license_type":"sample string 16","agent_type":"sample string 17","headline":"sample string 18","motto":"sample string 19","about":"sample string 20","services":"sample string 21","stateLicenseNumber":"sample string 22","website":"sample string 23","instagramUrl":"sample string 24","youtubeUrl":"sample string 25","googleUrl":"sample string 26","twitterUrl":"sample string 27","linkedinUrl":"sample string 28","pinterestUrl":"sample string 29","facebookUrl":"sample string 30","disclosures":"sample string 31","interests":"sample string 32","Score":33,"SignupCompleted":"2024-12-21T16:21:04.6195539+00:00","READBonusExpirationDate":"2024-12-21T16:21:04.6195539+00:00","READReferrerPageName":"sample string 34","completedBasicProfile":true,"associationId":1,"READReleaseViewDate":"2024-12-21T16:21:04.6195539+00:00","READReferrerFbPageId":36,"NRDSID":"sample string 37","mlsOrgId":"sample string 38","mlsAgentId":"sample string 39","mlsOfficeId":"sample string 40","mlsActive":"sample string 41","zips":["sample string 1","sample string 2"],"serviceAreas":[{"GeoShape":{"coordinates":[1.1,2.1],"radius":"sample string 1","Type":"sample string 2"},"Center":null,"Bid":1.0},{"GeoShape":{"coordinates":[1.1,2.1],"radius":"sample string 1","Type":"sample string 2"},"Center":null,"Bid":1.0}],"asapBalance":{"balance":1.0,"creditsBalance":1.0,"cashBalance":1.0,"freeLeads":64},"budget":1.0,"budgetUpdateDate":"2024-12-21T16:21:04.6351294+00:00","balance":1.0,"creditsBalance":1.0,"budgetType":64,"balanceRenewDay":64,"asapActivationDate":"2024-12-21T16:21:04.6351294+00:00","asapStatus":64,"optimizeBids":true,"expertise":[{"id":1,"area":"sample string 2","description":"sample string 3"},{"id":1,"area":"sample string 2","description":"sample string 3"}],"languages":[{"LanguageId":1,"Name":"sample string 2","LanguageCode":"sample string 3","Active":true},{"LanguageId":1,"Name":"sample string 2","LanguageCode":"sample string 3","Active":true}],"credentials":[{"Id":1,"Name":"sample string 2","Logo":"sample string 3"},{"Id":1,"Name":"sample string 2","Logo":"sample string 3"}],"association":{"address":"sample string 1","associationName":"sample string 2","city":"sample string 3","contactEmail":"sample string 4","contactName":"sample string 5","email":"sample string 6","id":7,"logoLink":"sample string 8","phoneNumber":"sample string 9","stateCode":"sample string 10","tagline":"sample string 11","zip":"sample string 12"},"displayRealtorIcon":true,"agentDirectoryPageId":"sample string 43","agentFeaturedlistingsPageId":"sample string 44","agentProfilePageId":"sample string 45","agentPropertySearchPageId":"sample string 46","updateIndex":"sample string 47","customURL":"sample string 48","awards":[{"Id":1,"Title":"sample string 2","Description":"sample string 3","Date":"2024-12-21T16:21:04.6351294+00:00","AgentId":5},{"Id":1,"Title":"sample string 2","Description":"sample string 3","Date":"2024-12-21T16:21:04.6351294+00:00","AgentId":5}],"publications":[{"Id":1,"Publication":"sample string 2","Title":"sample string 3","Description":"sample string 4","Url":"sample string 5","Date":"2024-12-21T16:21:04.6351294+00:00","AgentId":7},{"Id":1,"Publication":"sample string 2","Title":"sample string 3","Description":"sample string 4","Url":"sample string 5","Date":"2024-12-21T16:21:04.6351294+00:00","AgentId":7}],"organizations":[{"Id":1,"Title":"sample string 2","Description":"sample string 3","AgentId":4},{"Id":1,"Title":"sample string 2","Description":"sample string 3","AgentId":4}],"education":[{"Id":1,"Name":"sample string 2","Qualification":"sample string 3","Year":4,"Major":"sample string 5","AgentId":6},{"Id":1,"Name":"sample string 2","Qualification":"sample string 3","Year":4,"Major":"sample string 5","AgentId":6}],"grantedFriendsPermission":true,"isSearchAllianceMember":true,"IsSearchAllianceInvited":true,"smsPhone":"sample string 51","enableSMS":true,"enableMyListingsSMS":true,"isSMSPhoneValidated":true,"isImpersonated":true,"additionalInformation":{"lastLoggedIn":"2024-12-21T16:21:04.6351294+00:00","memberSince":"2024-12-21T16:21:04.6351294+00:00","idxAgentSince":"2024-12-21T16:21:04.6351294+00:00","hasSearchAlliance":true},"mobileAppNotificationOn":true,"listingImportedDateTime":"2024-12-21T16:21:04.6351294+00:00","homeSearchRegisteredDateTime":"2024-12-21T16:21:04.6351294+00:00","appReauthorizeRequiredDate":"2024-12-21T16:21:04.6351294+00:00","additionalTextForPosts":"sample string 53","accountInReview":true,"productServices":["sample string 1","sample string 2"],"saLeadChargeFailed":true,"readInviteOptIn":true,"agentSettings":[{"AgentId":1,"Key":"sample string 2","Value":"sample string 3","IsPublic":true},{"AgentId":1,"Key":"sample string 2","Value":"sample string 3","IsPublic":true}],"verifiedAgent":true,"agentProfilePostMessage":"sample string 55","privacyPolicyUrl":"sample string 56","country":"sample string 57","hasReferredOtherAgents":true}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'NPlay.Common.Geometry.GeoPoint' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'NPlay.Common.Geometry.GeoPoint' cannot be serialized. Consider marking it with the DataContractAttribute attribute, and marking all of its members you want serialized with the DataMemberAttribute attribute. If the type is a collection, consider marking it with the CollectionDataContractAttribute. See the Microsoft .NET Framework documentation for other supported types.

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AgentModel'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.