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

Resend an invite

POST/api/v1/identity-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 Option A

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

API KeyX-API-Key Option B

API key for management-tier access. Never send alongside an Authorization header: a request carrying both is refused.

Path Parameters

idstring Required

Responses

application/json

  • dataApiIdentityInviteResendResponseDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Returned object

ApiIdentityInviteResendResponseDtoView all properties on this resource
Request
curl -X POST "https://auth.canopy-io.com/api/v1/identity-invites/value/resend" \
  -H "X-API-Key: $CANOPY_API_KEY"
Response
{
  "data": {
    "message": "string",
    "accept_url": "string"
  }
}
 Related endpoints
GETList invites
POSTCreate an invite
GETGet invite summary
POSTBulk-create invites
DELETERevoke an invite
 Was this page helpful?

Tell us how we can improve this guide.

Canopy