Set Integration

POST 
/api/v2/instance/:instanceId/typebot-integration

Set Integration

Request

Path Parameters

instanceId stringrequired

ID of the instance.

application/json

Body

required

• publicId: The ID or name given to your typebot
• typebotURL: The URL of your typebot host
  • default: https://typebot.io
• enabled: Enable or disable your integration

publicId Typebot IDrequired

The ID or name given to your typebot

typebotURL Typebot URLrequired

Default value: https://typebot.io

The URL of your typebot host

enabled Enabledrequired

Default value: false

Enable or disable your integration

Responses

201

Success - status: 201

application/json

Schema

Schema

integrationId stringrequired
publicId stringrequired
typebotURL stringrequired
enabled booleanrequired
instanceInstanceId stringrequired
createdAt date-timerequired
updatedAt date-timerequired

Example (from schema)

{
  "integrationId": "string",
  "publicId": "string",
  "typebotURL": "string",
  "enabled": true,
  "instanceInstanceId": "string",
  "createdAt": "2024-04-14T14:11:05.747Z",
  "updatedAt": "2024-04-14T14:11:05.747Z"
}

400

BadRequestException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

403

ForbiddenException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

404

NotFoundException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...