Create and send a booking invite

POST

/booking-invites

Booking Invites

Last modified:2026-06-05 10:12:55

Maintainer:Not configured

Creates a personalised booking invite link for a candidate and emails it to them. The candidate uses the link to book directly without needing to enter payment details.

Duplicate detection: If an unused invite was sent to the same email within the last 30 days, the request returns 409 to prevent duplicate sends.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Invite created and email dispatched.

Bodyapplication/json

🟠409

🟠401Unauthorized

🟠422UnprocessableEntity

Request Example

Shell

JavaScript

Java

Swift

curl --location '/booking-invites' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Jane Smith",
    "email": "jane.smith@nhsstaff.co.uk",
    "cgo_name": "John Doe",
    "cgo_email": "john.doe@acme.co.uk",
    "course_id": 1,
    "training_id": 26
}'

Response Example

201 - Success

{
    "id": 101,
    "name": "Jane Smith",
    "email": "jane.smith@nhsstaff.co.uk",
    "cgo_name": "John Doe",
    "cgo_email": "john.doe@acme.co.uk",
    "invite_url": "https://tdta.hbcompliance.co.uk/practical-training/?si=abc123def456",
    "is_sent": true,
    "is_used": false,
    "course": {
        "id": 1,
        "name": "CSTF All-In-One Mandatory Practical Training"
    },
    "training_event": {
        "id": 26,
        "start_date": "2026-07-15T10:00:00+01:00"
    },
    "booking_id": null,
    "created_at": "2026-06-05T10:00:00+00:00"
}

Modified at 2026-06-05 10:12:55

List booking invites

Get a booking invite