External invitations
People outside of the Starmind network can be invited via their email-addresses through these Endpoints. Invitations always happen in behalf of the issuing user, including his profile-picture.
Attention: No content information will ever be revealed outside of the network via these endpoints. When sharing content, or recommending someone as an expert, direct links to corresponding entities (like questions or solutions) will be contained in the email.
If invitation_email_allowed_domains are specified, it is not possible to send external invitations to email addresses whose domain is not listed in that setting.
Join invitation
POST /external/invitation
Sends a request for joining Starmind to one or more external recipients.
Request
| Parameter | Type | Default | Required | Description |
|---|---|---|---|---|
recipients |
Array |
- | ✓ | List of email-addresses to invite. |
message |
String |
- | ✗ | Message to accompany the external invite. |
Response
HTTP 200 OK with an empty body.
Share question invitation
POST /external/invitation/share/question/:questionId
Shares a link to a question with one or more external recipients.
Request
| Parameter | Type | Default | Required | Description |
|---|---|---|---|---|
recipients |
Array |
- | ✓ | List of email-addresses to share question-link with. |
message |
String |
- | ✗ | Message to accompany the external question shares. |
Response
HTTP 200 OK with an empty body.
Share solution invitation
POST /external/invitation/share/solution/:solutionId
Shares a link to a solution with one or more external recipients.
Request
| Parameter | Type | Default | Required | Description |
|---|---|---|---|---|
recipients |
Array |
- | ✓ | List of email-addresses to share solution-link with. |
message |
String |
- | ✗ | Message to accompany the external solution shares. |
Response
HTTP 200 OK with an empty body.
Recommend expert invitation
POST /external/invitation/recommend/:questionId
Recommends one or more external recipients as experts for a question
Request
| Parameter | Type | Default | Required | Description |
|---|---|---|---|---|
recipients |
Array |
- | ✓ | List of email-addresses to recommend as experts. |
message |
String |
- | ✗ | Message to accompany the external expert recommendations. |
Response
HTTP 200 OK with an empty body.