Skip to main content
POST
/
integrations
/
v2
/
integrations
Create Integration
curl --request POST \
  --url https://api-qa.interactly.ai/integrations/v2/integrations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "logicalId": "<string>",
  "name": "<string>",
  "status": "active",
  "access": "team",
  "config": {
    "scope": "<string>",
    "accessToken": "<string>",
    "refreshToken": "<string>",
    "tokenType": "<string>",
    "expiresAt": "2023-11-07T05:31:56Z",
    "connectedAt": "2023-11-07T05:31:56Z",
    "renewedAt": "2023-11-07T05:31:56Z",
    "errorMessage": "<string>",
    "provider": "microsoft",
    "authType": "oauth",
    "authUserEmail": "<string>",
    "authUserName": "<string>"
  },
  "timezone": "UTC"
}
'
{
  "integration": {
    "teamId": "5eb7cf5a86d9755df3a6c593",
    "createdBy": "5eb7cf5a86d9755df3a6c593",
    "updatedBy": "5eb7cf5a86d9755df3a6c593",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "_id": "5eb7cf5a86d9755df3a6c593",
    "logicalId": "<string>",
    "name": "<string>",
    "status": "active",
    "access": "team",
    "config": {
      "scope": "<string>",
      "accessToken": "<string>",
      "refreshToken": "<string>",
      "tokenType": "<string>",
      "expiresAt": "2023-11-07T05:31:56Z",
      "connectedAt": "2023-11-07T05:31:56Z",
      "renewedAt": "2023-11-07T05:31:56Z",
      "errorMessage": "<string>",
      "provider": "microsoft",
      "authType": "oauth",
      "authUserEmail": "<string>",
      "authUserName": "<string>"
    },
    "timezone": "UTC"
  }
}

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

​
provider
enum<string> | null

Integration provider type (e.g., microsoft, google, slack).

Available options:
microsoft,
google,
athena,
ecw,
slack,
okta
​
name
string | null

Friendly name for the integration (e.g., 'Google Calendar Sync').

​
status
enum<string> | null
default:active

Status of the integration. Defaults to 'active'.

Available options:
active,
inactive
​
access
enum<string> | null
default:team

Access level for the integration (personal, team, or system).

Available options:
personal,
team,
system
​
config
Microsoft Integration · object

Microsoft OAuth-based integration configuration.

​
timezone
string | null
default:UTC

IANA timezone string (e.g., 'America/New_York', 'Asia/Kolkata').

Response

Successful Response

Response model for a single integration. Contains a IntegrationsModel object.

​
integration
IntegrationsModel · object
required

Single integration object