---
title: "Share payment link"
method: POST
path: "/payment-links/{paymentLinkId}/sharing-events"
tags: ["sharingEvents"]
---

# Share payment link

`POST /payment-links/{paymentLinkId}/sharing-events`

Use this method to email a payment link to a customer.  

To email a payment link, you need its paymentLinkId. Our gateway returned the paymentLinkId in the response of the [Create Payment Link](https://docs.payroc.com/api/schema/payment-links/create) method.  

**Note:** If you don't have the paymentLinkId, use our [List Payment Links](https://docs.payroc.com/api/schema/payment-links/list) method to search for the payment link.  

In the request, you must provide the recipient's name and email address.  

In the response, our gateway returns a sharingEventId, which you can use to [List Payment Link Sharing Events](https://docs.payroc.com/api/schema/payment-links/sharing-events/list).

## Path parameters

- `paymentLinkId` string, required

## Headers

- `Authorization` string, required
- `Idempotency-Key` string, uuid, required

## Request body

- PaymentLinksSharingEventsShareRequest — Object that contains the information about a sharing event that the merchant sent by email.
  - `sharingMethod` 'email', required — Method that the merchant uses to share the payment link.
  - `sharingEventId` string — Unique identifier that we assigned to the sharing event.
  - `dateTime` string, date-time — Date and time that the merchant shared the link. Our gateway returns this value in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
  - `merchantCopy` boolean — Indicates if we send a copy of the email to the merchant. By default, we don't send a copy to the merchant.
  - `message` string — Message that the merchant sends with the payment link.
  - `recipients` PaymentLinkEmailRecipient[], required — Array that contains the recipients of the payment link.
    - `name` string, required — Recipient's name.
    - `email` string, required — Recipient's email address.

## Response `201`

Successful request. We return a polymorphic object that contains information about how the merchant shared a payment link.

- PaymentLinksSharingEventsShareResponse201 — Object that contains the information about a sharing event that the merchant sent by email.
  - `sharingMethod` 'email', required — Method that the merchant uses to share the payment link.
  - `sharingEventId` string — Unique identifier that we assigned to the sharing event.
  - `dateTime` string, date-time — Date and time that the merchant shared the link. Our gateway returns this value in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
  - `merchantCopy` boolean — Indicates if we send a copy of the email to the merchant. By default, we don't send a copy to the merchant.
  - `message` string — Message that the merchant sends with the payment link.
  - `recipients` PaymentLinkEmailRecipient[], required — Array that contains the recipients of the payment link.
    - `name` string, required — Recipient's name.
    - `email` string, required — Recipient's email address.

## Other responses

- `400` — Invalid request
- `401` — Identity could not be verified
- `403` — Do not have permissions to perform this action
- `404` — Resource not found
- `406` — Not acceptable
- `409` — Conflict
- `415` — Unsupported media type
- `500` — An error has occured

---

[API](https://skmtc.dev/payroc/apis/schema.md) · [All operations](https://skmtc.dev/payroc/apis/schema/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/payroc/schema/revisions/1d9d3e305945/schema)