Passer au contenu principal
POST
/
flows
/
vault
/
connections
Create a Flows Vault connection
curl --request POST \
  --url https://{tenantDomain}/api/v2/flows/vault/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "app_id": "ACTIVECAMPAIGN",
  "setup": {
    "type": "API_KEY",
    "api_key": "<string>",
    "base_url": "<string>"
  }
}
'
{
  "id": "<string>",
  "app_id": "<string>",
  "name": "<string>",
  "ready": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "fingerprint": "<string>",
  "environment": "<string>",
  "account_name": "<string>",
  "refreshed_at": "2023-11-07T05:31:56Z"
}

Autorisations

Authorization
string
header
requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Corps

name
string
requis

Flows Vault Connection name.

Required string length: 1 - 150
app_id
enum<string>
requis

Flows Vault Connection app identifier.

Options disponibles:
ACTIVECAMPAIGN
Required string length: 1 - 55
setup
object
requis

Réponse

Connection successfully created.

id
string<flows-vault-connections-id>
requis

Flows Vault Connection identifier.

Maximum string length: 30
app_id
string
requis

Flows Vault Connection app identifier.

Required string length: 1 - 55
name
string
requis

Flows Vault Connection name.

Required string length: 1 - 150
ready
boolean
requis

Whether the Flows Vault Connection is configured.

created_at
string<date-time>
requis

The ISO 8601 formatted date when this Flows Vault Connection was created.

updated_at
string<date-time>
requis

The ISO 8601 formatted date when this Flows Vault Connection was updated.

fingerprint
string
requis
Minimum string length: 1
environment
string

Flows Vault Connection environment.

Required string length: 1 - 55
account_name
string

Flows Vault Connection custom account name.

Required string length: 1 - 150
refreshed_at
string<date-time>

The ISO 8601 formatted date when this Flows Vault Connection was refreshed.