Resend an invitation email

curl --request GET \
  --url https://web-api.dev.soxai.site/api/orgs/{org_id}/ResendInvitationEmail/{uid} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://web-api.dev.soxai.site/api/orgs/{org_id}/ResendInvitationEmail/{uid}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://web-api.dev.soxai.site/api/orgs/{org_id}/ResendInvitationEmail/{uid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "mailSended": true,
  "message": "Invitation email sent"
}

{
  "error": "http-error",
  "error_msg": "Invalid authentication credentials. <reason>"
}

{
  "error": "forbidden",
  "error_msg": "Not enough permission"
}

{
  "error": "not-found",
  "error_msg": "OrgUser '<uid>' not found"
}

{
  "error": "conflict",
  "error_msg": "OrgUser is already activated"
}

{
  "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

Resend an invitation email

Not callable with a Sandbox key

A request authenticated with a Sandbox soxai-api-key is answered 403 This endpoint is not available in the sandbox., because it would send or resolve a real email. It is published here because the Sandbox runs the same build; use it in Production. See Sandbox.

Send the invitation email again to a member who has not accepted yet.

Sending is the whole request, so a send that does not happen is reported as a failed request rather than as a 200 saying it was declined.

Parameters

org_id (path, required) - organization identifier.
uid (path, required) - the member to invite again. They must be on this organization’s roster.

Response

200 {"mailSended": true, "message": ...}. The mail itself is queued and delivered after the response is sent, so a 200 means it was accepted for sending, not that it arrived.

Errors

Status	Condition
404	The organization does not exist, or `uid` is not on its roster
409	The member is not `Invitation Pending`: they are already `Activated`, or `Closed` because they turned data sharing off, so there is no invitation to accept

Authorization

Scheme: Authorization: Bearer <idToken> or soxai-api-key: <api key>.
Accepted roles: PartnerAdmin, OrgAdmin
Admin is accepted regardless of the roles above.
PartnerAdmin reaches only an org owned by its own company; any other caller must carry an orgId claim naming exactly {org_id}.
Denials: a PartnerAdmin naming another company’s org receives 403 PartnerAdmin can change only the org that belongs to your company; a caller whose orgId claim does not name {org_id} receives 403 orgId not match; anyone else receives 403 Not enough permission.

GET

api

orgs

{org_id}

ResendInvitationEmail

{uid}

Resend an invitation email

curl --request GET \
  --url https://web-api.dev.soxai.site/api/orgs/{org_id}/ResendInvitationEmail/{uid} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://web-api.dev.soxai.site/api/orgs/{org_id}/ResendInvitationEmail/{uid}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://web-api.dev.soxai.site/api/orgs/{org_id}/ResendInvitationEmail/{uid}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "mailSended": true,
  "message": "Invitation email sent"
}

{
  "error": "http-error",
  "error_msg": "Invalid authentication credentials. <reason>"
}

{
  "error": "forbidden",
  "error_msg": "Not enough permission"
}

{
  "error": "not-found",
  "error_msg": "OrgUser '<uid>' not found"
}

{
  "error": "conflict",
  "error_msg": "OrgUser is already activated"
}

{
  "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>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

org_id

string

required

Organization ID.

Example:

"org_123"

uid

string

required

User ID.

Example:

"user_123"

Response

The invitation was accepted for sending. The mail is delivered after the response, so this does not mean it arrived.

Get started

API Reference (Sandbox)

API Reference (Production)

About

Resend an invitation email

Authorizations

Path Parameters

Response