Sign in
MessageFragments

Attach an offering to a message fragment

Adds an offering to the fragment's offerings list. Once attached, the fragment will be rendered into emails whose booking contains the offering (subject to message_type and permitted_membership_type_ids filters). Adding an offering that is already attached is a no-op.

Requires the update ability on the target fragment, which is granted via the SETTINGS_MANAGE permission on the fragment's site.

post/shop/message-fragments/{messageFragmentId}/offerings

Request body

Example request

{
  "offering": {
    "offering_name": "Twilight massage",
    "offering_type": "appointment"
  }
}

Response

The message fragment was successfully retrieved.

Example response

{
  "data": {
    "id": "65d4a6f7f4c1b22a3c5d4e8a",
    "name": "Spa - arrival instructions",
    "message_type": "basket_confirmed",
    "message": "<p>Hi {{ customer.first_name }} - we're looking forward to\nseeing you on {{ booking.starts_at|date }}. Please arrive\n15 minutes early to check in at reception.</p>\n",
    "priority": 10,
    "offerings": [
      {
        "offering_name": "Twilight massage",
        "offering_type": "appointment"
      }
    ],
    "permitted_membership_type_ids": [
      "65a1c4f7f4c1b22a3c5d1234"
    ]
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.