Skip to main content
POST
/
integrations
/
v1
/
integrations
/
{integration}
/
use-case-groups
Upsert Group And Usecases
curl --request POST \
  --url https://api-qa.interactly.ai/integrations/v1/integrations/{integration}/use-case-groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assistant_id": "68a8652f82513625d1c21a85",
  "name": "Appointment Reminders",
  "sheet_link": "https://1drv.ms/x/...",
  "start_time": "08:00:00",
  "timezone": "America/Chicago",
  "use_cases": [
    {
      "actions": [
        {
          "action_type": "SMS",
          "context": "reminder_7d",
          "day": 7,
          "template_name": "First SMS"
        },
        {
          "action_type": "CALL",
          "context": "reminder_1d",
          "day": 1,
          "template_name": "Day 1 Call"
        }
      ],
      "enabled": true,
      "use_case": "NEW_PATIENT_APPOINTMENT_REMINDER"
    },
    {
      "actions": [
        {
          "action_type": "SMS",
          "context": "lab_result_sms",
          "day": 0,
          "template_name": "Lab Result SMS"
        }
      ],
      "enabled": true,
      "use_case": "LAB_REMINDER"
    }
  ]
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Retrieve your API Key from Dashboard API Keys Section.

Path Parameters

integration
enum<string>
required
Available options:
microsoft,
google

Body

application/json
name
string
required

Human friendly group name

slug
string | null

Optional explicit slug; if omitted will be generated

Associated sheet link for this group

assistant_id
string | null

Assistant identifier bound to this group

timezone
string | null

Timezone identifier e.g. America/Chicago

start_time
string<time> | null

Time of day to run the use-case group (HH:MM:SS)

group_id
string | null

If provided, updates the existing group; otherwise creates a new group

Required string length: 24
Example:

"5eb7cf5a86d9755df3a6c593"

use_cases
UseCaseConfigPayload · object[]

List of use-case configurations to upsert under this group

Response

Successful Response