Skip to main content
POST
/
integration
/
config
Create Integration Configuration
curl --request POST \
  --url https://app.cardclan.io/api/integration/config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userId": "60f7b2b5b8f4a20015a4f5a3",
  "workspaceId": "60f7b2b5b8f4a20015a4f5a4",
  "cardId": "60f7b2b5b8f4a20015a4f5a5"
}
'
{
  "data": {
    "_id": "60f7b2b5b8f4a20015a4f5a7",
    "userId": "60f7b2b5b8f4a20015a4f5a3",
    "workspaceId": "60f7b2b5b8f4a20015a4f5a4",
    "cardId": "60f7b2b5b8f4a20015a4f5a5",
    "createdAt": "2023-07-20T10:30:00.000Z",
    "updatedAt": "2023-07-20T10:30:00.000Z"
  },
  "message": "Integration configuration created"
}
Creates a new integration configuration that links a specific card to workflow settings. This configuration is required before you can send cards through the Integration API and serves as a bridge between your automation workflows and CardClan cards.

​
What is an Integration Configuration?

An integration configuration is a record that:
  • Links a card to integration workflows
  • Defines workflow settings for automation platforms
  • Enables card sending through the Integration API
  • Tracks integration usage and analytics
Think of it as “registering” a card for use in automated workflows.

​
Request Parameters

​
userId
string
required
Your CardClan user ID (obtained from authentication)
​
workspaceId
string
required
Workspace ID containing the card (from Get Workspaces endpoint)
​
cardId
string
required
ID of the card to configure for integration use

​
Response Details

​
data
object
The created integration configuration object
​
message
string
Success message confirming the configuration was created

​
Workflow Integration Process

​
Response Example

{
  "data": {
    "_id": "60f7b2b5b8f4a20015a4f5a8",
    "userId": "60f7b2b5b8f4a20015a4f5a3",
    "workspaceId": "60f7b2b5b8f4a20015a4f5a4",
    "cardId": "60f7b2b5b8f4a20015a4f5a5",
    "createdAt": "2023-07-20T10:30:00.000Z",
    "updatedAt": "2023-07-20T10:30:00.000Z"
  },
  "message": "Integration configuration created"
}

Authorizations

​
Authorization
string
header
required

Enter your CardClan integration key

Body

application/json
​
userId
string
required

User ID

Example:

"60f7b2b5b8f4a20015a4f5a3"

​
workspaceId
string
required

Workspace ID

Example:

"60f7b2b5b8f4a20015a4f5a4"

​
cardId
string
required

Card ID

Example:

"60f7b2b5b8f4a20015a4f5a5"

Response

Integration configuration created successfully

​
data
object
​
message
string
Example:

"Integration configuration created"