ContactoverviewService

A list of all methods in the ContactoverviewService service. Click on the method name to view detailed information about that method.

Methods

Description

ContactOverview_GetContactOverviewAsync

Get all information about a single contact by specifying either: - contactId - email and contactType - socialSecurityNumber and contactType - mobilePhone and contactType - customKey and contactType (the customKey must be configured by your supplier) - any and contactType - the any field can contain email, socialSecurityNumber, mobilePhone or the custom key (and are checked in that order) The dynamic fields of the response depend on your current Voyado configuration.

ContactOverview_GetContactOverviewAsync

Get all information about a single contact by specifying either: - contactId - email and contactType - socialSecurityNumber and contactType - mobilePhone and contactType - customKey and contactType (the customKey must be configured by your supplier) - any and contactType - the any field can contain email, socialSecurityNumber, mobilePhone or the custom key (and are checked in that order) The dynamic fields of the response depend on your current Voyado configuration.

• HTTP Method: GET
• Endpoint: /api/v2/contactoverview

Parameters

Name	Type	Required	Description
contactType	string	❌
contactId	string	❌
email	string	❌
socialSecurityNumber	string	❌
mobilePhone	string	❌
customKey	string	❌
any	string	❌

Return Type

any

Example Usage Code Snippet

import { VoyadoEngage } from 'voyado_engage';

(async () => {
  const voyadoEngage = new VoyadoEngage({
    token: 'YOUR_TOKEN',
  });

  const { data } = await voyadoEngage.contactoverview.contactOverviewGetContactOverviewAsync({
    contactType: 'contactType',
    contactId: 'contactId',
    email: 'email',
    socialSecurityNumber: 'socialSecurityNumber',
    mobilePhone: 'mobilePhone',
    customKey: 'customKey',
    any: 'any',
  });

  console.log(data);
})();

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →