Skip to content

Send a friend invite

Invites someone to connect by email address.

POST
/v1/invites
curl --request POST \
--url https://api.shiftsync.app/v1/invites \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "emailAddress": "user@example.com" }'
Media typeapplication/json
object
emailAddress
required
string format: email
/^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/
Example
{
"emailAddress": "user@example.com"
}

Invite sent

Media typeapplication/json
object
success
required
boolean
Example
{
"success": true
}