InteractionschemasService

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

Methods	Description
InteractionSchema_GetInteractionSchemas	Retrieve all InteractionSchemas.
InteractionSchema_CreateInteractionSchema	Create a new InteractionSchema.
InteractionSchema_GetInteractionSchema	Retrieve a specific InteractionSchema by providing the schemaId.
InteractionSchema_DeleteInteractionSchema	Delete InteractionSchema by providing the schemaId.

InteractionSchema_GetInteractionSchemas

Retrieve all InteractionSchemas.

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

Return Type

InteractionSchemaWithoutJsonModel[]

Example Usage Code Snippet

import { VoyadoEngage } from 'voyado_engage';

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

  const { data } = await voyadoEngage.interactionschemas.interactionSchemaGetInteractionSchemas();

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

InteractionSchema_CreateInteractionSchema

Create a new InteractionSchema.

• HTTP Method: POST
• Endpoint: /api/v2/interactionschemas

Parameters

Name	Type	Required	Description
body	any	✅	The request body.

Return Type

InteractionSchemaResponse

Example Usage Code Snippet

import { VoyadoEngage } from 'voyado_engage';

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

  const { data } = await voyadoEngage.interactionschemas.interactionSchemaCreateInteractionSchema(input);

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

InteractionSchema_GetInteractionSchema

Retrieve a specific InteractionSchema by providing the schemaId.

• HTTP Method: GET
• Endpoint: /api/v2/interactionschemas/{interactionSchemaId}

Parameters

Name	Type	Required	Description
interactionSchemaId	string	✅

Return Type

InteractionSchemaModel

Example Usage Code Snippet

import { VoyadoEngage } from 'voyado_engage';

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

  const { data } = await voyadoEngage.interactionschemas.interactionSchemaGetInteractionSchema('interactionSchemaId');

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

InteractionSchema_DeleteInteractionSchema

Delete InteractionSchema by providing the schemaId.

• HTTP Method: DELETE
• Endpoint: /api/v2/interactionschemas/{interactionSchemaId}

Parameters

Name	Type	Required	Description
interactionSchemaId	string	✅

Example Usage Code Snippet

import { VoyadoEngage } from 'voyado_engage';

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

  const { data } =
    await voyadoEngage.interactionschemas.interactionSchemaDeleteInteractionSchema('interactionSchemaId');

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

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →