SIsignalshq
SETTINGS

Change the role a pending invitation will grant

patch/internal/api/settings/team/invites/{invite_id}

Request

  • Base URL
    https://api.signalshq.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: /auth/login

Path parameters

invite_idstring uuid required

Request body

role'OWNER' | 'ADMIN' | 'USER' | 'SUPER_ADMIN' | 'REVIEWER' | 'PREPARER' | 'MANAGER' required

Response

Successful Response

idstring uuid required
type'user' | 'invite' required

Discriminates the two sources merged into one roster row.

The client keys rows on f"{type}:{id}" and otherwise never needs to know that users and invites are separate tables.

emailstring required
namestring nullable
role'OWNER' | 'ADMIN' | 'USER' | 'SUPER_ADMIN' | 'REVIEWER' | 'PREPARER' | 'MANAGER' required
status'ACTIVE' | 'INACTIVE' | 'SUSPENDED' | 'INVITED' | 'EXPIRED' required

Roster status — the union of user status and invite lifecycle.

last_login_atstring date-time nullable
created_atstring date-time required
invite_expires_atstring date-time nullable
is_selfboolean

Changes

No recorded changes to this operation across all 1 revision of this API.