1. Docs
  2. API Reference
  3. Resend an invite

Resend an invite

POST/portal/v1/accounts/{accountSlug}/user-invites/{id}/resend

Resends the email for a pending invite in the active Environment, generating a fresh token, invalidating the previous one, and resetting the 7-day expiry. Returns the new tokenized accept_url. Subject to a 5-minute cooldown between resends. Returns 404 when the invite is not found and 400 when it is not in pending status or the cooldown has not elapsed.

Authentication

Bearer TokenAuthorization

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

Requires capability administrators.manageGovernance

Invite, deactivate, and remove administrators. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

idstring Required

Responses

application/json

  • dataMessageResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Returned object

MessageResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/user-invites/value/resend" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "data": {
    "message": "string"
  }
}
 Related endpoints
GETList invites
POSTCreate an invite
GETGet invite summary
PATCHChange the role a pending invite grants
DELETERevoke an invite
 Was this page helpful?

Tell us how we can improve this guide.

Canopy