POST
/
interactions
/
{interaction_id}
import { ProficientClient } from "@proficient/client";

const proficient = new ProficientClient({
  apiKey: process.env.PROFICIENT_AI_PUBLISHABLE_KEY,
  userExternalId: "...", // The user's unique ID in your system
});

const interactionId = "int_53mfKtX0Da6zaJCp5bNnzxDaEg1xptWvQDr2";

const interaction = await proficient.interactions.update(interactionId, {
  // ... fields to update
});

{
  "id": "<string>",
  "object": "interaction",
  "agent_id": "<string>",
  "archived": true,
  "created_at": 123,
  "initial_turn": "user",
  "name": "<string>",
  "total_message_count": 123,
  "updated_at": 123,
  "user_id": "<string>"
}
import { ProficientClient } from "@proficient/client";

const proficient = new ProficientClient({
  apiKey: process.env.PROFICIENT_AI_PUBLISHABLE_KEY,
  userExternalId: "...", // The user's unique ID in your system
});

const interactionId = "int_53mfKtX0Da6zaJCp5bNnzxDaEg1xptWvQDr2";

const interaction = await proficient.interactions.update(interactionId, {
  // ... fields to update
});

Path Parameters

​
interaction_id
string
required

The unique identifier of the interaction

Body

application/json

The data with which an interaction is updated.

​
name
string | null

The name of the interaction

Response

200
application/json
<p>Users communicate with agents via <i>interactions</i>. You can think of each interaction as a conversation between an agent and user.</p>
​
id
string
required

The unique identifier of the interaction

​
object
enum<string>
required

The type of the Interaction object

Available options:
interaction
​
agent_id
string
required

The unique identifier of the agent

​
archived
boolean
required

Whether the interaction has been archived by the user

​
created_at
integer
required

The time at which the object was created, measured in milliseconds since the Unix epoch

​
initial_turn
enum<string>
required

Indicates who sends the first message in each interaction. Defaults to "user".

Available options:
user,
agent
​
name
string
required

The name of the interaction

​
total_message_count
integer
required

The total number of messages in the interaction

​
updated_at
integer
required

The time at which the object was last updated, measured in milliseconds since the Unix epoch

​
user_id
string
required

The unique identifier of the user

Retrieve an interactionDelete an interaction