connections

Record Consent

Changed on

Accept the widened ask, where the provider has nothing left to grant.

The other half of the offer core/reconsent.py makes. When a version bump widened only what we do with scopes the customer already granted, the token needs nothing and sending them round an OAuth trip would be asking them to click for nothing — so this records the agreement and stops the offer.

It refuses, hard, when the bump widened the provider grant. No token we hold carries a scope the customer never granted, and no row we write changes that: stamping the version there would manufacture exactly the consent record that keeping consent_version NULL was refusing to manufacture. The reconnect flow is what records that one, because the provider is what grants it.

Owner only: agreeing to a wider ask on the workspace's behalf is the same act as connecting the account in the first place.

post/api/connections/{connection_id}/consent

Request

  • Base URL: https://api.heymetra.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.heymetra.com/api/connections/{connection_id}/consent
  • Auth: none declared

Path parameters

connection_idstring uuid required

Headers

authorizationstring nullable
x-workspace-idstring nullable

Response

Successful Response

idstring uuid required
provider'google_ads' | 'meta_ads' | 'meta_instagram' | 'meta_page' | 'ga4' | 'gsc' | 'zoho_crm' | 'zoho_salesiq' | 'zoho_marketing' | 'telegram' | 'slack' | 'email' | 'adapty' | 'trendyol' | 'revenuecat' | 'appsflyer' | 'app_store_connect' | 'woocommerce' | 'shopify' | 'stripe' | 'posthog' | 'jira' | 'hepsiburada' | 'n11' | 'ciceksepeti' | 'amazon_seller' | 'ikas' required
account_idstring required
account_namestring nullable required
aliasstring nullable required
display_namestring required
is_activeboolean required
paused_for_planboolean required
write_enabledboolean required
ask_before_sendingboolean
currencystring nullable required
consent_versioninteger nullable
is_mineboolean
may_administerboolean
shared_with_workspaceboolean
referencestring required
identityobject required
credentialsobject
last_errorstring nullable required
created_atstring date-time required
grant_shape'separable' | 'read_only' | 'inseparable' | 'channel' required

What a customer's read-or-write choice can actually buy at this provider.

The choice is offered on every connector, because a customer deciding whether an assistant may change their account should not have to know which providers happen to model that as a scope. What differs is what the choice BUYS, and saying so is this enum's whole job: a screen that offers the same two options everywhere while one of them is unenforceable at three providers is worse than one that says which is which.

Changes

  • 877b0f87d6d0Revision changes
    • info

      removed the google_calendar enum value from the response property for the response status

    • info

      removed the google_meet enum value from the response property for the response status

  • 488ce9683884Revision changes
    • warning

      added the new ikas enum value to the response property for the response status