Send Appointment payment link to the client

Request

Sends the Appointment's online payment link to the client through the Location's notification channels (the channel cascade configured for the payment link notification) and by email when the client has one. Use Get Appointment payment link to deliver the link yourself instead.

The payment link notification template must be active in the Location's notification settings; otherwise the request fails. The Business User needs the permission to send messages to clients.

Security

BearerPartnerUser

Path

location_idintegerrequired

Location ID

Example:4564

record_idintegerrequired

Appointment ID

Example:671726526

Acceptstringrequired

Default:"application/vnd.api.v2+json"

Content-Typestringrequired

Default:"application/json"

Authorizationstringrequired

Bearer {partner_token}, User {user_token}

curl -i -X POST \
  https://developer.alteg.io/_mock/en/b2b-v1/openapi/locations/4564/appointments/671726526/payment_link/send \
  -H 'Accept: application/vnd.api.v2+json' \
  -H 'Authorization: Bearer <YOUR_Bearer {PartnerToken}, User {UserToken}_HERE>' \
  -H 'Content-Type: application/json'

Responses

Accepted. The notification is queued for delivery.

Bodyapplication/json

successboolean

datanull

metaobject

Response

{
  "success": true,
  "data": null,
  "meta": {
    "message": "The notification will be sent to the client"
  }
}