POST
/
v1
/
integration_account
curl --request POST \
  --url http://localhost:8000/api/v1/integration_account \
  --header 'Content-Type: application/json' \
  --data '{
  "integrationDefinitionId": "<string>",
  "integrationAccountName": "<string>",
  "authType": "<string>",
  "workspaceId": "<string>",
  "config": {},
  "accountIdentifier": "<string>"
}'
{
  "integrationAccountId": "<string>",
  "integrationDefinitionId": "<string>",
  "integrationConfiguration": {},
  "authType": "<string>",
  "workspaceId": "<string>",
  "integrationAccountName": "<string>",
  "deleted": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "linkId": "<string>"
}

Body

application/json
integrationDefinitionId
string
required
integrationAccountName
string
required
authType
string
required
workspaceId
string
required
config
object
required
accountIdentifier
string
required

Response

201 - application/json
integrationAccountId
string
required

A unique identifier for Integration Account

integrationDefinitionId
string
required

A unique identifier for Integration Definition

integrationConfiguration
object | null
required

Configuration used to configure the integration

authType
string
required

Type of authentication used to create this account Exmaple: OAuth2, Api Key etc

workspaceId
string
required

A unique identifier for Workspace

integrationAccountName
string
required

This is used for User experience. You can pass a name to easily identify the account in UI

deleted
string | null
required

When this account is deleted. If deleted

createdAt
string
required

When the integration account was created.

updatedAt
string
required

When the integration account was updated last.

linkId
string | null

This will be linkId of the link used to created this account