MYmyaltimate
connections

Update Existing Connection

Changed on

Update the caller's connection with optional revalidation

patch/connections/{connection_id}

Request

  • Base URL
    https://api.myaltimate.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.myaltimate.com/connections/{connection_id}
  • Auth
    • HTTP bearer
    • or HTTP bearer

Path parameters

connection_idinteger required

Request body

namestring nullable
integration_idstring nullable
configobject nullable
preserve_secret_fieldsstring[]

Response

Successful Response

namestring required
integration_idstring required
configobject required
idinteger required
user_idinteger required
is_validboolean required
last_validated_atstring date-time nullable
created_atstring date-time required
updated_atstring date-time nullable
privacy'private' | 'public' | 'restricted'

Sharing modes for a workspace.

Deliberately local rather than adding a member to the shared PrivacySetting, which is imported by five resources (datamates, knowledge bases, notebooks, query bookmarks, custom skills). restricted is meaningless for the other four, and widening the shared enum would make it a legal value there.

The two overlapping values keep identical strings, so rows written before this existed, and every cross-file read that compares against PrivacySetting.PUBLIC.value, still work.

Reviewers found this argument was made and then broken in the same diff: four CustomSkill schemas were swapped to this enum, which made restricted a legal value for a resource with no grant table behind it — _visible_to (crud/custom_skills.py) matches owner-or-public only, and custom_skills.privacy has no CHECK, so such a skill would persist and be permanently invisible to everyone but its creator. Custom skills are back on PrivacySetting; keep them there until they implement sharing.

is_ownerboolean
unreadable_secret_fieldsstring[]

Changes

  • 883849803623Revision changes
    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status