Create a Flows Vault connection

POST https://{tenantDomain}/api/v2/flows/vault/connections

Create a Flows Vault connection

cURL

curl --request POST \
  --url https://{tenantDomain}/api/v2/flows/vault/connections \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "setup": {
    "api_key": "<string>",
    "base_url": "<string>"
  }
}
'

201

{
  "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"
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Body

application/jsonapplication/x-www-form-urlencoded

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Option 10

Option 11

Option 12

Option 13

Option 14

Option 15

Option 16

Option 17

Option 18

Option 19

Option 20

Option 21

Option 22

Option 23

Option 24

Option 25

Option 26

Option 27

Option 28

Option 29

Option 30

Option 31

Option 32

Option 33

Option 34

Option 35

Option 36

Option 37

Option 38

Option 39

Option 40

Option 41

Option 42

Option 43

Option 44

Option 45

Option 46

Option 47

Option 48

Option 49

Option 50

name · string · required

Flows Vault Connection name.

Required string length: 1 - 150

app_id · enum<string> · required

Flows Vault Connection app identifier.

Available options: ACTIVECAMPAIGN

Required string length: 1 - 55

setup · object · required

Show child attributes

Response

201

application/json

Connection successfully created.

id · string<flows-vault-connections-id> · required

Flows Vault Connection identifier.

Maximum string length: 30

app_id · string · required

Flows Vault Connection app identifier.

Required string length: 1 - 55

name · string · required

Flows Vault Connection name.

Required string length: 1 - 150

ready · boolean · required

Whether the Flows Vault Connection is configured.

created_at · string<date-time> · required

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

updated_at · string<date-time> · required

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

fingerprint · string · required

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.