Skip to main content

updateCollaborationStatus

Updates the collaboration status for an integration.

This mutation allows authorized users to change the collaboration status of an integration, typically used by system administrators or support staff to manage the collaboration workflow.

Collaboration Status Flow​

The collaboration process follows these status transitions: no_access → support_requested → pending_approval → access_approved → completed

**Note:** Moving backwards in the status flow will generate a warning log entry.

Requirements​

  • The integration must exist and belong to the current brand
  • The new status must be different from the current status
  • Valid collaboration statuses: no_access, support_requested, pending_approval, access_approved, completed

Behavior​

Upon successful update, the integration's collaboration status will be changed to the new status. If the status is being rolled back (moving to a previous state), a warning will be logged.

Possible Errors​

  • GraphQL::ExecutionError - when integration_id doesn't exist
  • IntegrationNotFoundError - when integration doesn't belong to the brand
  • NoValidStatusError - when new_status is the same as current status

**Permissions required:** system:update_collab_status

updateCollaborationStatus(
  input: UpdateCollaborationStatusInput!
): AsynchronousActionResponse!

Arguments​

updateCollaborationStatus.input ● UpdateCollaborationStatusInput! non-null input​

Parameters for UpdateCollaborationStatus

Type​

AsynchronousActionResponse object​

Asynchronous action response type