> ## Documentation Index > Fetch the complete documentation index at: https://docs.useinvent.com/llms.txt > Use this file to discover all available pages before exploring further. # Update a Connection > Update the details of an existing connection. ## OpenAPI ````yaml https://api.useinvent.com/openapi.json patch /orgs/{org_id}/connections/{connection_id} openapi: 3.1.0 info: version: 1.0.0 title: Invent API servers: - url: https://api.useinvent.com security: - bearerAuth: [] paths: /orgs/{org_id}/connections/{connection_id}: patch: tags: - Orgs Connections summary: Update a Connection description: Update the details of an existing connection. parameters: - schema: type: string required: true description: The ID of the org name: org_id in: path - schema: type: string required: true description: The ID of the connection name: connection_id in: path requestBody: description: The updated details of the connection. content: application/json: schema: $ref: '#/components/schemas/UpdateConnectionSchema' multipart/form-data: schema: $ref: '#/components/schemas/UpdateConnectionSchema' responses: '200': description: The updated connection. content: application/json: schema: $ref: '#/components/schemas/ConnectionSchema' components: schemas: UpdateConnectionSchema: type: object properties: name: type: string maxLength: 256 description: Name for the new connection example: My New Connection config: type: object properties: {} additionalProperties: {} description: Configuration of a partial connection oneOf: - $ref: '#/components/schemas/ConnectionConfigPartialSchema' ConnectionSchema: type: object properties: id: type: string description: Unique identifier for the connection type: $ref: '#/components/schemas/ConnectionTypeSchema' name: type: - string - 'null' description: Optional name for the connection example: My Encompass Connection external_name: type: - string - 'null' description: Optional external name for the connection external_id: type: - string - 'null' description: Optional external identifier for the connection status: $ref: '#/components/schemas/ConnectionStatusSchema' status_error: type: - string - 'null' description: Optional error message if the connection is in error state config: type: object properties: {} additionalProperties: {} description: Configuration of a connection oneOf: - $ref: '#/components/schemas/ConnectionConfigSchema' email_identity: $ref: '#/components/schemas/EmailIdentitySchema' created_at: type: - string - 'null' format: date-time description: Timestamp of when the connection was created updated_at: type: - string - 'null' format: date-time description: Timestamp of when the connection was last updated required: - id - type - name - external_name - external_id - status - status_error - config - created_at - updated_at description: Detailed information about a connection ConnectionConfigPartialSchema: anyOf: - $ref: '#/components/schemas/ConnectionPhoneManualConfigSchema' - $ref: '#/components/schemas/ConnectionEmailsManualConfigSchema' - $ref: '#/components/schemas/ConnectionOauthManualConfigSchema' - $ref: '#/components/schemas/ConnectionOauthOauthConfigSchema' - $ref: '#/components/schemas/ConnectionHttpCredentialsManualConfigSchema' - $ref: '#/components/schemas/ConnectionMcpManualConfigSchema' - $ref: '#/components/schemas/ConnectionGoogleSheetsOauthConfigSchema' - $ref: '#/components/schemas/ConnectionGoogleCalendarOauthConfigSchema' - $ref: '#/components/schemas/ConnectionOutlookCalendarOauthConfigSchema' - $ref: '#/components/schemas/ConnectionGoogleDriveOauthConfigSchema' - $ref: '#/components/schemas/ConnectionAirtableOauthConfigSchema' - $ref: '#/components/schemas/ConnectionNotionOauthConfigSchema' - $ref: '#/components/schemas/ConnectionLinearOauthConfigSchema' - $ref: '#/components/schemas/ConnectionTrelloOauthConfigSchema' - $ref: '#/components/schemas/ConnectionHubspotOauthConfigSchema' - $ref: '#/components/schemas/ConnectionSalesforceOauthConfigSchema' - $ref: '#/components/schemas/ConnectionZohoOauthConfigSchema' - $ref: '#/components/schemas/ConnectionZohoBookingsOauthConfigSchema' - $ref: '#/components/schemas/ConnectionZohoInventoryOauthConfigSchema' - $ref: '#/components/schemas/ConnectionZohoCalendarOauthConfigSchema' - $ref: '#/components/schemas/ConnectionGohighlevelOauthConfigSchema' - $ref: '#/components/schemas/ConnectionCalOauthConfigSchema' - $ref: '#/components/schemas/ConnectionCalendlyOauthConfigSchema' - $ref: '#/components/schemas/ConnectionSlackOauthConfigSchema' - $ref: '#/components/schemas/ConnectionTelegramManualConfigSchema' - $ref: '#/components/schemas/ConnectionInstagramOauthConfigSchema' - $ref: '#/components/schemas/ConnectionMessengerOauthConfigSchema' - $ref: '#/components/schemas/ConnectionTiktokOauthConfigSchema' - $ref: '#/components/schemas/ConnectionWhatsappOauthConfigSchema' - $ref: '#/components/schemas/ConnectionGmailOauthConfigSchema' - $ref: '#/components/schemas/ConnectionJapifonManualConfigSchema' - $ref: '#/components/schemas/ConnectionTwilioManualConfigSchema' - $ref: '#/components/schemas/ConnectionTelnyxManualConfigSchema' - $ref: '#/components/schemas/ConnectionResendManualConfigSchema' - $ref: '#/components/schemas/ConnectionStripeOauthConfigSchema' - $ref: '#/components/schemas/ConnectionShopifyOauthConfigSchema' - $ref: '#/components/schemas/ConnectionZendeskOauthConfigSchema' - $ref: '#/components/schemas/ConnectionOdooManualConfigSchema' - $ref: '#/components/schemas/ConnectionWoocommerceManualConfigSchema' description: Configuration of a connection ConnectionTypeSchema: type: string enum: - 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 description: Connection type example: SLACK ConnectionStatusSchema: type: string enum: - ACTIVE - INACTIVE ConnectionConfigSchema: anyOf: - $ref: '#/components/schemas/ConnectionPhoneManualConfigSchema' - $ref: '#/components/schemas/ConnectionEmailsManualConfigSchema' - $ref: '#/components/schemas/ConnectionOauthManualConfigSchema' - $ref: '#/components/schemas/ConnectionOauthOauthConfigSchema' - $ref: '#/components/schemas/ConnectionHttpCredentialsManualConfigSchema' - $ref: '#/components/schemas/ConnectionMcpManualConfigSchema' - $ref: '#/components/schemas/ConnectionGoogleSheetsOauthConfigSchema' - $ref: '#/components/schemas/ConnectionGoogleCalendarOauthConfigSchema' - $ref: '#/components/schemas/ConnectionOutlookCalendarOauthConfigSchema' - $ref: '#/components/schemas/ConnectionGoogleDriveOauthConfigSchema' - $ref: '#/components/schemas/ConnectionAirtableOauthConfigSchema' - $ref: '#/components/schemas/ConnectionNotionOauthConfigSchema' - $ref: '#/components/schemas/ConnectionLinearOauthConfigSchema' - $ref: '#/components/schemas/ConnectionTrelloOauthConfigSchema' - $ref: '#/components/schemas/ConnectionHubspotOauthConfigSchema' - $ref: '#/components/schemas/ConnectionSalesforceOauthConfigSchema' - $ref: '#/components/schemas/ConnectionZohoOauthConfigSchema' - $ref: '#/components/schemas/ConnectionZohoBookingsOauthConfigSchema' - $ref: '#/components/schemas/ConnectionZohoInventoryOauthConfigSchema' - $ref: '#/components/schemas/ConnectionZohoCalendarOauthConfigSchema' - $ref: '#/components/schemas/ConnectionGohighlevelOauthConfigSchema' - $ref: '#/components/schemas/ConnectionCalOauthConfigSchema' - $ref: '#/components/schemas/ConnectionCalendlyOauthConfigSchema' - $ref: '#/components/schemas/ConnectionSlackOauthConfigSchema' - $ref: '#/components/schemas/ConnectionTelegramManualConfigSchema' - $ref: '#/components/schemas/ConnectionInstagramOauthConfigSchema' - $ref: '#/components/schemas/ConnectionMessengerOauthConfigSchema' - $ref: '#/components/schemas/ConnectionTiktokOauthConfigSchema' - $ref: '#/components/schemas/ConnectionWhatsappOauthConfigSchema' - $ref: '#/components/schemas/ConnectionGmailOauthConfigSchema' - $ref: '#/components/schemas/ConnectionJapifonManualConfigSchema' - $ref: '#/components/schemas/ConnectionTwilioManualConfigSchema' - $ref: '#/components/schemas/ConnectionTelnyxManualConfigSchema' - $ref: '#/components/schemas/ConnectionResendManualConfigSchema' - $ref: '#/components/schemas/ConnectionStripeOauthConfigSchema' - $ref: '#/components/schemas/ConnectionShopifyOauthConfigSchema' - $ref: '#/components/schemas/ConnectionZendeskOauthConfigSchema' - $ref: '#/components/schemas/ConnectionOdooManualConfigSchema' - $ref: '#/components/schemas/ConnectionWoocommerceManualConfigSchema' description: Configuration of a connection EmailIdentitySchema: type: object properties: id: type: string description: Unique identifier for the email identity email: type: string description: Email address of the identity name: type: - string - 'null' description: Display name for the identity status: $ref: '#/components/schemas/EmailIdentityStatusSchema' domain: $ref: '#/components/schemas/EmailDomainSchema' is_default: type: boolean description: Whether this is the default identity for the org click_tracking: type: boolean description: Whether click tracking is enabled for this identity open_tracking: type: boolean description: Whether open tracking is enabled for this identity verified_at: type: - string - 'null' format: date-time description: Timestamp when the identity was verified created_at: type: - string - 'null' format: date-time description: Timestamp when the identity was created updated_at: type: - string - 'null' format: date-time description: Timestamp when the identity was last updated required: - id - email - name - status - domain - is_default - click_tracking - open_tracking - verified_at - created_at - updated_at description: An email identity ConnectionPhoneManualConfigSchema: type: object properties: type: type: string enum: - PHONE description: The type of the connection auth_method: type: string enum: - MANUAL description: The authentication method to use phone: type: string description: The phone number to send the verification code to title: Phone Number code: type: number description: The validation code title: Expires In required: - type - auth_method - phone description: Configuration of an Phone connection ConnectionEmailsManualConfigSchema: type: object properties: type: type: string enum: - EMAILS description: The type of the connection auth_method: type: string enum: - MANUAL description: The authentication method to use required: - type - auth_method description: Configuration of an Emails connection ConnectionOauthManualConfigSchema: type: object properties: type: type: string enum: - OAUTH description: The type of the connection auth_method: type: string enum: - MANUAL description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method - access_token description: Configuration of an OAuth connection ConnectionOauthOauthConfigSchema: type: object properties: type: type: string enum: - OAUTH description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an OAuth connection ConnectionHttpCredentialsManualConfigSchema: type: object properties: type: type: string enum: - HTTP_CREDENTIALS description: The type of the connection auth_method: type: string enum: - MANUAL description: The authentication method to use auth_type: type: string description: The type of HTTP authentication to use title: Authentication Type enum: - bearer - basic - custom_header - oauth_client_credentials - oauth_custom token: type: string description: The bearer token for authentication title: Bearer Token username: type: string description: Username for Basic authentication title: Username password: type: string description: Password for Basic authentication title: Password header_name: type: string description: The name of the custom header title: Header Name header_value: type: string description: The value for the custom header title: Header Value token_url: type: string description: Endpoint that issues access tokens. title: Token URL client_id: type: string client_secret: type: string scope: type: string description: Space-separated list of scopes to request. title: Scope refresh_url: type: string description: >- Optional. Separate endpoint for refresh. Falls back to the token URL when empty. title: Refresh URL token_body_format: type: string description: How the token endpoint expects the request body title: Token request body format enum: - form-urlencoded - json token_body_fields: type: string description: >- JSON object posted to the token URL. Provider-specific. Example for DataTree: {"ClientId":"...","ClientSecretKey":"..."}. title: Token request body token_response_format: type: string description: >- How to read the access token out of the response. 'json' uses a JSON path. 'raw_string' treats the entire response body as the token (e.g. DataTree). title: Token response format enum: - json - raw_string token_response_path: type: string description: JSON path to the access token (e.g. 'access_token', 'data.token'). title: Access token path expires_in_seconds: type: number description: Used when the response does not include an expiry. DataTree = 7200. title: Token TTL fallback (seconds) refresh_token_response_path: type: string description: JSON path to the refresh token. Defaults to 'refresh_token'. title: Refresh token path expires_in_response_path: type: string description: JSON path to the TTL. Defaults to 'expires_in'. title: Expires in path auth_header_name: type: string description: Defaults to 'Authorization'. title: Auth header name auth_header_template: type: string description: Use {{token}} as the placeholder. Defaults to 'Bearer {{token}}'. title: Auth header value template access_token: type: string description: The cached access token title: Access Token refresh_token: type: string description: The cached refresh token (if returned by the token endpoint) title: Refresh Token next_refresh_at: type: number description: Unix seconds when the cached token must be refreshed title: Next Refresh At required: - type - auth_method - auth_type description: Configuration of an HTTP Credentials connection ConnectionMcpManualConfigSchema: type: object properties: type: type: string enum: - MCP description: The type of the connection auth_method: type: string enum: - MANUAL description: The authentication method to use url: type: string description: The URL of the MCP server title: URL api_key: type: string description: Access token or API key for authentication title: Access Token or API Key headers: type: string description: Additional headers as JSON key-value pairs title: Headers required: - type - auth_method - url description: Configuration of an MCP connection ConnectionGoogleSheetsOauthConfigSchema: type: object properties: type: type: string enum: - GOOGLE_SHEETS description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an Google Sheets connection ConnectionGoogleCalendarOauthConfigSchema: type: object properties: type: type: string enum: - GOOGLE_CALENDAR description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an Google Calendar connection ConnectionOutlookCalendarOauthConfigSchema: type: object properties: type: type: string enum: - OUTLOOK_CALENDAR description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an Outlook Calendar connection ConnectionGoogleDriveOauthConfigSchema: type: object properties: type: type: string enum: - GOOGLE_DRIVE description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an Google Drive connection ConnectionAirtableOauthConfigSchema: type: object properties: type: type: string enum: - AIRTABLE description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an Airtable connection ConnectionNotionOauthConfigSchema: type: object properties: type: type: string enum: - NOTION description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an Notion connection ConnectionLinearOauthConfigSchema: type: object properties: type: type: string enum: - LINEAR description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an Linear connection ConnectionTrelloOauthConfigSchema: type: object properties: type: type: string enum: - TRELLO description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an Trello connection ConnectionHubspotOauthConfigSchema: type: object properties: type: type: string enum: - HUBSPOT description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an HubSpot connection ConnectionSalesforceOauthConfigSchema: type: object properties: type: type: string enum: - SALESFORCE description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an Salesforce connection ConnectionZohoOauthConfigSchema: type: object properties: type: type: string enum: - ZOHO description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an Zoho CRM connection ConnectionZohoBookingsOauthConfigSchema: type: object properties: type: type: string enum: - ZOHO_BOOKINGS description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an Zoho Bookings connection ConnectionZohoInventoryOauthConfigSchema: type: object properties: type: type: string enum: - ZOHO_INVENTORY description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an Zoho Inventory connection ConnectionZohoCalendarOauthConfigSchema: type: object properties: type: type: string enum: - ZOHO_CALENDAR description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an Zoho Calendar connection ConnectionGohighlevelOauthConfigSchema: type: object properties: type: type: string enum: - GOHIGHLEVEL description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an GoHighLevel connection ConnectionCalOauthConfigSchema: type: object properties: type: type: string enum: - CAL description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an Cal.com connection ConnectionCalendlyOauthConfigSchema: type: object properties: type: type: string enum: - CALENDLY description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an Calendly connection ConnectionSlackOauthConfigSchema: type: object properties: type: type: string enum: - SLACK description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an Slack connection ConnectionTelegramManualConfigSchema: type: object properties: type: type: string enum: - TELEGRAM description: The type of the connection auth_method: type: string enum: - MANUAL description: The authentication method to use api_key: type: string description: The bot token from @BotFather title: Telegram Bot Token required: - type - auth_method - api_key description: Configuration of an Telegram connection ConnectionInstagramOauthConfigSchema: type: object properties: type: type: string enum: - INSTAGRAM description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an Instagram connection ConnectionMessengerOauthConfigSchema: type: object properties: type: type: string enum: - MESSENGER description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an Messenger connection ConnectionTiktokOauthConfigSchema: type: object properties: type: type: string enum: - TIKTOK description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an TikTok connection ConnectionWhatsappOauthConfigSchema: type: object properties: type: type: string enum: - WHATSAPP description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an WhatsApp connection ConnectionGmailOauthConfigSchema: type: object properties: type: type: string enum: - GMAIL description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an Gmail connection ConnectionJapifonManualConfigSchema: type: object properties: type: type: string enum: - JAPIFON description: The type of the connection auth_method: type: string enum: - MANUAL description: The authentication method to use api_key: type: string description: Your Japifon API Key title: API Key required: - type - auth_method - api_key description: Configuration of an Japifon connection ConnectionTwilioManualConfigSchema: type: object properties: type: type: string enum: - TWILIO description: The type of the connection auth_method: type: string enum: - MANUAL description: The authentication method to use account_sid: type: string description: Your Twilio Account SID from the console title: Account SID auth_token: type: string description: Your Twilio Auth Token (keep this secret) title: Auth Token required: - type - auth_method - account_sid - auth_token description: Configuration of an Twilio connection ConnectionTelnyxManualConfigSchema: type: object properties: type: type: string enum: - TELNYX description: The type of the connection auth_method: type: string enum: - MANUAL description: The authentication method to use api_key: type: string description: Your Telnyx API Key (API v2) title: API Key required: - type - auth_method - api_key description: Configuration of an Telnyx connection ConnectionResendManualConfigSchema: type: object properties: type: type: string enum: - RESEND description: The type of the connection auth_method: type: string enum: - MANUAL description: The authentication method to use api_key: type: string description: The API key for Resend title: API Key required: - type - auth_method - api_key description: Configuration of an Resend connection ConnectionStripeOauthConfigSchema: type: object properties: type: type: string enum: - STRIPE description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an Stripe connection ConnectionShopifyOauthConfigSchema: type: object properties: type: type: string enum: - SHOPIFY description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an Shopify connection ConnectionZendeskOauthConfigSchema: type: object properties: type: type: string enum: - ZENDESK description: The type of the connection auth_method: type: string enum: - OAUTH description: The authentication method to use access_token: type: string description: The access token for OAuth authentication title: Access Token refresh_token: type: string description: The refresh token for OAuth authentication title: Refresh Token expires_in: type: number description: The expiration time of the access token title: Expires In next_refresh_at: type: number description: The timestamp when the access token will be refreshed title: Next Refresh At scope: type: string description: The scope of the access token title: Scope api_url: type: string profile_url: type: string subdomain: type: string required: - type - auth_method description: Configuration of an Zendesk connection ConnectionOdooManualConfigSchema: type: object properties: type: type: string enum: - ODOO description: The type of the connection auth_method: type: string enum: - MANUAL description: The authentication method to use url: type: string description: Your Odoo instance URL title: Odoo URL database: type: string description: The name of your Odoo database title: Database Name username: type: string description: Your Odoo username or email title: Username / Email api_key: type: string description: API key from Odoo (Settings > Users > API Keys) title: API Key required: - type - auth_method - url - database - username - api_key description: Configuration of an Odoo CRM connection ConnectionWoocommerceManualConfigSchema: type: object properties: type: type: string enum: - WOOCOMMERCE description: The type of the connection auth_method: type: string enum: - MANUAL description: The authentication method to use store_url: type: string description: Your WooCommerce store URL (must use HTTPS) title: Store URL consumer_key: type: string description: >- Generate from WooCommerce > Settings > Advanced > REST API (Read/Write) title: Consumer Key consumer_secret: type: string description: The Consumer Secret paired with your Consumer Key title: Consumer Secret required: - type - auth_method - store_url - consumer_key - consumer_secret description: Configuration of an WooCommerce connection EmailIdentityStatusSchema: type: string enum: - PENDING - VERIFIED - FAILED description: Verification status of an email identity EmailDomainSchema: type: object properties: id: type: string description: Unique identifier for the email domain domain: type: string description: The domain name dkim_status: $ref: '#/components/schemas/EmailDomainDkimStatusSchema' dkim_tokens: type: - array - 'null' items: $ref: '#/components/schemas/EmailDomainDkimTokenSchema' description: DKIM CNAME records to add to DNS verified_at: type: - string - 'null' format: date-time description: Timestamp when the domain was verified created_at: type: - string - 'null' format: date-time description: Timestamp when the domain was created updated_at: type: - string - 'null' format: date-time description: Timestamp when the domain was last updated required: - id - domain - dkim_status - dkim_tokens - verified_at - created_at - updated_at description: Linked email domain EmailDomainDkimStatusSchema: type: string enum: - PENDING - VERIFIED - FAILED description: DKIM verification status of an email domain EmailDomainDkimTokenSchema: type: object properties: name: type: string description: CNAME record name value: type: string description: CNAME record value required: - name - value description: A DKIM CNAME record for domain verification securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: Bearer token authentication using your API key ````