integrations
integration-connections

Update Integration Connection

Update an integration connection's name and/or scope.

put/v1/integrations/connection/{integration_connection_id}

Request

  • Base URL
    https://api.mentium.io (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

integration_connection_idstring uuid required

Headers

mentium-workspace-idstring nullable

Request body

namestring nullable
scope'ORGANIZATION' | 'WORKSPACE' | 'USER'
contributes_to_carrier_poolboolean nullable
preferred_load_identifier'EXTERNAL_REFERENCE_ID' | 'TMS_DISPLAY_REFERENCE_ID'
past_pickup_grace_daysinteger nullable
equipment_length_feetobject nullable
default_equipment_length_feetinteger nullable

Response

Successful Response

idstring required
integration_idstring required
organization_idstring required
workspace_idstring nullable
user_idstring nullable
secret_idstring required
namestring nullable
paramsobject nullable
connected_with_deployed_workflowboolean
contributes_to_carrier_poolboolean
preferred_load_identifier'EXTERNAL_REFERENCE_ID' | 'TMS_DISPLAY_REFERENCE_ID'
past_pickup_grace_daysinteger
equipment_length_feetobject
default_equipment_length_feetinteger nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.