Skip to main content

requestCollaborationSupport

Requests collaboration support for an integration setup.

This mutation initiates the collaboration process between a brand and an external system by providing a collaboration code that enables access to the external platform.

Collaboration Status Flow​

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

Requirements​

  • The integration must exist and belong to the current brand
  • The collaboration process must not already be completed
  • The same collaboration code cannot be requested twice for the same integration

Behavior​

Upon successful request, the integration's collaboration status will be updated to support_requested and the collaboration code will be stored for future use.

Possible Errors​

  • GraphQL::ExecutionError - when integration_id doesn't exist
  • ValidationError - when integration doesn't belong to the brand
  • ValidationError - when collaboration process is already completed
  • ValidationError - when collaboration support was already requested with the same code

**Permissions required:** brand:request_collaborator_support

requestCollaborationSupport(
  input: RequestCollaborationSupportInput!
): AsynchronousActionResponse!

Arguments​

requestCollaborationSupport.input ● RequestCollaborationSupportInput! non-null input​

Parameters for RequestCollaborationSupport

Type​

AsynchronousActionResponse object​

Asynchronous action response type