Skip to main content
PATCH
Update a Connection

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

The ID of the org

connection_id
string
required

The ID of the connection

Body

The updated details of the connection.

name
string

Name for the new connection

Maximum string length: 256
Example:

"My New Connection"

config
object

Configuration of a connection

Response

200 - application/json

The updated connection.

Detailed information about a connection

id
string
required

Unique identifier for the connection

type
enum<string>
required

Connection type

Available options:
SCHEDULER,
WORKFLOWS,
TOOLS,
FILES,
EMAILS,
HTTP_CREDENTIALS,
TABLES,
PAGES,
KNOWLEDGE,
SKILLS,
CONTACTS,
SEGMENTS,
ASSISTANTS,
INBOX,
MEMBERS,
BROADCASTS,
ANALYTICS,
AUDIT,
PHONE,
GMAIL,
GOOGLE_SHEETS,
GOOGLE_CALENDAR,
GOOGLE_DRIVE,
OUTLOOK_CALENDAR,
AIRTABLE,
NOTION,
LINEAR,
HUBSPOT,
GOHIGHLEVEL,
CAL,
CALENDLY,
RESEND,
OAUTH,
SLACK,
TELEGRAM,
TRELLO,
FACEBOOK,
WHATSAPP,
INSTAGRAM,
MESSENGER,
TIKTOK,
JAPIFON,
TWILIO,
TELNYX,
ZOHO,
ZOHO_BOOKINGS,
ZOHO_INVENTORY,
ZOHO_CALENDAR,
SALESFORCE,
STRIPE,
SHOPIFY,
ZENDESK,
MCP,
ODOO,
WOOCOMMERCE
Example:

"SLACK"

name
string | null
required

Optional name for the connection

Example:

"My Encompass Connection"

external_name
string | null
required

Optional external name for the connection

external_id
string | null
required

Optional external identifier for the connection

status
enum<string>
required
Available options:
ACTIVE,
INACTIVE
status_error
string | null
required

Optional error message if the connection is in error state

config
object
required

Configuration of a connection

created_at
string<date-time> | null
required

Timestamp of when the connection was created

updated_at
string<date-time> | null
required

Timestamp of when the connection was last updated

email_identity
object

An email identity