{"items":[{"type":"link","fsPath":"general/welcome.md","metadata":{"type":"markdown"},"label":"Welcome","link":"/general/welcome","routeSlug":"/general/welcome","icon":"/assets/home.b7cf062f5cc16be59a93ce1ac0fe868b7f022fecde15c463eadf96529c41cb9f.eb5cabde.svg"},{"type":"group","label":"Documentation","items":[{"type":"link","fsPath":"general/about-closelink.md","metadata":{"type":"markdown"},"label":"About Closelink","link":"/general/about-closelink","routeSlug":"/general/about-closelink"},{"type":"link","fsPath":"general/glossary.md","metadata":{"type":"markdown"},"label":"Glossary","link":"/general/glossary","routeSlug":"/general/glossary"},{"type":"link","fsPath":"general/order-flow.md","metadata":{"type":"markdown"},"label":"Order flow","link":"/general/order-flow","routeSlug":"/general/order-flow"}],"selectFirstItemOnExpand":true,"icon":"/assets/book-2.994785813a7efb621e0d4c7a93efd5b7f763adac3a3fd606a1bcda83e4a1dc0e.eb5cabde.svg"},{"type":"group","label":"Public API","items":[{"type":"link","fsPath":"publicapi/getting-started.md","metadata":{"type":"markdown"},"label":"Getting started","link":"/publicapi/getting-started","routeSlug":"/publicapi/getting-started","icon":"/assets/player-play.0d3a139786c5d8b2551eae34dbf8aef65aa1b16a1521c76cd154e2049c0735c1.eb5cabde.svg"},{"type":"link","label":"Closelink Public API","link":"/publicapi/publicapi","routeSlug":"/publicapi/publicapi"},{"type":"separator","label":""},{"type":"group","label":"Remaining On Board","link":"/publicapi/publicapi/remaining-on-board","routeSlug":"/publicapi/publicapi/remaining-on-board","items":[{"label":"Update remaining on board information","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/remaining-on-board/createremainingonboard","routeSlug":"/publicapi/publicapi/remaining-on-board/createremainingonboard","metadata":{"seo":{"title":"Update remaining on board information","description":"Update remaining on board information"}},"httpPath":"/v1/remaining-on-board"},{"label":"Import remaining on board information by vessel","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/remaining-on-board/importremainingonboard","routeSlug":"/publicapi/publicapi/remaining-on-board/importremainingonboard","metadata":{"seo":{"title":"Import remaining on board information by vessel","description":"Import remaining on board information by vessel"}},"httpPath":"/v1/remaining-on-board/import"}]},{"type":"group","label":"Port Calls","link":"/publicapi/publicapi/port-calls","routeSlug":"/publicapi/publicapi/port-calls","items":[{"label":"Update future port calls (Overrides all future port calls)","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/port-calls/updateportcalls","routeSlug":"/publicapi/publicapi/port-calls/updateportcalls","metadata":{"seo":{"title":"Update future port calls (Overrides all future port calls)","description":"Update future port calls (Overrides all future port calls)"}},"httpPath":"/v1/port-calls"},{"label":"Import vessel schedules with reset support","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/port-calls/importportcalls","routeSlug":"/publicapi/publicapi/port-calls/importportcalls","metadata":{"seo":{"title":"Import vessel schedules with reset support","description":"Import vessel schedules with reset support"}},"httpPath":"/v1/port-calls/import"}]},{"type":"group","label":"Ports","link":"/publicapi/publicapi/ports","routeSlug":"/publicapi/publicapi/ports","items":[{"label":"Get port","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/ports/getport","routeSlug":"/publicapi/publicapi/ports/getport","metadata":{"seo":{"title":"Get port","description":"Get port by id"}},"httpPath":"/v1/ports/{portId}"},{"label":"Find port","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/ports/findport","routeSlug":"/publicapi/publicapi/ports/findport","metadata":{"seo":{"title":"Find port","description":"Find port by name or locode"}},"httpPath":"/v1/ports/find"}]},{"type":"group","label":"Vessels","link":"/publicapi/publicapi/vessels","routeSlug":"/publicapi/publicapi/vessels","items":[{"label":"Query for multiple vessels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/vessels/getvessels","routeSlug":"/publicapi/publicapi/vessels/getvessels","metadata":{"seo":{"title":"Query for multiple vessels","description":"Query for multiple vessels"}},"httpPath":"/v1/vessels"},{"label":"Find vessel by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/vessels/getvessel","routeSlug":"/publicapi/publicapi/vessels/getvessel","metadata":{"seo":{"title":"Find vessel by ID","description":"Find vessel by ID"}},"httpPath":"/v1/vessels/{vesselId}"}]},{"type":"group","label":"Vessel Tanks","link":"/publicapi/publicapi/vessel-tanks","routeSlug":"/publicapi/publicapi/vessel-tanks","items":[{"label":"Create or update vessel tanks","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/vessel-tanks/updatevesseltanks","routeSlug":"/publicapi/publicapi/vessel-tanks/updatevesseltanks","metadata":{"seo":{"title":"Create or update vessel tanks","description":"Create or update vessel tanks"}},"httpPath":"/v1/vessel-tanks/{vesselId}"},{"label":"Find vessel tanks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/vessel-tanks/getvesseltanksbyvesselid","routeSlug":"/publicapi/publicapi/vessel-tanks/getvesseltanksbyvesselid","metadata":{"seo":{"title":"Find vessel tanks","description":"Find vessel tanks"}},"httpPath":"/v1/vessel-tanks"}]},{"type":"group","label":"Integration Event Messages","link":"/publicapi/publicapi/integration-event-messages","routeSlug":"/publicapi/publicapi/integration-event-messages","items":[{"label":"Send an integration event","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/integration-event-messages/sendmessage","routeSlug":"/publicapi/publicapi/integration-event-messages/sendmessage","metadata":{"seo":{"title":"Send an integration event","description":"Send an integration event"}},"httpPath":"/v1/integration-events"}]},{"type":"group","label":"Enquiries","link":"/publicapi/publicapi/enquiries","routeSlug":"/publicapi/publicapi/enquiries","items":[{"label":"Find enquiry by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/enquiries/findenquirybyid","routeSlug":"/publicapi/publicapi/enquiries/findenquirybyid","metadata":{"seo":{"title":"Find enquiry by ID","description":"Find enquiry by ID"}},"httpPath":"/v1/enquiries/{enquiryId}"},{"label":"Update enquiry by ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/enquiries/updateenquirybyid","routeSlug":"/publicapi/publicapi/enquiries/updateenquirybyid","metadata":{"seo":{"title":"Update enquiry by ID","description":"Update enquiry by ID"}},"httpPath":"/v1/enquiries/{enquiryId}"},{"label":"Delete enquiry by ID","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/enquiries/deleteenquirybyid","routeSlug":"/publicapi/publicapi/enquiries/deleteenquirybyid","metadata":{"seo":{"title":"Delete enquiry by ID","description":"Delete enquiry by ID"}},"httpPath":"/v1/enquiries/{enquiryId}"},{"label":"Create enquiry","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/enquiries/createenquiry","routeSlug":"/publicapi/publicapi/enquiries/createenquiry","metadata":{"seo":{"title":"Create enquiry","description":"Create enquiry"}},"httpPath":"/v1/enquiries"},{"label":"Get enquiry internal files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/enquiries/getenquiryinternalfiles","routeSlug":"/publicapi/publicapi/enquiries/getenquiryinternalfiles","metadata":{"seo":{"title":"Get enquiry internal files","description":"Get enquiry internal files"}},"httpPath":"/v1/enquiries/{enquiryId}/internal-files"},{"label":"Upload enquiry internal file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/enquiries/uploadenquiryinternalfile","routeSlug":"/publicapi/publicapi/enquiries/uploadenquiryinternalfile","metadata":{"seo":{"title":"Upload enquiry internal file","description":"Upload enquiry internal file"}},"httpPath":"/v1/enquiries/{enquiryId}/internal-files"},{"label":"Upload enquiry file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/enquiries/uploadenquiryfile","routeSlug":"/publicapi/publicapi/enquiries/uploadenquiryfile","metadata":{"seo":{"title":"Upload enquiry file","description":"Upload enquiry file"}},"httpPath":"/v1/enquiries/{enquiryId}/files"},{"label":"Download enquiry internal file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/enquiries/downloadenquiryinternalfile","routeSlug":"/publicapi/publicapi/enquiries/downloadenquiryinternalfile","metadata":{"seo":{"title":"Download enquiry internal file","description":"Download enquiry internal file"}},"httpPath":"/v1/enquiries/{enquiryId}/internal-files/{fileId}/download"},{"label":"Download enquiry file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/enquiries/downloadenquiryfile","routeSlug":"/publicapi/publicapi/enquiries/downloadenquiryfile","metadata":{"seo":{"title":"Download enquiry file","description":"Download enquiry file"}},"httpPath":"/v1/enquiries/{enquiryId}/files/{fileId}/download"},{"label":"Delete enquiry internal file","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/enquiries/deleteenquiryinternalfile","routeSlug":"/publicapi/publicapi/enquiries/deleteenquiryinternalfile","metadata":{"seo":{"title":"Delete enquiry internal file","description":"Delete enquiry internal file"}},"httpPath":"/v1/enquiries/{enquiryId}/internal-files/{fileId}"},{"label":"Delete enquiry file","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/enquiries/deleteenquiryfile","routeSlug":"/publicapi/publicapi/enquiries/deleteenquiryfile","metadata":{"seo":{"title":"Delete enquiry file","description":"Delete enquiry file"}},"httpPath":"/v1/enquiries/{enquiryId}/files/{fileId}"}]},{"type":"group","label":"Offers","link":"/publicapi/publicapi/offers","routeSlug":"/publicapi/publicapi/offers","items":[{"label":"Create surcharges","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/offers/createsurcharges","routeSlug":"/publicapi/publicapi/offers/createsurcharges","metadata":{"seo":{"title":"Create surcharges","description":"Note that the name is omitted in the frontend when the surcharge type is not CUSTOM."}},"httpPath":"/v1/offers/{offerId}/surcharges"},{"label":"Patch surcharges","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/offers/patchsurcharges","routeSlug":"/publicapi/publicapi/offers/patchsurcharges","metadata":{"seo":{"title":"Patch surcharges","description":"Note that the name is omitted in the frontend when the surcharge type is not CUSTOM."}},"httpPath":"/v1/offers/{offerId}/surcharges"},{"label":"Create message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/offers/createmessage","routeSlug":"/publicapi/publicapi/offers/createmessage","metadata":{"seo":{"title":"Create message","description":"Create message"}},"httpPath":"/v1/offers/{offerId}/message"},{"label":"Create items","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/offers/createitems","routeSlug":"/publicapi/publicapi/offers/createitems","metadata":{"seo":{"title":"Create items","description":"Create items"}},"httpPath":"/v1/offers/{offerId}/items"},{"label":"Patch items","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/offers/patchitems","routeSlug":"/publicapi/publicapi/offers/patchitems","metadata":{"seo":{"title":"Patch items","description":"Patch items"}},"httpPath":"/v1/offers/{offerId}/items"},{"label":"Get offer internal files","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/offers/getofferinternalfiles","routeSlug":"/publicapi/publicapi/offers/getofferinternalfiles","metadata":{"seo":{"title":"Get offer internal files","description":"Get offer internal files"}},"httpPath":"/v1/offers/{offerId}/internal-files"},{"label":"Upload offer internal file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/offers/uploadofferinternalfile","routeSlug":"/publicapi/publicapi/offers/uploadofferinternalfile","metadata":{"seo":{"title":"Upload offer internal file","description":"Upload offer internal file"}},"httpPath":"/v1/offers/{offerId}/internal-files"},{"label":"Upload offer file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/offers/uploadofferfile","routeSlug":"/publicapi/publicapi/offers/uploadofferfile","metadata":{"seo":{"title":"Upload offer file","description":"Upload offer file"}},"httpPath":"/v1/offers/{offerId}/files"},{"label":"Get offer by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/offers/getofferbyid","routeSlug":"/publicapi/publicapi/offers/getofferbyid","metadata":{"seo":{"title":"Get offer by ID","description":"Get offer by ID"}},"httpPath":"/v1/offers/{offerId}"},{"label":"Patch offer","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/offers/patchoffer","routeSlug":"/publicapi/publicapi/offers/patchoffer","metadata":{"seo":{"title":"Patch offer","description":"Patch offer"}},"httpPath":"/v1/offers/{offerId}"},{"label":"Download offer internal file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/offers/downloadofferinternalfile","routeSlug":"/publicapi/publicapi/offers/downloadofferinternalfile","metadata":{"seo":{"title":"Download offer internal file","description":"Download offer internal file"}},"httpPath":"/v1/offers/{offerId}/internal-files/{fileId}/download"},{"label":"Download offer file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/offers/downloadofferfile","routeSlug":"/publicapi/publicapi/offers/downloadofferfile","metadata":{"seo":{"title":"Download offer file","description":"Download offer file"}},"httpPath":"/v1/offers/{offerId}/files/{fileId}/download"},{"label":"Get offer list","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/offers/getofferlist","routeSlug":"/publicapi/publicapi/offers/getofferlist","metadata":{"seo":{"title":"Get offer list","description":"Get offer list"}},"httpPath":"/v1/offers/list"},{"label":"Delete offer internal file","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/offers/deleteofferinternalfile","routeSlug":"/publicapi/publicapi/offers/deleteofferinternalfile","metadata":{"seo":{"title":"Delete offer internal file","description":"Delete offer internal file"}},"httpPath":"/v1/offers/{offerId}/internal-files/{fileId}"},{"label":"Delete offer file","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/offers/deleteofferfile","routeSlug":"/publicapi/publicapi/offers/deleteofferfile","metadata":{"seo":{"title":"Delete offer file","description":"Delete offer file"}},"httpPath":"/v1/offers/{offerId}/files/{fileId}"}]},{"type":"group","label":"Products","link":"/publicapi/publicapi/products","routeSlug":"/publicapi/publicapi/products","items":[{"label":"Query for products","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/products/getlistbyids","routeSlug":"/publicapi/publicapi/products/getlistbyids","metadata":{"seo":{"title":"Query for products","description":"Query for products"}},"httpPath":"/v1/products/list"}]},{"type":"group","label":"Files","link":"/publicapi/publicapi/files","routeSlug":"/publicapi/publicapi/files","items":[{"label":"Upload file","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/files/createfile","routeSlug":"/publicapi/publicapi/files/createfile","metadata":{"seo":{"title":"Upload file","description":"Upload file"}},"httpPath":"/v1/files"}]},{"type":"group","label":"Enums","link":"/publicapi/publicapi/enums","routeSlug":"/publicapi/publicapi/enums","items":[{"label":"Query for enums","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/enums/getallenums","routeSlug":"/publicapi/publicapi/enums/getallenums","metadata":{"seo":{"title":"Query for enums","description":"Query for enums"}},"httpPath":"/v1/enums"}]},{"type":"group","label":"Approval Requests","link":"/publicapi/publicapi/approval-requests","routeSlug":"/publicapi/publicapi/approval-requests","items":[{"label":"Get a list of approval requests","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/approval-requests/getlist","routeSlug":"/publicapi/publicapi/approval-requests/getlist","metadata":{"seo":{"title":"Get a list of approval requests","description":"Retrieve a list of approval requests filtered by optional offer IDs, states, and email addresses."}},"httpPath":"/v1/offers/approval-requests"}]},{"type":"group","label":"Messages","link":"/publicapi/publicapi/messages","routeSlug":"/publicapi/publicapi/messages","items":[{"label":"List messages for a certain offer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/messages/getmessagelistbyofferid","routeSlug":"/publicapi/publicapi/messages/getmessagelistbyofferid","metadata":{"seo":{"title":"List messages for a certain offer","description":"Lists all the messages that were sent and received for a certain offer"}},"httpPath":"/v1/messages/offer/{offerId}"}]},{"type":"group","label":"Customer Groups","link":"/publicapi/publicapi/customer-groups","routeSlug":"/publicapi/publicapi/customer-groups","items":[{"label":"Find customer group by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/customer-groups/getcustomergroup","routeSlug":"/publicapi/publicapi/customer-groups/getcustomergroup","metadata":{"seo":{"title":"Find customer group by ID","description":"Fetches a single customer group based on the provided ID"}},"httpPath":"/v1/customer-groups/{id}"}]},{"type":"group","label":"Suppliers","link":"/publicapi/publicapi/suppliers","routeSlug":"/publicapi/publicapi/suppliers","items":[{"label":"Find a supplier by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/suppliers/get_5","routeSlug":"/publicapi/publicapi/suppliers/get_5","metadata":{"seo":{"title":"Find a supplier by ID","description":"Fetches a supplier based on the ID"}},"httpPath":"/v1/suppliers/{supplierId}"},{"label":"Find customers by filtered value","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/suppliers/getsupplierlist","routeSlug":"/publicapi/publicapi/suppliers/getsupplierlist","metadata":{"seo":{"title":"Find customers by filtered value","description":"Fetches a list of customers based on the set of parameters"}},"httpPath":"/v1/suppliers/list"}]},{"type":"group","label":"Customers","link":"/publicapi/publicapi/customers","routeSlug":"/publicapi/publicapi/customers","items":[{"label":"Find a customer by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/customers/get_6","routeSlug":"/publicapi/publicapi/customers/get_6","metadata":{"seo":{"title":"Find a customer by ID","description":"Fetches a customer based on the ID"}},"httpPath":"/v1/customers/{customerId}"},{"label":"Find customers by filtered value","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/customers/getcustomerlist","routeSlug":"/publicapi/publicapi/customers/getcustomerlist","metadata":{"seo":{"title":"Find customers by filtered value","description":"Fetches a list of customers based on the set of parameters"}},"httpPath":"/v1/customers/list"}]},{"type":"group","label":"Assignments","link":"/publicapi/publicapi/assignments","routeSlug":"/publicapi/publicapi/assignments","items":[{"label":"Query for assignments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/assignments/listassignments","routeSlug":"/publicapi/publicapi/assignments/listassignments","metadata":{"seo":{"title":"Query for assignments","description":"Query for assignments"}},"httpPath":"/v1/assignments"}]},{"type":"group","label":"Users","link":"/publicapi/publicapi/users","routeSlug":"/publicapi/publicapi/users","items":[{"label":"Get user by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/users/getuser","routeSlug":"/publicapi/publicapi/users/getuser","metadata":{"seo":{"title":"Get user by ID","description":"Get user by ID"}},"httpPath":"/v1/users/{userId}"},{"label":"Get user list by filter","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/users/getuserlist","routeSlug":"/publicapi/publicapi/users/getuserlist","metadata":{"seo":{"title":"Get user list by filter","description":"Get user list by filter"}},"httpPath":"/v1/users/list"}]},{"type":"group","label":"Agents","link":"/publicapi/publicapi/agents","routeSlug":"/publicapi/publicapi/agents","items":[{"label":"Find agent by ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/agents/get","routeSlug":"/publicapi/publicapi/agents/get","metadata":{"seo":{"title":"Find agent by ID","description":"Find agent by ID"}},"httpPath":"/v1/agents/{id}"},{"label":"Update agent","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/agents/update","routeSlug":"/publicapi/publicapi/agents/update","metadata":{"seo":{"title":"Update agent","description":"Update agent"}},"httpPath":"/v1/agents/{id}"},{"label":"Find agent by external ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/agents/getexternalagent","routeSlug":"/publicapi/publicapi/agents/getexternalagent","metadata":{"seo":{"title":"Find agent by external ID","description":"Find agent by external ID"}},"httpPath":"/v1/agents/external/{externalId}"},{"label":"Update agent by external ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/agents/updateexternalagent","routeSlug":"/publicapi/publicapi/agents/updateexternalagent","metadata":{"seo":{"title":"Update agent by external ID","description":"Update agent by external ID"}},"httpPath":"/v1/agents/external/{externalId}"},{"label":"Update multiple agents","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/agents/updatebulk","routeSlug":"/publicapi/publicapi/agents/updatebulk","metadata":{"seo":{"title":"Update multiple agents","description":"Update multiple agents"}},"httpPath":"/v1/agents/bulk"},{"label":"Create multiple agents","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/agents/createbulk","routeSlug":"/publicapi/publicapi/agents/createbulk","metadata":{"seo":{"title":"Create multiple agents","description":"Create multiple agents"}},"httpPath":"/v1/agents/bulk"},{"label":"Query for agents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/agents/findlist","routeSlug":"/publicapi/publicapi/agents/findlist","metadata":{"seo":{"title":"Query for agents","description":"Query for agents"}},"httpPath":"/v1/agents"},{"label":"Create agent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/publicapi/publicapi/agents/create","routeSlug":"/publicapi/publicapi/agents/create","metadata":{"seo":{"title":"Create agent","description":"Create agent"}},"httpPath":"/v1/agents"}]}],"selectFirstItemOnExpand":true,"icon":"/assets/world-code.db0ae1a92df0132f1387d7d374f827bb6faf244ee2be7de2229ab7cd5b3307d1.eb5cabde.svg"},{"type":"group","label":"Webhooks","items":[{"type":"link","fsPath":"webhooks/getting-started.md","metadata":{"type":"markdown"},"label":"Getting started","link":"/webhooks/getting-started","routeSlug":"/webhooks/getting-started","icon":"/assets/player-play.0d3a139786c5d8b2551eae34dbf8aef65aa1b16a1521c76cd154e2049c0735c1.eb5cabde.svg"},{"type":"link","label":"Closelink Webhooks API","link":"/webhooks/webhooks","routeSlug":"/webhooks/webhooks"},{"type":"separator","label":""},{"type":"group","label":"Webhook Management","link":"/webhooks/webhooks/webhook-management","routeSlug":"/webhooks/webhooks/webhook-management","items":[{"label":"Update webhook","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/webhooks/webhooks/webhook-management/updatewebhook","routeSlug":"/webhooks/webhooks/webhook-management/updatewebhook","metadata":{"seo":{"title":"Update webhook","description":"Update an existing webhook"}},"httpPath":"/v1/webhooks/{id}"},{"label":"Delete webhook","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/webhooks/webhooks/webhook-management/deletewebhook","routeSlug":"/webhooks/webhooks/webhook-management/deletewebhook","metadata":{"seo":{"title":"Delete webhook","description":"Delete an existing webhook"}},"httpPath":"/v1/webhooks/{id}"},{"label":"Find webhooks","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/webhooks/webhooks/webhook-management/findwebhooks","routeSlug":"/webhooks/webhooks/webhook-management/findwebhooks","metadata":{"seo":{"title":"Find webhooks","description":"Query for multiple webhooks"}},"httpPath":"/v1/webhooks"},{"label":"Create webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/webhooks/webhooks/webhook-management/createwebhook","routeSlug":"/webhooks/webhooks/webhook-management/createwebhook","metadata":{"seo":{"title":"Create webhook","description":"createWebhook"}},"httpPath":"/v1/webhooks"}]},{"type":"group","label":"Draft Events","link":"/webhooks/webhooks/draft-events","routeSlug":"/webhooks/webhooks/draft-events","items":[{"label":"Draft Created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/webhooks/draft-events/paths/draftcreated/post","routeSlug":"/webhooks/webhooks/draft-events/paths/draftcreated/post","metadata":{"seo":{"title":"Draft Created","description":"Triggered when a draft enquiry is created"}},"httpPath":"draftCreated"},{"label":"Draft Deleted","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/webhooks/draft-events/paths/draftdeleted/post","routeSlug":"/webhooks/webhooks/draft-events/paths/draftdeleted/post","metadata":{"seo":{"title":"Draft Deleted","description":"Triggered when a draft enquiry is deleted"}},"httpPath":"draftDeleted"},{"label":"Draft Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/webhooks/draft-events/paths/draftupdated/post","routeSlug":"/webhooks/webhooks/draft-events/paths/draftupdated/post","metadata":{"seo":{"title":"Draft Updated","description":"Triggered when a draft enquiry is updated"}},"httpPath":"draftUpdated"}]},{"type":"group","label":"Enquiry Events","link":"/webhooks/webhooks/enquiry-events","routeSlug":"/webhooks/webhooks/enquiry-events","items":[{"label":"Enquiry Created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/webhooks/enquiry-events/paths/enquirycreated/post","routeSlug":"/webhooks/webhooks/enquiry-events/paths/enquirycreated/post","metadata":{"seo":{"title":"Enquiry Created","description":"Triggered when an enquiry is created"}},"httpPath":"enquiryCreated"},{"label":"Enquiry Draft Submitted","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/webhooks/enquiry-events/paths/enquirydraftsubmitted/post","routeSlug":"/webhooks/webhooks/enquiry-events/paths/enquirydraftsubmitted/post","metadata":{"seo":{"title":"Enquiry Draft Submitted","description":"Triggered when an enquiry draft is submitted"}},"httpPath":"enquiryDraftSubmitted"},{"label":"Enquiry Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/webhooks/enquiry-events/paths/enquiryupdated/post","routeSlug":"/webhooks/webhooks/enquiry-events/paths/enquiryupdated/post","metadata":{"seo":{"title":"Enquiry Updated","description":"Triggered when an enquiry is updated"}},"httpPath":"enquiryUpdated"}]},{"type":"group","label":"Offer Events","link":"/webhooks/webhooks/offer-events","routeSlug":"/webhooks/webhooks/offer-events","items":[{"label":"Offer Created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/webhooks/offer-events/paths/offercreated/post","routeSlug":"/webhooks/webhooks/offer-events/paths/offercreated/post","metadata":{"seo":{"title":"Offer Created","description":"Triggered when an offer is created"}},"httpPath":"offerCreated"},{"label":"Offer Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/webhooks/offer-events/paths/offerupdated/post","routeSlug":"/webhooks/webhooks/offer-events/paths/offerupdated/post","metadata":{"seo":{"title":"Offer Updated","description":"Triggered when an offer is updated"}},"httpPath":"offerUpdated"}]},{"type":"group","label":"Approval Request Events","link":"/webhooks/webhooks/approval-request-events","routeSlug":"/webhooks/webhooks/approval-request-events","items":[{"label":"Approval Request Created","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/webhooks/approval-request-events/paths/approvalrequestcreated/post","routeSlug":"/webhooks/webhooks/approval-request-events/paths/approvalrequestcreated/post","metadata":{"seo":{"title":"Approval Request Created","description":"Triggered when an approval request is created"}},"httpPath":"approvalRequestCreated"},{"label":"Approval Request Updated","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":true,"type":"link","link":"/webhooks/webhooks/approval-request-events/paths/approvalrequestupdated/post","routeSlug":"/webhooks/webhooks/approval-request-events/paths/approvalrequestupdated/post","metadata":{"seo":{"title":"Approval Request Updated","description":"Triggered when an approval request is updated"}},"httpPath":"approvalRequestUpdated"}]}],"selectFirstItemOnExpand":true,"icon":"/assets/webhook.2510ca96d771ec1fe7f3d7fc1b51254d63d1cd6748ea67b607b69d88b900c6ea.eb5cabde.svg"}]}