Revoke workspace invitation
const url = 'https://api.shypr.app/rest/workspaces/invitations/revoke';const options = { method: 'POST', headers: {'X-API-KEY': '<X-API-KEY>', 'Content-Type': 'application/json'}, body: '{"invitationId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.shypr.app/rest/workspaces/invitations/revoke \ --header 'Content-Type: application/json' \ --header 'X-API-KEY: <X-API-KEY>' \ --data '{ "invitationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'Creates a WorkspaceInvitation resource.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”The new WorkspaceInvitation resource
An invitation to the team of a workspace. An admin sends it to an email address. The person accepts it on the auth host: with a new account, or with the account that already has the address. The invitation goes away when it is accepted or revoked.
Only the hash of the token is in the database, as with the reset token of UserAccount.
object
Example generated
{ "invitationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}An invitation to the team of a workspace. An admin sends it to an email address. The person accepts it on the auth host: with a new account, or with the account that already has the address. The invitation goes away when it is accepted or revoked.
Only the hash of the token is in the database, as with the reset token of UserAccount.
object
Responses
Section titled “Responses”WorkspaceInvitation resource created
Invalid input
A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "status": 400}A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "status": 400}Forbidden
A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "status": 400}A representation of common errors.
object
A short, human-readable summary of the problem.
A human-readable explanation specific to this occurrence of the problem.
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
A URI reference that identifies the problem type
Example
{ "status": 400}An error occurred
Unprocessable entity
object
object
The property path of the violation
The message associated with the violation
The code of the violation
An extra hint to understand the violation
The serialized payload of the violation
object
Example
{ "status": 422}Unprocessable entity
object
object
The property path of the violation
The message associated with the violation
The code of the violation
An extra hint to understand the violation
The serialized payload of the violation
object
Example
{ "status": 422}