Resend Invitation via API
This method allows you to resend an invitation email to a user who has not yet accepted their invitation.
Tip: You can explore and test this endpoint interactively using our OpenAPI documentation.
URL
/users/:identifier/resend_invitation
HTTP Method
POST
Supported Parameters
This endpoint does not accept any parameters. The user identifier (UUID) is specified in the URL.
Example cURL Request
curl -H "Content-type: application/json" \
-H "Accept: application/json" \
--user adam@atechmedia.com:my-api-key \
-X POST \
https://test.deployhq.com/users/9e11def8-8c43-454e-8c99-3c5b9cf08396/resend_invitation
Example Response
A successful request returns an HTTP 200 status:
{
"status": "ok"
}
If the user has already accepted their invitation, the API returns HTTP 422:
{
"error": "User already activated"
}
Notes
- The
:identifierin the URL is a UUID that uniquely identifies the user - This endpoint only works for users who have not yet accepted their invitation
- A new invitation email will be sent to the user's email address