Skip to main content

addConsumerToOrganisationFolder

Add a consumer connection to a folder of service provider organisation. When the consumer is not known in the organisation, a connection request will be sent.

Possible exception(s) that can be thrown:

  • Validation Exception when the consumer connection with the requested email is already added to folder
  • Validation Exception when the consumer role requested is not configured for the journey type of the folder
addConsumerToOrganisationFolder(
  organisationId: ID!
  folderId: ID!
  consumerFolderDetails: [ConsumerFolderDetailsInput]
): ID!

Arguments​

addConsumerToOrganisationFolder.organisationId ● ID! non-null scalar​

addConsumerToOrganisationFolder.folderId ● ID! non-null scalar​

addConsumerToOrganisationFolder.consumerFolderDetails ● [ConsumerFolderDetailsInput] list input​

Type​

ID scalar​

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.