sendEmailToFriend mutation

Use the sendEmailToFriend mutation to allow Magento to send a message on behalf of a customer to the specified email addresses.

The Stores > Configuration > Catalog > Email to a friend > Enabled field must be set to Yes to implement this mutation.

Syntax

1
2
3
4
5
6
7
mutation {
  sendEmailToFriend(
    input: SendEmailToFriendInput
  ) {
    SendEmailToFriendOutput
  }
}

Example usage

The following example sends a message to two friends.

Request:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
mutation {
  sendEmailToFriend(
    input: {
      product_id: 10
      sender: {
        name: "Veronica Cost"
        email: "roni_cost@example.com"
        message: "Sarah needs this! http://luma.example.com/savvy-shoulder-tote.html"
      }
      recipients: [
        { name: "Amie Franklin", email: "afranklin@example.com" }
        { name: "Tomoko", email: "tomoko@example.com" }
      ]
    }
  ) {
    sender {
      name
      email
    }
    recipients {
      name
      email
    }
  }
}

Response:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
  "data": {
    "sendEmailToFriend": {
      "sender": {
        "name": "Veronica Cost",
        "email": "roni_cost@example.com",
      },
      "recipients": [
        {
          "name": "Amie Franklin",
          "email": "afranklin@example.com"
        },
        {
          "name": "Tomoko",
          "email": "tomoko@example.com"
        }
      ]
    }
  }
}

Input attributes

The SendEmailToFriendInput object contains the following attributes:

SendEmailToFriendRecipientInput object

The SendEmailToFriendRecipientInput object must contain the following attributes:

SendEmailToFriendSenderInput object

The SendEmailToFriendSenderInput object must contain the following attributes:

Output attributes

The SendEmailToFriendOutput object contains the following attributes:

SendEmailToFriendRecipient object

The SendEmailToFriendRecipientInput object can contain the following attributes:

SendEmailToFriendSender object

The SendEmailToFriendSender object can contain the following attributes:

Errors

Some errors occur because the Email a friend feature is not properly configured. Go to Stores > Configuration > Catalog > Email to a friend in the Admin to adjust the settings.