@kagamidigital/salt-sdk-mirror
    Preparing search index...

    Type Alias UpdateCollaboratorParams

    The changes to apply to a collaborator within an organisation. At least one field must be provided. A collaborator's address is their identity and cannot be changed here; status may be set to 'Active' to re-activate a previously removed (Inactive) collaborator, or to 'Inactive' to deactivate them without going through Salt.removeCollaborator.

    type UpdateCollaboratorParams = {
        accessLevel?: 1 | 2 | 3 | AccessRole;
        name?: string;
        role?: string;
        status?: "Active" | "Inactive";
    }
    Index

    Properties

    accessLevel? name? role? status?

    Properties

    accessLevel?: 1 | 2 | 3 | AccessRole

    The collaborator's access level — the permission tier the Salt API enforces. Accepts a number or its named AccessRole:

    • 1 / 'owner'
    • 2 / 'member'
    • 3 / 'agent'
    name?: string

    The collaborator's display name.

    'Alice'
    role?: string

    The collaborator's free-text role label. This is a display label only and has no effect on permissions — for that, use accessLevel.

    'CFO'
    status?: "Active" | "Inactive"

    Set 'Active' to re-activate a previously removed collaborator, or 'Inactive' to deactivate. Because collaborators are unique by EVM address, re-inviting a removed collaborator is not possible — use this field instead.

    'Active'

    Settings

    Member Visibility

    On This Page

    Properties