Skip to main content
POST
TypeScript (SDK)

Authorizations

tql_api_key
string
header
required

Headers

Connect-Protocol-Version
enum<number>
default:1
required

Define the version of the Connect protocol

Available options:
1
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
memberEmail
string | null

Email within the caller's organization; case-insensitive, with outer whitespace ignored. Use instead of member_id; if both are supplied they must identify the same member.

roleName
string | null

Exact, case-sensitive role name in the caller's organization. To target a role, supply role_name or role_id; if both are supplied they must match.

objectType
string
objectId
string
memberId
string | null
roleId
string | null

Legacy role ID. Prefer role_name.

Response

Success

success
boolean