Type Alias CreateOrganisationParams

Parameters for creating a new organisation.

type CreateOrganisationParams = {
    collaborators?: CreateOrganisationCollaborator[];
    name: string;
    owner: { address: string; name: string; role: string };
    termsAcceptedVersion?: number;
}

Index

Properties

collaborators? name owner termsAcceptedVersion?

Properties

`Optional`collaborators

collaborators?: CreateOrganisationCollaborator[]

Optional list of collaborators to invite to the organisation. Each collaborator will receive an invitation with status "Invited".

name

name: string

The display name of the organisation (1-50 characters)

Example

'My Organisation'

owner

owner: { address: string; name: string; role: string }

Details of the organisation owner (the authenticated user)

Type Declaration

address: string

Ethereum address of the owner

Example

'0x1234567890123456789012345678901234567890'

name: string
Display name of the owner
role: string
The owner's role within the organisation
Example
```
'CEO'
```

`Optional`termsAcceptedVersion

termsAcceptedVersion?: number

The version of the terms and conditions accepted. Defaults to 1.

Type Alias CreateOrganisationParams

Index

Properties

Properties

`Optional`collaborators

name

Example

owner

Type Declaration

address: string

Example

name: string

role: string

Example

`Optional`termsAcceptedVersion

Default Value

Settings

On This Page

Type Alias CreateOrganisationParams

Index

Properties

Properties

Optionalcollaborators

name

Example

owner

Type Declaration

address: string

Example

name: string

role: string

Example

OptionaltermsAcceptedVersion

Default Value

Settings

On This Page

`Optional`collaborators

`Optional`termsAcceptedVersion