Invitations
Invitations
Send a Sample
Sample invitations are example of invitations emails that are sent to current authenticated user's email. Use it to see how the email looks like before sending to other users.
- Authentication: Required
- Required Role: Collaborator or Administrator
POST /api/v1/invitations/sample
Parameters
| Name | Type | Description |
|---|---|---|
subject | number | Required. The subject of the email to be sent. |
message | string | Required. The content of the email to be sent. The message must include the %invite% placeholder, which will be replaced a secure invitation link. |
Example
POST <baseURL>/api/v1/invitations/sample
---
{
"subject": "Share your ideas and thoughts about Fider",
"message": "Hi,\n\nAt **Fider** we take feedback very seriously, which is why we've launched a space where you can vote, discuss and share your ideas and thoughts about our products and services.\n\nWe'd like to extend an invite for you to join this community and raise awareness on topics you care about!\n\nTo join, click on the link below.\n\n%invite%\n\nRegards,\nFider"
}
Response
200 OK
---
{}
Send an Invite
- Authentication: Required
- Required Role: Collaborator or Administrator
POST /api/v1/invitations/send
Parameters
| Name | Type | Description |
|---|---|---|
recipients | array of strings | Required. The list of email addresses to send an invite. |
subject | string | Required. The subject of the email to be sent. |
message | string | Required. The content of the email to be sent. The message must include the %invite% placeholder, which will be replaced a secure invitation link. |
Example
POST <baseURL>/api/v1/invitations/send
---
{
"recipients":["jon.snow@got.com","arya.stark@got.com"],
"subject": "Share your ideas and thoughts about Fider",
"message": "Hi,\n\nAt **Fider** we take feedback very seriously, which is why we've launched a space where you can vote, discuss and share your ideas and thoughts about our products and services.\n\nWe'd like to extend an invite for you to join this community and raise awareness on topics you care about!\n\nTo join, click on the link below.\n\n%invite%\n\nRegards,\nFider"
}
Response
200 OK
---
{}