mutation · Module: Accounts · Requires accounts:write
Arguments
Returns
Invitation!
Errors
Errors are returned inerrors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
mutation RevokeInvitation($id: ID!) {
revokeInvitation(id: $id) {
id
object
status
livemode
created
updated
account
email
role
expires_at
membership
}
}
{
"id": "inv_1a2B3c"
}
{
"data": {
"revokeInvitation": {
"id": "inv_1a2B3c",
"object": "invitation",
"status": "pending",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"account": "acct_ada",
"email": "ops@example.com",
"role": "example",
"expires_at": 1791302400,
"membership": "example"
}
}
}
Revoke an invitation
mutation RevokeInvitation($id: ID!) {
revokeInvitation(id: $id) {
id
object
status
livemode
created
updated
account
email
role
expires_at
membership
}
}
{
"id": "inv_1a2B3c"
}
{
"data": {
"revokeInvitation": {
"id": "inv_1a2B3c",
"object": "invitation",
"status": "pending",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"account": "acct_ada",
"email": "ops@example.com",
"role": "example",
"expires_at": 1791302400,
"membership": "example"
}
}
}
mutation · Module: Accounts · Requires accounts:write
| Argument | Type | Description |
|---|---|---|
id | ID! | The object’s ID. |
Invitation!
| Field | Type |
|---|---|
id | String! |
object | InvitationObject! |
livemode | Boolean! |
created | Int! |
updated | Int |
account | String |
email | String! |
role | String! |
status | InvitationStatus! |
expires_at | Int |
membership | String |
user_metadata | UserMetadata |
carrier_metadata | CarrierMetadata |
system_metadata | SystemMetadata |
errors[], with the REST error object in extensions (type, code, param, request_id), using the codes in Conventions §9.
mutation RevokeInvitation($id: ID!) {
revokeInvitation(id: $id) {
id
object
status
livemode
created
updated
account
email
role
expires_at
membership
}
}
{
"id": "inv_1a2B3c"
}
{
"data": {
"revokeInvitation": {
"id": "inv_1a2B3c",
"object": "invitation",
"status": "pending",
"livemode": true,
"created": 1791302400,
"updated": 1791302400,
"account": "acct_ada",
"email": "ops@example.com",
"role": "example",
"expires_at": 1791302400,
"membership": "example"
}
}
}