menu
Invite a user
Invites a user to the account by email. Registered SendStreak users are added to the team immediately; unknown addresses receive an invitation email with a signup link. Invitations are limited per address and per account to protect recipients from repeat emails.
Endpoint
POST https://api.sendstreak.com/v2/accounts/{accountId}/users
All v2 endpoints require a bearer token - see Authentication.
Path parameters
| Parameter | Type | Description |
|---|---|---|
accountId | string | The account the request is scoped to. |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
email | string (email) | yes | Address to invite; receives an invitation or added-to-team email. |
Response
Invitation sent.
Errors
| Status | Description |
|---|---|
400 | The request body or parameters failed validation. |
401 | Missing or invalid token, or the token is not authorized for this account/user. |
404 | The requested resource does not exist. |
429 | Invitations are limited: re-inviting the same address within 24 hours, or starting more than 20 invitations per account per 24 hours. |
See Errors and rate limits for what error responses look like.
Curl example
curl --location --request POST 'https://api.sendstreak.com/v2/accounts/YOUR_ACCOUNT_ID/users' \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
"email": "[email protected]"
}'