Skip to main content
PUT
/
connections
/
{id}
Update a connection
curl --request PUT \
  --url https://api.cloud.flexprice.io/v1/connections/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "metadata": {},
  "name": "<string>",
  "sync_config": {
    "deal": {
      "inbound": true,
      "outbound": true
    },
    "invoice": {
      "inbound": true,
      "outbound": true
    },
    "plan": {
      "inbound": true,
      "outbound": true
    },
    "subscription": {
      "inbound": true,
      "outbound": true
    }
  }
}'
{
  "created_at": "<string>",
  "created_by": "<string>",
  "environment_id": "<string>",
  "id": "<string>",
  "metadata": {},
  "name": "<string>",
  "provider_type": "flexprice",
  "status": "published",
  "sync_config": {
    "deal": {
      "inbound": true,
      "outbound": true
    },
    "invoice": {
      "inbound": true,
      "outbound": true
    },
    "plan": {
      "inbound": true,
      "outbound": true
    },
    "subscription": {
      "inbound": true,
      "outbound": true
    }
  },
  "tenant_id": "<string>",
  "updated_at": "<string>",
  "updated_by": "<string>"
}

Authorizations

x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

id
string
required

Connection ID

Body

application/json

Connection

metadata
object
name
string
Maximum length: 255
sync_config
object

Response

OK

created_at
string
created_by
string
environment_id
string
id
string
metadata
object
name
string
provider_type
enum<string>
Available options:
flexprice,
stripe,
s3,
hubspot
status
enum<string>
Available options:
published,
deleted,
archived
sync_config
object
tenant_id
string
updated_at
string
updated_by
string