Schema Documentation

SendPasswordResetEmailPayload

Description

The payload for the sendPasswordResetEmail mutation.

Fields
Field NameDescription
clientMutationId - String If a 'clientMutationId' input is provided to the mutation, it will be returned as output on the mutation. This ID can be used by the client to track the progress of mutations and catch possible duplicate mutation submissions.
success - Boolean Whether the mutation completed successfully. This does NOT necessarily mean that an email was sent.
user - User The user that the password reset email was sent to This field will be removed in a future version of WPGraphQL
Example
{"clientMutationId":"abc123","success":true,"user":User}