Send email invites
POST
https://backend.networked.co/api/v1/admin/community/invites/emails
✉️ Send email invites
data.success; failures appear under data.failure without failing the whole call (HTTP 200 with partial success is normal).HTTP Method
POSTEndpoint
/api/v1/admin/community/invites/emailsHeaders
| Name | Type | Required | Description |
|---|---|---|---|
| x-api-key | String | ✅ Yes | API key provided by the Networked Team. |
Request body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
| users | Array | ✅ Yes | List of invite rows. Entries without a usable email are skipped by the server. |
| users[].name | String | ✅ Yes | Invitee display name (non-empty). |
| users[].tagId | String | ✅ Yes | RoleId for which the user is to be invited into the community |
| users[].email | String | ✅ Yes | Valid email address; the invite is sent here. |
| users[].note | String | No | Optional message included with the invite. |
| monetizationPlanIds | String[] | No | Optional list of monetization plan Id's when your community uses paid plans. (User will see these plans to select and onboards from) |
Sample response
{
"data": {
"success": [
{
"email": "jane.doe@example.com",
"data": {
"inviteId": "67a1b2c3d4e5f6789012345a",
"email": "jane.doe@example.com",
"timeStamp": 1711800000000,
"user": {
"userId": "67a1b2c3d4e5f6789012345b",
"name": "Jane Doe",
"image": "",
"location": "",
"title": "",
"industries": []
}
}
}
],
"failure": []
},
"error": false,
"message": "Operation completed successfully"
}
Response interface
Response field descriptions
| Field | Type | Description |
|---|---|---|
| data.success | Array | One entry per email that was invited successfully; data is the created invite payload. |
| data.failure | Array | One entry per email that failed; inspect error for reason (validation, duplicate, permissions, etc.). |
| error | Boolean | false when the HTTP handler completes; per-email errors are in data.failure. |
| message | String | Overall outcome message from the API envelope. |
Reference
Notes
Request
Header Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://backend.networked.co/api/v1/admin/community/invites/emails' \
--header 'x-api-key: <your-api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
"users": [
{
"name": "Jane Doe",
"tagId": "69baa36beddb9f0012fdf101",
"email": "jane.doe@yopmail.com",
"note": "We would love to have you join our community."
}
],
"monetizationPlanIds": []
}'Response Response Example
{
"data": {
"success": [],
"failure": [
{
"email": "jane.doe@yopmail.com",
"error": {}
}
]
},
"error": false,
"message": "Operation completed successfully"
}Modified at 2026-05-15 10:46:46