NAV

<back to all web services

LeadUpgrade

The following routes are available for this service:
POST/upgrade-lead
LeadUpgrade Parameters:
NameParameterData TypeRequiredDescription
BeeNumberbodydecimalNo
EmailAddressbodystringNo
MentorBeeNumberbodydecimal?No
LanguagebodystringNo
BirthDatebodyDateTime?No
PrimaryPhonebodyNAVPhoneUpdateNo
AdditionalPhonebodyNAVPhoneUpdateNo
BillingAddressbodyNAVAddressUpdateNo
ShippingAddressbodyNAVAddressUpdateNo
GovernmentIdbodystringNo
TermsAgreementbodyNAVTermsUpdateNo
ElectronicAgreementbodyNAVTermsUpdateNo
AgentIdbodystringNo
KitNumberbodystringNo
KitPricebodydecimal?No
PaymentMethodbodystringNo
TaxAmountbodydecimal?No
DonationAmountbodydecimal?No
PublicityTagbodystringNo
EStoreUrlbodystringNo
ApptYYYYCCbodystringNo
ApptHHMMSSbodystringNo
ApptYYYYMMDDbodystringNo
PrivacyPolicyAgreementbodyNAVTermsUpdateNo
WebsiteTermsOfUseAgreementbodyNAVTermsUpdateNo
AgeVerificationAgreementbodyNAVTermsUpdateNo
CASLStatementAgreementbodyNAVCASLTermsUpdateNo
NAVPhoneUpdate Parameters:
NameParameterData TypeRequiredDescription
NumberformstringNo
ExtensionformstringNo
CodeIdPhoneTypeformstringNo
CountryCodeformstringNo
NAVAddressUpdate Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNo
LastNameformstringNo
AddressLine1formstringNo
AddressLine2formstringNo
AddressLine3formstringNo
AddressLine4formstringNo
AddressLine5formstringNo
CityformstringNo
StateCodeformstringNo
PostalCodeformstringNo
CountryCodeformstringNo
NAVTermsUpdate Parameters:
NameParameterData TypeRequiredDescription
VersionformstringNo
DateformDateTimeNo
NAVCASLTermsUpdate Parameters:
NameParameterData TypeRequiredDescription
AgreeformstringNo
DateformDateTimeNo
LeadUpgradeResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /upgrade-lead HTTP/1.1 
Host: extensions.avon.ca 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"beeNumber":0,"emailAddress":"String","mentorBeeNumber":0,"language":"String","birthDate":"0001-01-01T00:00:00.0000000","primaryPhone":{"number":"String","extension":"String","codeIdPhoneType":"String","countryCode":"String"},"additionalPhone":{"number":"String","extension":"String","codeIdPhoneType":"String","countryCode":"String"},"billingAddress":{"firstName":"String","lastName":"String","addressLine1":"String","addressLine2":"String","addressLine3":"String","addressLine4":"String","addressLine5":"String","city":"String","stateCode":"String","postalCode":"String","countryCode":"String"},"shippingAddress":{"firstName":"String","lastName":"String","addressLine1":"String","addressLine2":"String","addressLine3":"String","addressLine4":"String","addressLine5":"String","city":"String","stateCode":"String","postalCode":"String","countryCode":"String"},"governmentId":"String","termsAgreement":{"version":"String","date":"0001-01-01T00:00:00.0000000"},"electronicAgreement":{"version":"String","date":"0001-01-01T00:00:00.0000000"},"agentId":"String","kitNumber":"String","kitPrice":0,"paymentMethod":"String","taxAmount":0,"donationAmount":0,"publicityTag":"String","eStoreUrl":"String","apptYYYYCC":"String","apptHHMMSS":"String","apptYYYYMMDD":"String","privacyPolicyAgreement":{"version":"String","date":"0001-01-01T00:00:00.0000000"},"websiteTermsOfUseAgreement":{"version":"String","date":"0001-01-01T00:00:00.0000000"},"ageVerificationAgreement":{"version":"String","date":"0001-01-01T00:00:00.0000000"},"caslStatementAgreement":{"agree":"String","date":"0001-01-01T00:00:00.0000000"}}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}