SPsponsorunited
Contact

Create a new contact

Creates a new person profile and links it to the specified entity (agency, property, brand, or sale). Handles profile picture upload and optional sale list assignment. Agency/property/brand contacts also accept service X-API-Key authentication. A request sent with an agent token may name the agent in X-Agent-Name; it is recorded on the contacts row and returned as created_by_agent.

post/api/contacts/{contactableEntity}/{contactableId}

Request

Path parameters

contactableEntitystring required

Type of an entity (agency, property, brand, sale)

contactableIdinteger required

Id of an entity

Headers

X-Agent-Namestring
Example:News Agent

Name of the agent making the change, for example News Agent. Recorded as created_by_agent / updated_by_agent only when the request carries an agent token; ignored otherwise. At most 100 characters.

Request body

namestring required
emailstring email
positionstring
profile_picturestring
work_phonestring
work_phone_extstring
email_statusstring
email_status_updatedboolean
manual_email_statusstring
manual_email_status_updated_atstring date-time
linkedinstring
facebookstring
twitterstring
instagramstring
notesstring
suggestedboolean
previous_suggestedboolean
linkedin_dataobject
contact_status_idinteger

Response

A new person profile linked to the given entity.

OR
OR
OR

Example response

{
  "linkedin_data": {
    "type": "agency|company|property"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.