AutomationService
A list of all methods in the AutomationService service. Click on the method name to view detailed information about that method.
| Methods | Description |
|---|---|
| custom_triggers_trigger_by_contact_id | |
| custom_triggers_trigger_by_social_security_number | |
| custom_triggers_trigger_by_external_contact_id | |
| custom_triggers_trigger_by_contact_type_and_key |
custom_triggers_trigger_by_contact_id
- HTTP Method:
POST - Endpoint:
/api/v2/automation/customTriggers/{triggerId}/triggerByContactId/{contactId}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| request_body | dict | ✅ | The request body. |
| trigger_id | str | ✅ | |
| contact_id | str | ✅ |
Return Type
dict
Example Usage Code Snippet
from voyado_engage import VoyadoEngage, Environment
from voyado_engage.models import dict
sdk = VoyadoEngage(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value
)
request_body = {}
result = sdk.automation.custom_triggers_trigger_by_contact_id(
request_body=request_body,
trigger_id="triggerId",
contact_id="contactId"
)
print(result)
custom_triggers_trigger_by_social_security_number
- HTTP Method:
POST - Endpoint:
/api/v2/automation/customTriggers/{triggerId}/triggerBySocialSecurityNumber/{ssn}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| request_body | dict | ✅ | The request body. |
| trigger_id | str | ✅ | |
| ssn | str | ✅ |
Return Type
dict
Example Usage Code Snippet
from voyado_engage import VoyadoEngage, Environment
from voyado_engage.models import dict
sdk = VoyadoEngage(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value
)
request_body = {}
result = sdk.automation.custom_triggers_trigger_by_social_security_number(
request_body=request_body,
trigger_id="triggerId",
ssn="ssn"
)
print(result)
custom_triggers_trigger_by_external_contact_id
- HTTP Method:
POST - Endpoint:
/api/v2/automation/customTriggers/{triggerId}/triggerByExternalContactId/{externalId}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| request_body | dict | ✅ | The request body. |
| trigger_id | str | ✅ | |
| external_id | str | ✅ |
Return Type
dict
Example Usage Code Snippet
from voyado_engage import VoyadoEngage, Environment
from voyado_engage.models import dict
sdk = VoyadoEngage(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value
)
request_body = {}
result = sdk.automation.custom_triggers_trigger_by_external_contact_id(
request_body=request_body,
trigger_id="triggerId",
external_id="externalId"
)
print(result)
custom_triggers_trigger_by_contact_type_and_key
- HTTP Method:
POST - Endpoint:
/api/v2/automation/customTriggers/{triggerId}/triggerByContactTypeAndKey/{contactType}/{keyValue}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| request_body | dict | ✅ | The request body. |
| trigger_id | str | ✅ | |
| contact_type | str | ✅ | |
| key_value | str | ✅ |
Return Type
dict
Example Usage Code Snippet
from voyado_engage import VoyadoEngage, Environment
from voyado_engage.models import dict
sdk = VoyadoEngage(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value
)
request_body = {}
result = sdk.automation.custom_triggers_trigger_by_contact_type_and_key(
request_body=request_body,
trigger_id="triggerId",
contact_type="contactType",
key_value="keyValue"
)
print(result)
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs