Skip to main content
POST
/
integrations
/
v2
/
use-cases
Create Integration
curl --request POST \
  --url https://api-qa.interactly.ai/integrations/v2/use-cases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "logicalId": "<string>",
  "integrationId": "5eb7cf5a86d9755df3a6c593",
  "schedulerNames": [
    "<string>"
  ],
  "config": {
    "displayName": "<string>",
    "assistantId": "5eb7cf5a86d9755df3a6c593",
    "status": "active",
    "timezone": "<string>",
    "type": "appointment_reminder_with_sheet",
    "name": "New Patients Appointment Reminder",
    "sheetLink": "<string>",
    "actions": [
      {
        "logicalId": "<string>",
        "templateName": "<string>",
        "communicationPreference": "call",
        "context": "<string>",
        "reportEmails": [
          "<string>"
        ],
        "daysWindow": 7,
        "status": "active",
        "schedule": {
          "startDateTime": "2023-11-07T05:31:56Z",
          "endDateTime": "2023-11-07T05:31:56Z",
          "field": "oneTime",
          "triggerAt": "2023-11-07T05:31:56Z"
        }
      }
    ]
  }
}
'
{
  "integration_use_case": {
    "teamId": "5eb7cf5a86d9755df3a6c593",
    "createdBy": "5eb7cf5a86d9755df3a6c593",
    "updatedBy": "5eb7cf5a86d9755df3a6c593",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "_id": "5eb7cf5a86d9755df3a6c593",
    "logicalId": "<string>",
    "integrationId": "5eb7cf5a86d9755df3a6c593",
    "schedulerNames": [
      "<string>"
    ],
    "config": {
      "displayName": "<string>",
      "assistantId": "5eb7cf5a86d9755df3a6c593",
      "status": "active",
      "timezone": "<string>",
      "type": "appointment_reminder_with_sheet",
      "name": "New Patients Appointment Reminder",
      "sheetLink": "<string>",
      "actions": [
        {
          "logicalId": "<string>",
          "templateName": "<string>",
          "communicationPreference": "call",
          "context": "<string>",
          "reportEmails": [
            "<string>"
          ],
          "daysWindow": 7,
          "status": "active",
          "schedule": {
            "startDateTime": "2023-11-07T05:31:56Z",
            "endDateTime": "2023-11-07T05:31:56Z",
            "field": "oneTime",
            "triggerAt": "2023-11-07T05:31:56Z"
          }
        }
      ]
    }
  }
}

Authorizations

​
Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Body

application/json
​
logicalId
string | null

Unique identifier for the integration use-case

​
integrationId
string | null

Reference to the associated integration

Required string length: 24
Pattern: ^[0-9a-f]{24}$
Example:

"5eb7cf5a86d9755df3a6c593"

​
schedulerNames
string[]

List of associated scheduler names

​
config
Appointment Reminder With Sheet Use Case Configuration · object

type-specific configuration schema determined by 'type'.

Response

Successful Response

Response model for a single integration use case. Contains a IntegrationsUseCasesModel object.

​
integration_use_case
IntegrationsUseCasesModel · object
required

Single integration use case object