MTmtn
salesLead

Creates a SalesLead

This operation creates a SalesLead entity.

post/lead

Request

Headers

transactionIdstring

transactionId

x-origin-channelIdstring

The SalesLead to be created

Request body

Example request

{
  "customerDetails": {
    "description": "new sales lead",
    "lastName": "Smith",
    "firstName": "John",
    "salutation": "Mr",
    "middleName": "New",
    "company": "MTN",
    "street": "new street",
    "city": "Durban",
    "state": "Durban",
    "postalCode": "543456",
    "country": "SouthAfrica",
    "latitude": "29.8587° S",
    "longitude": "31.0218° E",
    "phone": "27657876765",
    "mobileNumber": "27876678987",
    "email": "test@mtn.com",
    "website": "www.abc.com",
    "industry": "Telecom",
    "businessOrganizationType": "SME",
    "companyRegistration": "Sole owenership",
    "companySize": "Multilocation",
    "preferredCommunication": "email",
    "domainName": "@abc.com",
    "externalChannel": "WEBSITE",
    "notes": "details and information",
    "preferredContactSlot": "afternoon",
    "feasibilityDetails": "Feasibile",
    "feasibilityStatus": "eligible",
    "utmSource": "utmSource",
    "networkFeasibility": "Feasibile",
    "solutionType": "test",
    "sales": "sales",
    "segment": "sales",
    "region": "Durban",
    "opco": "SouthAfrica",
    "id": "2345676567",
    "idType": "RSA ID"
  },
  "productDetails": {
    "productServiceDescription": "Internet Service",
    "serviceRequiredPeriod": "12",
    "typeofProduct": "individual service",
    "productCode": "INT-1gbps"
  },
  "campaignDetails": {
    "campaignName": "new business campaign",
    "campaignType": "digital campaign",
    "campaignOwner": "sales team",
    "campaignPromotionId": "campaign-1A"
  },
  "leadDetails": {
    "leadSource": "customer enquiry",
    "leadOrigin": "IVR",
    "interactionReason": "new sales pitch",
    "leadReference": "sales one",
    "subSegment": "sales",
    "partnerName": "partner",
    "createdDate": "2019-08-23"
  }
}

Response

Created

statusCodestring

This is the MADAPI Canonical Error Code (it is 4 characters long and it is not the HTTP Status Code which is 3 characters long). Back-end system errors are mapped to specific canonical error codes which are returned. More information on these mappings can be found on the MADAPI Confluence Page 'Response Codes'

statusMessagestring

More details and corrective actions related to the error which can be shown to a client

supportMessagestring

Internal message meant for consumers of the API to troubleshoot the error (could possible include the back-end system error code in the message if it would be useful)

transactionIdstring

This is the same transactionId that is sent in the request

idstring

This is the Id generated by backend

Example response

{
  "statusCode": "0000",
  "statusMessage": "Success",
  "supportMessage": "Success",
  "transactionId": "0d1e1b18-1b6d-4792-8417-72d337f42a1c",
  "id": "0d1e1b18-1b6d-4792-8417-72d337f42a1c"
}

Changes

No recorded changes to this operation across all 1 revision of this API.