ContactoverviewService

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

Methods	Description
contact_overview_get_contact_overview_async	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. |

contact_overview_get_contact_overview_async

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
contact_type	str	❌
contact_id	str	❌
email	str	❌
social_security_number	str	❌
mobile_phone	str	❌
custom_key	str	❌
any	str	❌

Return Type

dict

Example Usage Code Snippet

from voyado_engage import VoyadoEngage, Environment

sdk = VoyadoEngage(
    access_token="YOUR_ACCESS_TOKEN",
    base_url=Environment.DEFAULT.value
)

result = sdk.contactoverview.contact_overview_get_contact_overview_async(
    contact_type="contactType",
    contact_id="contactId",
    email="email",
    social_security_number="socialSecurityNumber",
    mobile_phone="mobilePhone",
    custom_key="customKey",
    any="any"
)

print(result)

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →