@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 moves them through the collaborator lifecycle, within the transitions the Salt API allows.

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

    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" | "Suspended" | "Invited"

    The collaborator's lifecycle status. The Salt API checks the new status against the one it has on record and rejects anything outside these transitions:

    • 'Invited' → 'Inactive' (revoke a pending invitation)
    • 'Active' → 'Suspended' | 'Inactive'
    • 'Suspended' → 'Active' | 'Inactive'
    • 'Inactive' → 'Invited' (re-invite a removed collaborator)
    • 'Declined' → 'Invited' (re-invite someone who declined)

    Because collaborators are unique by EVM address, re-inviting a removed collaborator through Salt#inviteCollaborator is not possible — set 'Invited' here instead, which sends them a fresh invitation.

    'Declined' cannot be set: accepting or declining an invitation belongs to the invitee alone, so an owner can move nobody out of 'Invited' other than by revoking it with 'Inactive'.

    'Active'