Skip to main content

Contact User

Re-enable contact for a specific application/lead that was previously marked as "Do Not Contact".

Endpoint

Staging

POST https://missioncapital--full.sandbox.my.salesforce.com/services/apexrest/creditapp/contactUser

Production

POST https://missioncapital.my.salesforce.com/services/apexrest/creditapp/contactUser

Headers

HeaderValue
AuthorizationBearer YOUR_ACCESS_TOKEN
Content-Typeapplication/json
PartnerIdYOUR_PARTNER_ID
PartnerNameYOUR_PARTNER_NAME
ApplicationIDSALESFORCE_LEAD_ID

Request Body

This endpoint does not require a request body. All necessary information is provided in the headers.

Sample Request

POST https://missioncapital--full.sandbox.my.salesforce.com/services/apexrest/creditapp/contactUser
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json
PartnerId: YOUR_PARTNER_ID
PartnerName: YOUR_PARTNER_NAME
ApplicationID: 00QEa00000ItVf8MAF

Note: This endpoint does not require a JSON request body. All necessary information is provided in the headers.

Sample Response

Successful Response

{
"IsSuccessful": true,
"ResponseText": "Application has been updated successfully"
}

Error Response

{
"IsSuccessful": false,
"ResponseText": "Application not found"
}

Response Fields

FieldTypeDescription
IsSuccessfulbooleanWhether the request was successful
ResponseTextstringHuman-readable response message

Use Cases

This endpoint is useful when:

  • A lead was previously marked as "Do Not Contact" but now wants to be contacted
  • You need to re-enable communication for a specific application
  • A lead has changed their mind about receiving contact

Error Scenarios

Common error responses include:

  • Missing ApplicationID: "Missing Application ID"
  • Application not found: "Application not found"
  • Invalid authentication: "Invalid username and password"
  • Missing headers: "Invalid Request Header. PartnerName or PartnerId parameters are missing."

Integration Notes

  1. ApplicationID Required - The ApplicationID header must contain a valid Salesforce Lead ID
  2. Authentication Required - Ensure your Bearer token, PartnerId, and PartnerName are valid
  3. Idempotency - Calling this endpoint multiple times on the same application is safe
  4. Lead Status - This endpoint will update the lead's contact preferences and may reassign ownership