Update interaction event

PUT /api/experience/interaction-event

Update the current experience interaction event to the given event type. This API is used to switch the interaction event between SignIn and Register, while keeping all the verification records data.

application/json

Body Required

  • interactionEvent string Required

    The type of the interaction event. Only SignIn and Register are supported.

    Values are SignIn, Register, or ForgotPassword.

Responses

  • 204

    The interaction event has been successfully updated.

  • 400

    The interaction event is invalid or cannot be updated. Only SignIn and Register are interchangeable. If the current interaction event is ForgotPassword, it cannot be updated.

  • 403

    The given interaction event is not enabled in the sign-in experience settings.

PUT /api/experience/interaction-event 
curl \
 -X PUT https://[tenant_id].logto.app/api/experience/interaction-event \
 -H "Content-Type: application/json" \
 -d '{"interactionEvent":"SignIn"}'
Request examples 
{
  "interactionEvent": "SignIn"
}