Send Email Confirmation

POST /v1/endpoints/{uuid}/rbac/clients/{client_uuid}/email/confirmation

Email an active user a link that confirms their email address, as Confirm on their account page does. The link works for 24 hours, in a browser signed in as them. Once they open it, email_confirmed is true in Get User. Requires the endpoints:update permission in the active account.

Path parameters

uuid string (uuid) Req
The endpoint's uuid from /endpoints.
client_uuid string (uuid) Req
The user's uuid. Resolved under this endpoint only.

An integer id in the path is refused with 400 integer_id_unsupported (see public IDs). Use the uuid.

Request body

None.

Response (204 No Content)

The email is on its way.

Errors

401 Unauthorized
Missing or invalid auth.
403 Forbidden
Your role lacks endpoints:update, or you are not a member of the active account.
404 Not Found
Endpoint doesn't exist or doesn't belong to the calling account, or the user doesn't belong to this endpoint or isn't active.
409 Conflict
code no_email: the user has no email address; already_confirmed: it's confirmed already.
429 Too Many Requests
code recently_sent: an email went to this user a moment ago. They use that one (or look in spam), or you try again later. Without a code: too many confirmation emails were sent; try again later.
503 Service Unavailable
Emails can't be sent right now. Try again later.
Request
curl -X POST \ "https://api.ngris.com/v1/endpoints/019bb1e4-e785-77d2-9966-c3cff31d0a0e/rbac/clients/019b4b9d-d300-736b-8601-153b3d9f70ee/email/confirmation" \ -H "X-API-KEY: <your_api_key>"
Was this helpful?
Was this helpful?