InteractionschemasService
A list of all methods in the InteractionschemasService service. Click on the method name to view detailed information about that method.
| Methods | Description |
|---|---|
| interaction_schema_get_interaction_schemas | Retrieve all InteractionSchemas. |
| interaction_schema_create_interaction_schema | Create a new InteractionSchema. |
| interaction_schema_get_interaction_schema | Retrieve a specific InteractionSchema by providing the schemaId. |
| interaction_schema_delete_interaction_schema | Delete InteractionSchema by providing the schemaId. |
interaction_schema_get_interaction_schemas
Retrieve all InteractionSchemas.
- HTTP Method:
GET - Endpoint:
/api/v2/interactionschemas
Return Type
List[InteractionSchemaWithoutJsonModel]
Example Usage Code Snippet
from voyado_engage import VoyadoEngage, Environment
sdk = VoyadoEngage(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value
)
result = sdk.interactionschemas.interaction_schema_get_interaction_schemas()
print(result)
interaction_schema_create_interaction_schema
Create a new InteractionSchema.
- HTTP Method:
POST - Endpoint:
/api/v2/interactionschemas
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| request_body | any | ✅ | The request body. |
Return Type
InteractionSchemaResponse
Example Usage Code Snippet
from voyado_engage import VoyadoEngage, Environment
from voyado_engage.models import any
sdk = VoyadoEngage(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value
)
request_body = ""
result = sdk.interactionschemas.interaction_schema_create_interaction_schema(request_body=request_body)
print(result)
interaction_schema_get_interaction_schema
Retrieve a specific InteractionSchema by providing the schemaId.
- HTTP Method:
GET - Endpoint:
/api/v2/interactionschemas/{interactionSchemaId}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| interaction_schema_id | str | ✅ |
Return Type
InteractionSchemaModel
Example Usage Code Snippet
from voyado_engage import VoyadoEngage, Environment
sdk = VoyadoEngage(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value
)
result = sdk.interactionschemas.interaction_schema_get_interaction_schema(interaction_schema_id="interactionSchemaId")
print(result)
interaction_schema_delete_interaction_schema
Delete InteractionSchema by providing the schemaId.
- HTTP Method:
DELETE - Endpoint:
/api/v2/interactionschemas/{interactionSchemaId}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| interaction_schema_id | str | ✅ |
Example Usage Code Snippet
from voyado_engage import VoyadoEngage, Environment
sdk = VoyadoEngage(
access_token="YOUR_ACCESS_TOKEN",
base_url=Environment.DEFAULT.value
)
result = sdk.interactionschemas.interaction_schema_delete_interaction_schema(interaction_schema_id="interactionSchemaId")
print(result)
Build Your Own SDKs with liblab
Build developer friendly SDKs in minutes from your APIs