Sign in

v1

latestOpenAPI 3.0.4MIT2026-08-0417157271.9 KB
Lead

Create an email lead for a Member

post/v1/Lead/CreateLead

Query parameters

SuppressEmailboolean

Suppresses an email from being sent to the Realtor when set to true.

Request body

Culturestring required

The culture of the lead. Either en-CA or fr-CA. Default value is en-CA

MemberKeystring required

The key of the related member for this lead.

ListingKeystring required

The key of the related listing for this lead.

SenderNamestring required

The name of the lead.

SenderEmailAddressstring required

The email address of the lead.

SenderPhoneNumberinteger nullable

The phone number of the lead. Required if PrefferedMethodContact is phone or text or if SenderPhoneExtension has a value.

PreferredMethodContactstring required

The preffered method of contact for the lead. Either email, phone or text

SenderPhoneExtensioninteger nullable

The extension of the leads phone number.

Messagestring required

The leads message to the member. This field has a 500 character limit.

Example request

{
  "Culture": "en-CA",
  "MemberKey": "1234567",
  "ListingKey": "12345678",
  "SenderName": "SenderName",
  "SenderEmailAddress": "SenderEmailAddress@email.com",
  "SenderPhoneNumber": 1112223333,
  "PreferredMethodContact": "email",
  "SenderPhoneExtension": 4444,
  "Message": "Message"
}

Response

OK

detailsstring nullable
messagestring nullable
codestring nullable
successboolean