Properties
| Name | Type | Description |
|---|---|---|
| interactionType | string | The type of digital interaction. |
| subject | string | Subject of the interaction (e.g., email subject). |
| body | string | Body content of the interaction. |
| timestamp | string | When the interaction occurred. |
| direction | string | Direction of the interaction. |
| participants | array | Participants in the interaction. |
| workspaceId | string | The workspace to associate the interaction with. |
| clientUniqueId | string | Client-provided unique ID to prevent duplicate submissions. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/DigitalInteractionRequest",
"title": "DigitalInteractionRequest",
"type": "object",
"required": [
"interactionType",
"participants",
"timestamp"
],
"properties": {
"interactionType": {
"type": "string",
"enum": [
"Email",
"Chat",
"SMS",
"SocialMedia",
"Other"
],
"description": "The type of digital interaction."
},
"subject": {
"type": "string",
"description": "Subject of the interaction (e.g., email subject)."
},
"body": {
"type": "string",
"description": "Body content of the interaction."
},
"timestamp": {
"type": "string",
"format": "date-time",
"description": "When the interaction occurred."
},
"direction": {
"type": "string",
"enum": [
"Inbound",
"Outbound"
],
"description": "Direction of the interaction."
},
"participants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"emailAddress": {
"type": "string",
"format": "email"
},
"name": {
"type": "string"
},
"role": {
"type": "string",
"enum": [
"Sender",
"Recipient",
"CC",
"BCC"
]
}
}
},
"description": "Participants in the interaction."
},
"workspaceId": {
"type": "string",
"description": "The workspace to associate the interaction with."
},
"clientUniqueId": {
"type": "string",
"description": "Client-provided unique ID to prevent duplicate submissions."
}
}
}