Skip to main content

InteractionsService

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

MethodsDescription
InteractionGetInteractionAsyncRetrieve a specific Interaction by providing the interactionId.
InteractionDeleteInteractionAsyncDelete a specific Interaction by providing the interactionId.
InteractionGetInteractionsAsyncRetrieve multiple Interactions of a specified type connected to a specific contactId. Both schemaId and contactId are required. The continuation parameter can be used to access the next page when there are more than 50 records available. This token can be found in the response.
InteractionCreateInteractionAsyncCreate a new Interaction connected to a specific contactId.

InteractionGetInteractionAsync

Retrieve a specific Interaction by providing the interactionId.

  • HTTP Method: GET
  • Endpoint: /api/v2/interactions/{interactionId}

Parameters

NameTypeRequiredDescription
interactionIdstring

Return Type

InteractionModel

Example Usage Code Snippet

using VoyadoEngage;

var client = new VoyadoEngageClient();

var response = await client.Interactions.InteractionGetInteractionAsync("interactionId");

Console.WriteLine(response);

InteractionDeleteInteractionAsync

Delete a specific Interaction by providing the interactionId.

  • HTTP Method: DELETE
  • Endpoint: /api/v2/interactions/{interactionId}

Parameters

NameTypeRequiredDescription
interactionIdstring

Example Usage Code Snippet

using VoyadoEngage;

var client = new VoyadoEngageClient();

await client.Interactions.InteractionDeleteInteractionAsync("interactionId");

InteractionGetInteractionsAsync

Retrieve multiple Interactions of a specified type connected to a specific contactId. Both schemaId and contactId are required. The continuation parameter can be used to access the next page when there are more than 50 records available. This token can be found in the response.

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

Parameters

NameTypeRequiredDescription
contactIdstring
schemaIdstring
continuationstring

Return Type

InteractionPage

Example Usage Code Snippet

using VoyadoEngage;

var client = new VoyadoEngageClient();

var response = await client.Interactions.InteractionGetInteractionsAsync("contactId", "schemaId", "continuation");

Console.WriteLine(response);

InteractionCreateInteractionAsync

Create a new Interaction connected to a specific contactId.

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

Parameters

NameTypeRequiredDescription
inputobjectThe request body.

Return Type

InteractionCreateResponse

Example Usage Code Snippet

using VoyadoEngage;

var client = new VoyadoEngageClient();

var response = await client.Interactions.InteractionCreateInteractionAsync(new object {});

Console.WriteLine(response);

Build Your Own SDKs with  liblab

Build developer friendly SDKs in minutes from your APIs

Start for Free →