Infomaniak Mail icon

Infomaniak Mail

Interact with Infomaniak Mail API

Actions118

Mailboxes → Request Password Reset

AI-generated

Summary

Sends a password reset request to an Infomaniak mailbox

Inputs

  • authentication — Authentication method to use for the API request
  • path_mail_hosting_id (required) — Identifier for the mail hosting account
  • path_mailbox_name (required) — Name of the mailbox to target
  • body_type (required) — Type of password reset request. email: sent to specified email address. email_reminder: sent to designated backup email address. phone: sent to specified phone number. phone_reminder: sent to designated backup phone number. token: returns a token in the HTTP response
  • bodyParameters — Optional additional fields for the request body. Available: body_email (string), body_phone (string), body_user_id (number)
  • returnFullResponse — If true, the full API response is returned as a workflow item instead of just the operation result

Output shape

When body_type is set to 'token', the HTTP response includes a token field. If returnFullResponse is enabled, the complete API response payload is returned as a workflow item. Otherwise, the operation confirms the request was processed.

The actual API call is routed through the infomaniakApiRequest helper, using the provided mail hosting ID and mailbox name as path parameters, and the selected body_type plus optional bodyParameters as the request payload.

Links

Discussion