Contact Management Microservice
  • Dark
    Light
  • PDF

Contact Management Microservice

  • Dark
    Light
  • PDF

A list of APIs which are a part of Contact Management Microservices are listed here, alphabetically.


APIs

retrieveConsentHeirarchy

The purpose of this API service is to retrieve the consent scenarios hierarchy that is saved in the BLC.

createSelfCareUserForExistingContact

The purpose of this API service is to create the selfcare user for an existing contact.

expireUser

The purpose of this API service is to expire the SSO user and remove the association from contacts.

addAddress

The purpose of this API service is to add the address information.

patchAddress

The purpose of this API service is to update address information based on the address ID.

retrieveIndividualByIndividualId2

The purpose of this API service is to retrieve the individual information based on the individual ID.

patchIndividualByIndividualId

The purpose of this API service is to update the individual information based on the individual ID.

updateIndividualInfoBase

The purpose of this API service is to update the base individual information by the individual ID.

retrieveRolesByIndividualId

The purpose of this API service is to retrieve the roles of individual based on the individual ID.

createContact

The purpose of this API service is to create a contact.

createContactRole

The purpose of this API service is to create the contact role.

createIndividualRoles

The purpose of this API service is to create the contact roles.

createContactMediums

The purpose of this API service is to add the contact mediums to existing individual.

updateByCartId

The purpose of this API service is to update the individual information on NCA based on the cart ID.

createIndividualNCA

The purpose of this API service is to create the individual information on NCA.

retrieveIndividualByCartId

The purpose of this API service is to retrieve the individual owner information based on the cart ID.

retrieveContactsByAccount

The purpose of this API service is to retrieve the contacts of individual based on the account ID.

getPartyRoleSpecs

The purpose of this API service is to retrieve the enumerated contact roles.

updateContactStatusToForget

The purpose of this API service is to forget the contact.

retrieveContacts

The purpose of this API service is to retrieve the contacts of individual based on contact information.

updateContactMediumsWithConsent

The purpose of this API service is to add the contact medium consent to existing contact medium.

retrieveErasedContacts

The purpose of this API service is to retrieve the contacts of individual based on the contact information.

getContactMedium

The purpose of this API service is to retrieve the contact mediums of individual role based on the role specification type related entity ID and use type ID.

expireContactRoles

The purpose of this API service is to expire the contact roles.

expireIndividualRoles

The purpose of this API service is to expire individual roles based on the input payload.

setDefaultContactRole

The purpose of this API service is to configure the default contact role for an individual.

unsetDefaultContactRole

The purpose of this API service is to unset the default contact role for an individual.

retrieveCreditHistory

The purpose of this API service is to retrieve the score of the requested type of a contact.

individualScoreUpdate

The purpose of this API service is to insert the credit score for a contact.

getOTPContactMedium

The purpose of this API service is to retrieve the contact medium for account, contact, or service.

retrieveContactsByFilters

The purpose of this API service is to search for the contacts based on the filter passed in the query parameters.

retrieveExtendedData

The purpose of this API service is to retrieve the individual extended data by individual ID.

retrieveIndividualDetails

The purpose of this API service is to retrieve the individual details by the individual ID.

patchIndividualDetails

The purpose of this API service is to update the individual information based on the individual ID.

retrieveIndividualDetailsByCartId

The purpose of this API service is to retrieve the individual details by the cart ID.

updateIndividualDetailsByCartId

The purpose of this API service is to update the individual details based on the cart ID.

retrieveIndividualExtendedDataByCartId

The purpose of this API service is to retrieve the individual extended data by the individual ID.

updateIndividualExtendedDataByCartId

The purpose of this API service is to update the individual extended data based on the cart ID.

createOrganization

The purpose of this API service is to create an organization.

retrieveOrganization

The purpose of this API service is to retrieve the organization details.

roletraversal

The purpose of this API service is to reverse a customer's role.

patchOrganizationByOrganizationId

The purpose of this API service is to update the organization details.

patchOrganizationByIdAndRoleId

The purpose of this API service is to update the organization details based on the organization role ID.

expireStore

The purpose of this API service is to expire store or store group or organization.

roletransfer

The purpose of this API service is to transfer the account ownership.

roletransferWithConsents

The purpose of this API service is to expire and transfer the account ownership.

organizationRole

The purpose of this API service is to assign the role to a store, store group, or organization.

retrieveOrganizationByRoleId

The purpose of this API service is to retrieve the organization details based on the roles.

getRegionCode

The purpose of this API service is to retrieve an organization region code.

getOrganizationRoles

The purpose of this API service is to fetch the organization and organization roles based on the organization role ID.

updateContactCharacteristics

The purpose of this API service is to update the individual characteristics.

getCustomerCommunicationPreferences

The purpose of this API service is to retrieve the customer communication preferences.

validateOperation

The purpose of this API service is to validate the operation limit.

checkEligibilityForEnrollment

The purpose of this API service is to check the eligibility of a contact for enrollment.

geteligibleforenrollment

The purpose of this API service is to retrieve the details of a wrapper eligible for the enrollment.

mergeContacts

The purpose of this API service is to merge the contact.

getcontactmediumConsent

The purpose of this API service is to retrieve the customer communication preferences.

findNearbyOrganizationRolesByaddress

The purpose of this API service is to search the near by organization roles using address filters.

getIndividualRoleConsents

The purpose of this API service is to retrieve the data privacy consent management preferences for an account and the subscribers or MSISDNs which has data privacy.

retrieveDataPrivacyBySubscriber

The purpose of this API service is to retrieve the data privacy consent management preferences for a single subscribers or MSISDNs, which has data privacy.

setDataPrivacyBySubscriber

The purpose of this API service is to update the data privacy consent management preferences for a single subscribers or MSISDNs, which has data privacy.

createContactMediumConsent

The purpose of this API service is to insert a list of notification exemptions for a residential contact in the contact medium consent.

getTermsConditions

The purpose of this API service is to retrieve the terms and condition from the 3P system.

postgenerateOtp

The purpose of this API service is used for requesting the OTP for the user based on the input parameters.

createotpcommand

The purpose of this API service is used to create an OTP command in couchbase.

commandsendOTP

The purpose of this API service is used for requesting the OTP for the user based on command ID.

resendOTP

The purpose of this API service is to resend the OTP for the user based on the input parameters.

commandresendOTP

The purpose of this API service is to resend the OTP for the user based on the command.

validateOTP

The purpose of this API service is to verify the given OTP code by checking on the OPT side.

validateAndExecuteOTPCommand

The purpose of this API service is to validate the OTP API to accept the OTP command ID to validate my OTP code and execute the command.

Discover how we can help your Business

Get in touch with us today


Was this article helpful?