Sign in

v1

latestOpenAPI 3.0.4MIT License2026-07-236622149.8 KB
Get into Teaching

Perform a matchback operation to retrieve a pre-populated GetIntoTeachingCallback for the candidate.

Attempts to matchback against a known candidate and returns a pre-populated GetIntoTeachingCallback if a match is found.

post/api/get_into_teaching/callbacks/matchback

Request body

firstNamestring nullable
lastNamestring nullable
emailstring email required
dateOfBirthstring date-time nullable
referencestring nullable

Response

OK

candidateIdstring uuid nullable
acceptedPolicyIdstring uuid required
emailstring required
firstNamestring required
lastNamestring required
addressTelephonestring required
phoneCallScheduledAtstring date-time required
talkingPointsstring required
creationChannelSourceIdinteger nullable
creationChannelServiceIdinteger nullable
creationChannelActivityIdinteger nullable
defaultContactCreationChannelinteger nullable
defaultCreationChannelSourceIdinteger nullable
defaultCreationChannelServiceIdinteger nullable
defaultCreationChannelActivityIdinteger nullable