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.
/v2/Path parameters
accountIdstringrequired
The account the request is scoped to.
Request body
emailstring (email)required
Address to invite; receives an invitation or added-to-team email.
Response
Invitation sent.
Errors
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 --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]"
}'
const res = await fetch('https://api.sendstreak.com/v2/accounts/YOUR_ACCOUNT_ID/users', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.SENDSTREAK_TOKEN}`,
'Content-Type': 'application/json'
},
body: JSON.stringify({
"email": "[email protected]"
})
});
import os, requests
res = requests.post(
'https://api.sendstreak.com/v2/accounts/YOUR_ACCOUNT_ID/users',
headers={'Authorization': f"Bearer {os.environ['SENDSTREAK_TOKEN']}"},
json={
"email": "[email protected]"
},
)
No response body.