Shop API icon

Shop API

Call Shop API

Prospects → Book

AI-generated

Summary

Book a prospect for an agent by sending a booking request with the prospect's ID and the agent's ID, which associates the prospect with the agent unless re-booking is blocked.

Inputs

  • Id (required) — The unique identifier of the prospect to be booked.
  • Agent Id (required) — The identifier of the agent that books the prospect, sent as a query parameter (agentId).

Output shape

a single JSON object containing the booking confirmation or error information.

Returns a JSON response from the API indicating success or failure of the booking operation. If booking is blocked due to anti re-booking rules, a 409 error is expected.

Links

Discussion