Accept an organization invitation
curl --request GET \
--url https://web-api.soxai.site/api/AcceptEmailVerification/{token}import requests
url = "https://web-api.soxai.site/api/AcceptEmailVerification/{token}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://web-api.soxai.site/api/AcceptEmailVerification/{token}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"msg": "success"
}{
"error": "unprocessable-entity",
"error_msg": "body.<field>: <validation message>"
}{
"error": "rate-limited",
"error_msg": "Rate limit exceeded. Retry after <n> seconds."
}{
"error": "internal-server-error",
"error_msg": "Failed to fetch data: <error_message>"
}Organization Members
Accept an organization invitation
Accept an organization invitation from the link in the invitation
email. The invited member’s status changes from Invitation Pending to Activated, which is
what makes their data visible to that organization’s admins.
Parameters
token(path, required) - the token carried by the invitation link. It is not consumed by accepting and stays usable until it expires.
Response
200{"msg": "success"}once the invitation is accepted. Accepting twice is harmless and answers the same way.
Errors
- None. A token that is invalid, expired or missing a usable member or organization id
is also a
200, carrying{"msg": "write failed"}, and so is a failure to save the acceptance. The link is opened by a mail client, so the page must not turn a bad token into an error page; checkmsgrather than the status code.
Authorization
- No authentication. The token in the link is the credential, so the invited user does not have to be signed in to accept.
GET
/
api
/
AcceptEmailVerification
/
{token}
Accept an organization invitation
curl --request GET \
--url https://web-api.soxai.site/api/AcceptEmailVerification/{token}import requests
url = "https://web-api.soxai.site/api/AcceptEmailVerification/{token}"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://web-api.soxai.site/api/AcceptEmailVerification/{token}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"msg": "success"
}{
"error": "unprocessable-entity",
"error_msg": "body.<field>: <validation message>"
}{
"error": "rate-limited",
"error_msg": "Rate limit exceeded. Retry after <n> seconds."
}{
"error": "internal-server-error",
"error_msg": "Failed to fetch data: <error_message>"
}Response
The invitation is accepted. A token that is invalid, expired or missing a usable member or organization id, and a failure to save the acceptance, are also a 200, carrying msg write failed, because the link is opened by a mail client and must not become an error page.