{"items":[{"type":"separator","label":"Popular"},{"type":"link","fsPath":"apis/index.md","metadata":{"type":"markdown"},"label":"About API References","link":"/apis","routeSlug":"/apis"},{"type":"link","fsPath":"apis/try-it.md","metadata":{"type":"markdown"},"label":"Using Try It!","link":"/apis/try-it","routeSlug":"/apis/try-it"},{"type":"separator","label":"API References"},{"type":"group","label":"Awards","items":[{"type":"link","label":"Awards (Awards & Nominations)","link":"/apis/awards/awards-v1","routeSlug":"/apis/awards/awards-v1"},{"type":"group","label":"Application Fees","link":"/apis/awards/awards-v1/application-fees","routeSlug":"/apis/awards/awards-v1/application-fees","items":[{"label":"Creates a new application fee record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/application-fees/createapplicationfee","routeSlug":"/apis/awards/awards-v1/application-fees/createapplicationfee","metadata":{"seo":{"title":"Creates a new application fee record that does not already exist.","description":"This method will auto-generate an ID and create a new application fee. If an ID is specified for the application fee, an error will be thrown."}},"httpPath":"/applicationFees/{tenantId}"},{"label":"Returns a list of records with the specified award_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/application-fees/listfeesbyawardid","routeSlug":"/apis/awards/awards-v1/application-fees/listfeesbyawardid","metadata":{"seo":{"title":"Returns a list of records with the specified award_id","description":"Returns a list of records with the specified award_id"}},"httpPath":"/applicationFees/{tenantId}/award/{award_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/application-fees/executebatchoperations","routeSlug":"/apis/awards/awards-v1/application-fees/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/applicationFees/{tenantId}/batch"},{"label":"Returns a application fee from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/application-fees/deleteapplicationfee","routeSlug":"/apis/awards/awards-v1/application-fees/deleteapplicationfee","metadata":{"seo":{"title":"Returns a application fee from the system by its ID.","description":"This method will delete a application fee with the specified ID."}},"httpPath":"/applicationFees/{tenantId}/{id}"},{"label":"Returns a application fee from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/application-fees/getapplicationfee","routeSlug":"/apis/awards/awards-v1/application-fees/getapplicationfee","metadata":{"seo":{"title":"Returns a application fee from the system by its ID.","description":"This method will look up a application fee by the specified ID and return it back."}},"httpPath":"/applicationFees/{tenantId}/{id}"},{"label":"Partially updates a application fee with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/application-fees/patchapplicationfee","routeSlug":"/apis/awards/awards-v1/application-fees/patchapplicationfee","metadata":{"seo":{"title":"Partially updates a application fee with the specified ID.","description":"This method will patch an existing application fee with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/applicationFees/{tenantId}/{id}"},{"label":"Updates a application fee with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/application-fees/updateapplicationfee","routeSlug":"/apis/awards/awards-v1/application-fees/updateapplicationfee","metadata":{"seo":{"title":"Updates a application fee with the specified ID.","description":"This method will update an existing application fee with the specified ID."}},"httpPath":"/applicationFees/{tenantId}/{id}"}]},{"type":"group","label":"Application Processes","link":"/apis/awards/awards-v1/application-processes","routeSlug":"/apis/awards/awards-v1/application-processes","items":[{"label":"Creates a new application process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/application-processes/createapplicationprocess","routeSlug":"/apis/awards/awards-v1/application-processes/createapplicationprocess","metadata":{"seo":{"title":"Creates a new application process record that does not already exist.","description":"This method will auto-generate an ID and create a new application process. If an ID is specified for the application process, an error will be thrown."}},"httpPath":"/applicationProcesses/{tenantId}"},{"label":"Returns a list of records with the specified award_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/application-processes/listprocessesbyawardid","routeSlug":"/apis/awards/awards-v1/application-processes/listprocessesbyawardid","metadata":{"seo":{"title":"Returns a list of records with the specified award_id","description":"Returns a list of records with the specified award_id"}},"httpPath":"/applicationProcesses/{tenantId}/award/{award_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/application-processes/executebatchoperations","routeSlug":"/apis/awards/awards-v1/application-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/applicationProcesses/{tenantId}/batch"},{"label":"Gets all of the processes a contact/org is eligible to use","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/application-processes/geteligibleprocesses","routeSlug":"/apis/awards/awards-v1/application-processes/geteligibleprocesses","metadata":{"seo":{"title":"Gets all of the processes a contact/org is eligible to use","description":"Gets all of the processes a contact/org is eligible to use"}},"httpPath":"/applicationProcesses/{tenantId}/eligible/{awardId}/{customerType}/{contactOrOrganizationId}"},{"label":"Returns a application process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/application-processes/deleteapplicationprocess","routeSlug":"/apis/awards/awards-v1/application-processes/deleteapplicationprocess","metadata":{"seo":{"title":"Returns a application process from the system by its ID.","description":"This method will delete a application process with the specified ID."}},"httpPath":"/applicationProcesses/{tenantId}/{id}"},{"label":"Returns a application process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/application-processes/getapplicationprocess","routeSlug":"/apis/awards/awards-v1/application-processes/getapplicationprocess","metadata":{"seo":{"title":"Returns a application process from the system by its ID.","description":"This method will look up a application process by the specified ID and return it back."}},"httpPath":"/applicationProcesses/{tenantId}/{id}"},{"label":"Partially updates a application process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/application-processes/patchapplicationprocess","routeSlug":"/apis/awards/awards-v1/application-processes/patchapplicationprocess","metadata":{"seo":{"title":"Partially updates a application process with the specified ID.","description":"This method will patch an existing application process with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/applicationProcesses/{tenantId}/{id}"},{"label":"Updates a application process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/application-processes/updateapplicationprocess","routeSlug":"/apis/awards/awards-v1/application-processes/updateapplicationprocess","metadata":{"seo":{"title":"Updates a application process with the specified ID.","description":"This method will update an existing application process with the specified ID."}},"httpPath":"/applicationProcesses/{tenantId}/{id}"}]},{"type":"group","label":"Application Status Reasons","link":"/apis/awards/awards-v1/application-status-reasons","routeSlug":"/apis/awards/awards-v1/application-status-reasons","items":[{"label":"Gets all of the application status reasons in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/application-status-reasons/listapplicationstatusreasons","routeSlug":"/apis/awards/awards-v1/application-status-reasons/listapplicationstatusreasons","metadata":{"seo":{"title":"Gets all of the application status reasons in the system.","description":"This method will scan all application status reasons and and return them to the caller."}},"httpPath":"/applicationStatusReasons/{tenantId}"},{"label":"Creates a new application status reason record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/application-status-reasons/createapplicationstatusreason","routeSlug":"/apis/awards/awards-v1/application-status-reasons/createapplicationstatusreason","metadata":{"seo":{"title":"Creates a new application status reason record that does not already exist.","description":"This method will auto-generate an ID and create a new application status reason. If an ID is specified for the application status reason, an error will be thrown."}},"httpPath":"/applicationStatusReasons/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/application-status-reasons/executebatchoperations","routeSlug":"/apis/awards/awards-v1/application-status-reasons/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/applicationStatusReasons/{tenantId}/batch"},{"label":"Returns a application status reason from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/application-status-reasons/deleteapplicationstatusreason","routeSlug":"/apis/awards/awards-v1/application-status-reasons/deleteapplicationstatusreason","metadata":{"seo":{"title":"Returns a application status reason from the system by its ID.","description":"This method will delete a application status reason with the specified ID."}},"httpPath":"/applicationStatusReasons/{tenantId}/{id}"},{"label":"Returns a application status reason from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/application-status-reasons/getapplicationstatusreason","routeSlug":"/apis/awards/awards-v1/application-status-reasons/getapplicationstatusreason","metadata":{"seo":{"title":"Returns a application status reason from the system by its ID.","description":"This method will look up a application status reason by the specified ID and return it back."}},"httpPath":"/applicationStatusReasons/{tenantId}/{id}"},{"label":"Partially updates a application status reason with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/application-status-reasons/patchapplicationstatusreason","routeSlug":"/apis/awards/awards-v1/application-status-reasons/patchapplicationstatusreason","metadata":{"seo":{"title":"Partially updates a application status reason with the specified ID.","description":"This method will patch an existing application status reason with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/applicationStatusReasons/{tenantId}/{id}"},{"label":"Updates a application status reason with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/application-status-reasons/updateapplicationstatusreason","routeSlug":"/apis/awards/awards-v1/application-status-reasons/updateapplicationstatusreason","metadata":{"seo":{"title":"Updates a application status reason with the specified ID.","description":"This method will update an existing application status reason with the specified ID."}},"httpPath":"/applicationStatusReasons/{tenantId}/{id}"}]},{"type":"group","label":"Applications","link":"/apis/awards/awards-v1/applications","routeSlug":"/apis/awards/awards-v1/applications","items":[{"label":"Creates a new application record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/applications/createapplication","routeSlug":"/apis/awards/awards-v1/applications/createapplication","metadata":{"seo":{"title":"Creates a new application record that does not already exist.","description":"This method will auto-generate an ID and create a new application. If an ID is specified for the application, an error will be thrown."}},"httpPath":"/applications/{tenantId}"},{"label":"Returns a list of records with the specified award_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/applications/listapplicationsbyawardid","routeSlug":"/apis/awards/awards-v1/applications/listapplicationsbyawardid","metadata":{"seo":{"title":"Returns a list of records with the specified award_id","description":"Returns a list of records with the specified award_id"}},"httpPath":"/applications/{tenantId}/award/{award_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/applications/executebatchoperations","routeSlug":"/apis/awards/awards-v1/applications/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/applications/{tenantId}/batch"},{"label":"Returns a list of records with the specified owner_type and id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/applications/listapplicationsbyownertypecontactororgid","routeSlug":"/apis/awards/awards-v1/applications/listapplicationsbyownertypecontactororgid","metadata":{"seo":{"title":"Returns a list of records with the specified owner_type and id","description":"Returns a list of records with the specified owner_type and id"}},"httpPath":"/applications/{tenantId}/contact/{ownerType}/{contactOrOrgId}"},{"label":"Generates an order from an awards application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/applications/generateorder","routeSlug":"/apis/awards/awards-v1/applications/generateorder","metadata":{"seo":{"title":"Generates an order from an awards application","description":"This method will examine an awards application and generate an appropriate order"}},"httpPath":"/applications/{tenantId}/generateOrder"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/applications/previewemail","routeSlug":"/apis/awards/awards-v1/applications/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/applications/{tenantId}/previewEmail"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/applications/processapplication","routeSlug":"/apis/awards/awards-v1/applications/processapplication","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/applications/{tenantId}/process"},{"label":"Searches for applications using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/applications/searchforapplications","routeSlug":"/apis/awards/awards-v1/applications/searchforapplications","metadata":{"seo":{"title":"Searches for applications using predefined parameters","description":"Searches for applications using predefined parameters"}},"httpPath":"/applications/{tenantId}/search"},{"label":"Returns a application from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/applications/deleteapplication","routeSlug":"/apis/awards/awards-v1/applications/deleteapplication","metadata":{"seo":{"title":"Returns a application from the system by its ID.","description":"This method will delete a application with the specified ID."}},"httpPath":"/applications/{tenantId}/{id}"},{"label":"Returns a application from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/applications/getapplication","routeSlug":"/apis/awards/awards-v1/applications/getapplication","metadata":{"seo":{"title":"Returns a application from the system by its ID.","description":"This method will look up a application by the specified ID and return it back."}},"httpPath":"/applications/{tenantId}/{id}"},{"label":"Partially updates a application with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/applications/patchapplication","routeSlug":"/apis/awards/awards-v1/applications/patchapplication","metadata":{"seo":{"title":"Partially updates a application with the specified ID.","description":"This method will patch an existing application with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/applications/{tenantId}/{id}"},{"label":"Updates a application with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/applications/updateapplication","routeSlug":"/apis/awards/awards-v1/applications/updateapplication","metadata":{"seo":{"title":"Updates a application with the specified ID.","description":"This method will update an existing application with the specified ID."}},"httpPath":"/applications/{tenantId}/{id}"}]},{"type":"group","label":"Awards","link":"/apis/awards/awards-v1/awards","routeSlug":"/apis/awards/awards-v1/awards","items":[{"label":"Gets all of the awards in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/awards/listawards","routeSlug":"/apis/awards/awards-v1/awards/listawards","metadata":{"seo":{"title":"Gets all of the awards in the system.","description":"This method will scan all awards and and return them to the caller."}},"httpPath":"/awards/{tenantId}"},{"label":"Creates a new award record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/awards/createaward","routeSlug":"/apis/awards/awards-v1/awards/createaward","metadata":{"seo":{"title":"Creates a new award record that does not already exist.","description":"This method will auto-generate an ID and create a new award. If an ID is specified for the award, an error will be thrown."}},"httpPath":"/awards/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/awards/executebatchoperations","routeSlug":"/apis/awards/awards-v1/awards/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/awards/{tenantId}/batch"},{"label":"Creates a copy of an award, along with other associated records","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/awards/cloneaward","routeSlug":"/apis/awards/awards-v1/awards/cloneaward","metadata":{"seo":{"title":"Creates a copy of an award, along with other associated records","description":"Creates a copy of an award, along with other associated records"}},"httpPath":"/awards/{tenantId}/clone"},{"label":"Browse Open Awards for Portal","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/awards/browseopenawardsforportal","routeSlug":"/apis/awards/awards-v1/awards/browseopenawardsforportal","metadata":{"seo":{"title":"Browse Open Awards for Portal","description":"Returns a list of open awards available/visible in the portal"}},"httpPath":"/awards/{tenantId}/portal/browseOpen"},{"label":"Searches for awards using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/awards/searchforawards","routeSlug":"/apis/awards/awards-v1/awards/searchforawards","metadata":{"seo":{"title":"Searches for awards using predefined parameters","description":"Searches for awards using predefined parameters"}},"httpPath":"/awards/{tenantId}/search"},{"label":"Returns a list of records with the specified type_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/awards/listawardsbytypeid","routeSlug":"/apis/awards/awards-v1/awards/listawardsbytypeid","metadata":{"seo":{"title":"Returns a list of records with the specified type_id","description":"Returns a list of records with the specified type_id"}},"httpPath":"/awards/{tenantId}/type/{type_id}"},{"label":"Returns a award from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/awards/deleteaward","routeSlug":"/apis/awards/awards-v1/awards/deleteaward","metadata":{"seo":{"title":"Returns a award from the system by its ID.","description":"This method will delete a award with the specified ID."}},"httpPath":"/awards/{tenantId}/{id}"},{"label":"Returns a award from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/awards/getaward","routeSlug":"/apis/awards/awards-v1/awards/getaward","metadata":{"seo":{"title":"Returns a award from the system by its ID.","description":"This method will look up a award by the specified ID and return it back."}},"httpPath":"/awards/{tenantId}/{id}"},{"label":"Partially updates a award with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/awards/patchaward","routeSlug":"/apis/awards/awards-v1/awards/patchaward","metadata":{"seo":{"title":"Partially updates a award with the specified ID.","description":"This method will patch an existing award with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/awards/{tenantId}/{id}"},{"label":"Updates a award with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/awards/updateaward","routeSlug":"/apis/awards/awards-v1/awards/updateaward","metadata":{"seo":{"title":"Updates a award with the specified ID.","description":"This method will update an existing award with the specified ID."}},"httpPath":"/awards/{tenantId}/{id}"}]},{"type":"group","label":"Categories","link":"/apis/awards/awards-v1/categories","routeSlug":"/apis/awards/awards-v1/categories","items":[{"label":"Creates a new category record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/categories/createcategory","routeSlug":"/apis/awards/awards-v1/categories/createcategory","metadata":{"seo":{"title":"Creates a new category record that does not already exist.","description":"This method will auto-generate an ID and create a new category. If an ID is specified for the category, an error will be thrown."}},"httpPath":"/categories/{tenantId}"},{"label":"Returns a list of records with the specified award_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/categories/listcategoriesbyawardid","routeSlug":"/apis/awards/awards-v1/categories/listcategoriesbyawardid","metadata":{"seo":{"title":"Returns a list of records with the specified award_id","description":"Returns a list of records with the specified award_id"}},"httpPath":"/categories/{tenantId}/award/{award_id}"},{"label":"Returns a category from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/categories/deletecategory","routeSlug":"/apis/awards/awards-v1/categories/deletecategory","metadata":{"seo":{"title":"Returns a category from the system by its ID.","description":"This method will delete a category with the specified ID."}},"httpPath":"/categories/{tenantId}/{id}"},{"label":"Returns a category from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/categories/getcategory","routeSlug":"/apis/awards/awards-v1/categories/getcategory","metadata":{"seo":{"title":"Returns a category from the system by its ID.","description":"This method will look up a category by the specified ID and return it back."}},"httpPath":"/categories/{tenantId}/{id}"},{"label":"Partially updates a category with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/categories/patchcategory","routeSlug":"/apis/awards/awards-v1/categories/patchcategory","metadata":{"seo":{"title":"Partially updates a category with the specified ID.","description":"This method will patch an existing category with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/categories/{tenantId}/{id}"},{"label":"Updates a category with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/categories/updatecategory","routeSlug":"/apis/awards/awards-v1/categories/updatecategory","metadata":{"seo":{"title":"Updates a category with the specified ID.","description":"This method will update an existing category with the specified ID."}},"httpPath":"/categories/{tenantId}/{id}"}]},{"type":"group","label":"Coupons","link":"/apis/awards/awards-v1/coupons","routeSlug":"/apis/awards/awards-v1/coupons","items":[{"label":"Creates a new coupon record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/coupons/createcoupon","routeSlug":"/apis/awards/awards-v1/coupons/createcoupon","metadata":{"seo":{"title":"Creates a new coupon record that does not already exist.","description":"This method will auto-generate an ID and create a new coupon. If an ID is specified for the coupon, an error will be thrown."}},"httpPath":"/coupons/{tenantId}"},{"label":"Returns a list of records with the specified award_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/coupons/listcouponsbyawardid","routeSlug":"/apis/awards/awards-v1/coupons/listcouponsbyawardid","metadata":{"seo":{"title":"Returns a list of records with the specified award_id","description":"Returns a list of records with the specified award_id"}},"httpPath":"/coupons/{tenantId}/award/{award_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/coupons/executebatchoperations","routeSlug":"/apis/awards/awards-v1/coupons/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/coupons/{tenantId}/batch"},{"label":"Returns a coupon from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/coupons/deletecoupon","routeSlug":"/apis/awards/awards-v1/coupons/deletecoupon","metadata":{"seo":{"title":"Returns a coupon from the system by its ID.","description":"This method will delete a coupon with the specified ID."}},"httpPath":"/coupons/{tenantId}/{id}"},{"label":"Returns a coupon from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/coupons/getcoupon","routeSlug":"/apis/awards/awards-v1/coupons/getcoupon","metadata":{"seo":{"title":"Returns a coupon from the system by its ID.","description":"This method will look up a coupon by the specified ID and return it back."}},"httpPath":"/coupons/{tenantId}/{id}"},{"label":"Partially updates a coupon with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/coupons/patchcoupon","routeSlug":"/apis/awards/awards-v1/coupons/patchcoupon","metadata":{"seo":{"title":"Partially updates a coupon with the specified ID.","description":"This method will patch an existing coupon with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/coupons/{tenantId}/{id}"},{"label":"Updates a coupon with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/coupons/updatecoupon","routeSlug":"/apis/awards/awards-v1/coupons/updatecoupon","metadata":{"seo":{"title":"Updates a coupon with the specified ID.","description":"This method will update an existing coupon with the specified ID."}},"httpPath":"/coupons/{tenantId}/{id}"}]},{"type":"group","label":"Nomination Processes","link":"/apis/awards/awards-v1/nomination-processes","routeSlug":"/apis/awards/awards-v1/nomination-processes","items":[{"label":"Gets all of the nomination processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nomination-processes/listnominationprocesses","routeSlug":"/apis/awards/awards-v1/nomination-processes/listnominationprocesses","metadata":{"seo":{"title":"Gets all of the nomination processes in the system.","description":"This method will scan all nomination processes and and return them to the caller."}},"httpPath":"/nominationProcesses/{tenantId}"},{"label":"Creates a new nomination process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nomination-processes/createnominationprocess","routeSlug":"/apis/awards/awards-v1/nomination-processes/createnominationprocess","metadata":{"seo":{"title":"Creates a new nomination process record that does not already exist.","description":"This method will auto-generate an ID and create a new nomination process. If an ID is specified for the nomination process, an error will be thrown."}},"httpPath":"/nominationProcesses/{tenantId}"},{"label":"Returns a list of records with the specified award_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nomination-processes/listprocessesbyawardid","routeSlug":"/apis/awards/awards-v1/nomination-processes/listprocessesbyawardid","metadata":{"seo":{"title":"Returns a list of records with the specified award_id","description":"Returns a list of records with the specified award_id"}},"httpPath":"/nominationProcesses/{tenantId}/award/{award_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nomination-processes/executebatchoperations","routeSlug":"/apis/awards/awards-v1/nomination-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/nominationProcesses/{tenantId}/batch"},{"label":"Gets all of the processes a contact/org is eligible to use","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nomination-processes/geteligibleprocesses","routeSlug":"/apis/awards/awards-v1/nomination-processes/geteligibleprocesses","metadata":{"seo":{"title":"Gets all of the processes a contact/org is eligible to use","description":"Gets all of the processes a contact/org is eligible to use"}},"httpPath":"/nominationProcesses/{tenantId}/eligible/{awardId}/{customerType}/{customer_id}"},{"label":"Returns a nomination process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nomination-processes/deletenominationprocess","routeSlug":"/apis/awards/awards-v1/nomination-processes/deletenominationprocess","metadata":{"seo":{"title":"Returns a nomination process from the system by its ID.","description":"This method will delete a nomination process with the specified ID."}},"httpPath":"/nominationProcesses/{tenantId}/{id}"},{"label":"Returns a nomination process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nomination-processes/getnominationprocess","routeSlug":"/apis/awards/awards-v1/nomination-processes/getnominationprocess","metadata":{"seo":{"title":"Returns a nomination process from the system by its ID.","description":"This method will look up a nomination process by the specified ID and return it back."}},"httpPath":"/nominationProcesses/{tenantId}/{id}"},{"label":"Partially updates a nomination process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nomination-processes/patchnominationprocess","routeSlug":"/apis/awards/awards-v1/nomination-processes/patchnominationprocess","metadata":{"seo":{"title":"Partially updates a nomination process with the specified ID.","description":"This method will patch an existing nomination process with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/nominationProcesses/{tenantId}/{id}"},{"label":"Updates a nomination process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nomination-processes/updatenominationprocess","routeSlug":"/apis/awards/awards-v1/nomination-processes/updatenominationprocess","metadata":{"seo":{"title":"Updates a nomination process with the specified ID.","description":"This method will update an existing nomination process with the specified ID."}},"httpPath":"/nominationProcesses/{tenantId}/{id}"}]},{"type":"group","label":"Nominations","link":"/apis/awards/awards-v1/nominations","routeSlug":"/apis/awards/awards-v1/nominations","items":[{"label":"Creates a new nomination record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nominations/createnomination","routeSlug":"/apis/awards/awards-v1/nominations/createnomination","metadata":{"seo":{"title":"Creates a new nomination record that does not already exist.","description":"This method will auto-generate an ID and create a new nomination. If an ID is specified for the nomination, an error will be thrown."}},"httpPath":"/nominations/{tenantId}"},{"label":"Returns a list of records with the specified award_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nominations/listnominationsbyawardid","routeSlug":"/apis/awards/awards-v1/nominations/listnominationsbyawardid","metadata":{"seo":{"title":"Returns a list of records with the specified award_id","description":"Returns a list of records with the specified award_id"}},"httpPath":"/nominations/{tenantId}/award/{award_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nominations/executebatchoperations","routeSlug":"/apis/awards/awards-v1/nominations/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/nominations/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nominations/listnominationsbycontactid","routeSlug":"/apis/awards/awards-v1/nominations/listnominationsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/nominations/{tenantId}/contact/{contact_id}"},{"label":"Returns a list of records with the specified nominee_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nominations/listnominationsbynomineeid","routeSlug":"/apis/awards/awards-v1/nominations/listnominationsbynomineeid","metadata":{"seo":{"title":"Returns a list of records with the specified nominee_id","description":"Returns a list of records with the specified nominee_id"}},"httpPath":"/nominations/{tenantId}/nominee/{nominee_id}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nominations/listnominationsbyorganizationid","routeSlug":"/apis/awards/awards-v1/nominations/listnominationsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/nominations/{tenantId}/organization/{organization_id}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nominations/previewemail","routeSlug":"/apis/awards/awards-v1/nominations/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/nominations/{tenantId}/previewEmail"},{"label":"Searches for nominations using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nominations/searchfornominations","routeSlug":"/apis/awards/awards-v1/nominations/searchfornominations","metadata":{"seo":{"title":"Searches for nominations using predefined parameters","description":"Searches for nominations using predefined parameters"}},"httpPath":"/nominations/{tenantId}/search"},{"label":"Submit a nomination","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nominations/submitnominations","routeSlug":"/apis/awards/awards-v1/nominations/submitnominations","metadata":{"seo":{"title":"Submit a nomination","description":"Submit a nomination"}},"httpPath":"/nominations/{tenantId}/submit"},{"label":"Returns a nomination from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nominations/deletenomination","routeSlug":"/apis/awards/awards-v1/nominations/deletenomination","metadata":{"seo":{"title":"Returns a nomination from the system by its ID.","description":"This method will delete a nomination with the specified ID."}},"httpPath":"/nominations/{tenantId}/{id}"},{"label":"Returns a nomination from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nominations/getnomination","routeSlug":"/apis/awards/awards-v1/nominations/getnomination","metadata":{"seo":{"title":"Returns a nomination from the system by its ID.","description":"This method will look up a nomination by the specified ID and return it back."}},"httpPath":"/nominations/{tenantId}/{id}"},{"label":"Partially updates a nomination with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nominations/patchnomination","routeSlug":"/apis/awards/awards-v1/nominations/patchnomination","metadata":{"seo":{"title":"Partially updates a nomination with the specified ID.","description":"This method will patch an existing nomination with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/nominations/{tenantId}/{id}"},{"label":"Updates a nomination with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nominations/updatenomination","routeSlug":"/apis/awards/awards-v1/nominations/updatenomination","metadata":{"seo":{"title":"Updates a nomination with the specified ID.","description":"This method will update an existing nomination with the specified ID."}},"httpPath":"/nominations/{tenantId}/{id}"}]},{"type":"group","label":"Nominees","link":"/apis/awards/awards-v1/nominees","routeSlug":"/apis/awards/awards-v1/nominees","items":[{"label":"Creates a new nominee record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nominees/createnominee","routeSlug":"/apis/awards/awards-v1/nominees/createnominee","metadata":{"seo":{"title":"Creates a new nominee record that does not already exist.","description":"This method will auto-generate an ID and create a new nominee. If an ID is specified for the nominee, an error will be thrown."}},"httpPath":"/nominees/{tenantId}"},{"label":"Returns a list of records with the specified award_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nominees/listnomineesbyawardid","routeSlug":"/apis/awards/awards-v1/nominees/listnomineesbyawardid","metadata":{"seo":{"title":"Returns a list of records with the specified award_id","description":"Returns a list of records with the specified award_id"}},"httpPath":"/nominees/{tenantId}/award/{award_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nominees/executebatchoperations","routeSlug":"/apis/awards/awards-v1/nominees/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/nominees/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nominees/listnomineesbycontactid","routeSlug":"/apis/awards/awards-v1/nominees/listnomineesbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/nominees/{tenantId}/customer/{ownerType}/{contactOrOrganizationId}"},{"label":"Searches for nominees using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nominees/searchfornominees","routeSlug":"/apis/awards/awards-v1/nominees/searchfornominees","metadata":{"seo":{"title":"Searches for nominees using predefined parameters","description":"Searches for nominees using predefined parameters"}},"httpPath":"/nominees/{tenantId}/search"},{"label":"Returns a nominee from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nominees/deletenominee","routeSlug":"/apis/awards/awards-v1/nominees/deletenominee","metadata":{"seo":{"title":"Returns a nominee from the system by its ID.","description":"This method will delete a nominee with the specified ID."}},"httpPath":"/nominees/{tenantId}/{id}"},{"label":"Returns a nominee from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nominees/getnominee","routeSlug":"/apis/awards/awards-v1/nominees/getnominee","metadata":{"seo":{"title":"Returns a nominee from the system by its ID.","description":"This method will look up a nominee by the specified ID and return it back."}},"httpPath":"/nominees/{tenantId}/{id}"},{"label":"Partially updates a nominee with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nominees/patchnominee","routeSlug":"/apis/awards/awards-v1/nominees/patchnominee","metadata":{"seo":{"title":"Partially updates a nominee with the specified ID.","description":"This method will patch an existing nominee with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/nominees/{tenantId}/{id}"},{"label":"Updates a nominee with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/nominees/updatenominee","routeSlug":"/apis/awards/awards-v1/nominees/updatenominee","metadata":{"seo":{"title":"Updates a nominee with the specified ID.","description":"This method will update an existing nominee with the specified ID."}},"httpPath":"/nominees/{tenantId}/{id}"}]},{"type":"group","label":"Query Definitions","link":"/apis/awards/awards-v1/query-definitions","routeSlug":"/apis/awards/awards-v1/query-definitions","items":[{"label":"Returns a list of records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/query-definitions/getquerydefinitions","routeSlug":"/apis/awards/awards-v1/query-definitions/getquerydefinitions","metadata":{"seo":{"title":"Returns a list of records","description":"Returns a list of records"}},"httpPath":"/queryDefinitions/{tenantId}"}]},{"type":"group","label":"Recipient Categories","link":"/apis/awards/awards-v1/recipient-categories","routeSlug":"/apis/awards/awards-v1/recipient-categories","items":[{"label":"Creates a new recipient category record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/recipient-categories/createrecipientcategory","routeSlug":"/apis/awards/awards-v1/recipient-categories/createrecipientcategory","metadata":{"seo":{"title":"Creates a new recipient category record that does not already exist.","description":"This method will auto-generate an ID and create a new recipient category. If an ID is specified for the recipient category, an error will be thrown."}},"httpPath":"/recipientCategories/{tenantId}"},{"label":"Returns a list of records with the specified award_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/recipient-categories/listcategoriesbyawardid","routeSlug":"/apis/awards/awards-v1/recipient-categories/listcategoriesbyawardid","metadata":{"seo":{"title":"Returns a list of records with the specified award_id","description":"Returns a list of records with the specified award_id"}},"httpPath":"/recipientCategories/{tenantId}/award/{award_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/recipient-categories/executebatchoperations","routeSlug":"/apis/awards/awards-v1/recipient-categories/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/recipientCategories/{tenantId}/batch"},{"label":"Returns a recipient category from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/recipient-categories/deleterecipientcategory","routeSlug":"/apis/awards/awards-v1/recipient-categories/deleterecipientcategory","metadata":{"seo":{"title":"Returns a recipient category from the system by its ID.","description":"This method will delete a recipient category with the specified ID."}},"httpPath":"/recipientCategories/{tenantId}/{id}"},{"label":"Returns a recipient category from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/recipient-categories/getrecipientcategory","routeSlug":"/apis/awards/awards-v1/recipient-categories/getrecipientcategory","metadata":{"seo":{"title":"Returns a recipient category from the system by its ID.","description":"This method will look up a recipient category by the specified ID and return it back."}},"httpPath":"/recipientCategories/{tenantId}/{id}"},{"label":"Partially updates a recipient category with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/recipient-categories/patchrecipientcategory","routeSlug":"/apis/awards/awards-v1/recipient-categories/patchrecipientcategory","metadata":{"seo":{"title":"Partially updates a recipient category with the specified ID.","description":"This method will patch an existing recipient category with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/recipientCategories/{tenantId}/{id}"},{"label":"Updates a recipient category with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/recipient-categories/updaterecipientcategory","routeSlug":"/apis/awards/awards-v1/recipient-categories/updaterecipientcategory","metadata":{"seo":{"title":"Updates a recipient category with the specified ID.","description":"This method will update an existing recipient category with the specified ID."}},"httpPath":"/recipientCategories/{tenantId}/{id}"}]},{"type":"group","label":"Recipients","link":"/apis/awards/awards-v1/recipients","routeSlug":"/apis/awards/awards-v1/recipients","items":[{"label":"Creates a new recipient record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/recipients/createrecipient","routeSlug":"/apis/awards/awards-v1/recipients/createrecipient","metadata":{"seo":{"title":"Creates a new recipient record that does not already exist.","description":"This method will auto-generate an ID and create a new recipient. If an ID is specified for the recipient, an error will be thrown."}},"httpPath":"/recipients/{tenantId}"},{"label":"Returns a list of records with the specified award_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/recipients/listrecipientsbyawardid","routeSlug":"/apis/awards/awards-v1/recipients/listrecipientsbyawardid","metadata":{"seo":{"title":"Returns a list of records with the specified award_id","description":"Returns a list of records with the specified award_id"}},"httpPath":"/recipients/{tenantId}/award/{award_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/recipients/executebatchoperations","routeSlug":"/apis/awards/awards-v1/recipients/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/recipients/{tenantId}/batch"},{"label":"Returns a list of records with the specified owner_type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/recipients/listrecipientsbyownertypecontactororgid","routeSlug":"/apis/awards/awards-v1/recipients/listrecipientsbyownertypecontactororgid","metadata":{"seo":{"title":"Returns a list of records with the specified owner_type","description":"Returns a list of records with the specified owner_type"}},"httpPath":"/recipients/{tenantId}/ownerId/{ownerType}/{contactOrOrgId}"},{"label":"Searches for recipients using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/recipients/searchforrecipients","routeSlug":"/apis/awards/awards-v1/recipients/searchforrecipients","metadata":{"seo":{"title":"Searches for recipients using predefined parameters","description":"Searches for recipients using predefined parameters"}},"httpPath":"/recipients/{tenantId}/search"},{"label":"Returns a recipient from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/recipients/deleterecipient","routeSlug":"/apis/awards/awards-v1/recipients/deleterecipient","metadata":{"seo":{"title":"Returns a recipient from the system by its ID.","description":"This method will delete a recipient with the specified ID."}},"httpPath":"/recipients/{tenantId}/{id}"},{"label":"Returns a recipient from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/recipients/getrecipient","routeSlug":"/apis/awards/awards-v1/recipients/getrecipient","metadata":{"seo":{"title":"Returns a recipient from the system by its ID.","description":"This method will look up a recipient by the specified ID and return it back."}},"httpPath":"/recipients/{tenantId}/{id}"},{"label":"Partially updates a recipient with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/recipients/patchrecipient","routeSlug":"/apis/awards/awards-v1/recipients/patchrecipient","metadata":{"seo":{"title":"Partially updates a recipient with the specified ID.","description":"This method will patch an existing recipient with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/recipients/{tenantId}/{id}"},{"label":"Updates a recipient with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/recipients/updaterecipient","routeSlug":"/apis/awards/awards-v1/recipients/updaterecipient","metadata":{"seo":{"title":"Updates a recipient with the specified ID.","description":"This method will update an existing recipient with the specified ID."}},"httpPath":"/recipients/{tenantId}/{id}"}]},{"type":"group","label":"Reference Processes","link":"/apis/awards/awards-v1/reference-processes","routeSlug":"/apis/awards/awards-v1/reference-processes","items":[{"label":"Creates a new reference process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reference-processes/createreferenceprocess","routeSlug":"/apis/awards/awards-v1/reference-processes/createreferenceprocess","metadata":{"seo":{"title":"Creates a new reference process record that does not already exist.","description":"This method will auto-generate an ID and create a new reference process. If an ID is specified for the reference process, an error will be thrown."}},"httpPath":"/referenceProcesses/{tenantId}"},{"label":"Returns a list of records with the specified award_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reference-processes/listprocessesbyawardid","routeSlug":"/apis/awards/awards-v1/reference-processes/listprocessesbyawardid","metadata":{"seo":{"title":"Returns a list of records with the specified award_id","description":"Returns a list of records with the specified award_id"}},"httpPath":"/referenceProcesses/{tenantId}/award/{award_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reference-processes/executebatchoperations","routeSlug":"/apis/awards/awards-v1/reference-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/referenceProcesses/{tenantId}/batch"},{"label":"Returns a reference process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reference-processes/deletereferenceprocess","routeSlug":"/apis/awards/awards-v1/reference-processes/deletereferenceprocess","metadata":{"seo":{"title":"Returns a reference process from the system by its ID.","description":"This method will delete a reference process with the specified ID."}},"httpPath":"/referenceProcesses/{tenantId}/{id}"},{"label":"Returns a reference process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reference-processes/getreferenceprocess","routeSlug":"/apis/awards/awards-v1/reference-processes/getreferenceprocess","metadata":{"seo":{"title":"Returns a reference process from the system by its ID.","description":"This method will look up a reference process by the specified ID and return it back."}},"httpPath":"/referenceProcesses/{tenantId}/{id}"},{"label":"Partially updates a reference process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reference-processes/patchreferenceprocess","routeSlug":"/apis/awards/awards-v1/reference-processes/patchreferenceprocess","metadata":{"seo":{"title":"Partially updates a reference process with the specified ID.","description":"This method will patch an existing reference process with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/referenceProcesses/{tenantId}/{id}"},{"label":"Updates a reference process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reference-processes/updatereferenceprocess","routeSlug":"/apis/awards/awards-v1/reference-processes/updatereferenceprocess","metadata":{"seo":{"title":"Updates a reference process with the specified ID.","description":"This method will update an existing reference process with the specified ID."}},"httpPath":"/referenceProcesses/{tenantId}/{id}"}]},{"type":"group","label":"Reference Types","link":"/apis/awards/awards-v1/reference-types","routeSlug":"/apis/awards/awards-v1/reference-types","items":[{"label":"Gets all of the reference types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reference-types/listreferencetypes","routeSlug":"/apis/awards/awards-v1/reference-types/listreferencetypes","metadata":{"seo":{"title":"Gets all of the reference types in the system.","description":"This method will scan all reference types and and return them to the caller."}},"httpPath":"/referenceTypes/{tenantId}"},{"label":"Creates a new reference type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reference-types/createreferencetype","routeSlug":"/apis/awards/awards-v1/reference-types/createreferencetype","metadata":{"seo":{"title":"Creates a new reference type record that does not already exist.","description":"This method will auto-generate an ID and create a new reference type. If an ID is specified for the reference type, an error will be thrown."}},"httpPath":"/referenceTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reference-types/executebatchoperations","routeSlug":"/apis/awards/awards-v1/reference-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/referenceTypes/{tenantId}/batch"},{"label":"Returns a reference type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reference-types/deletereferencetype","routeSlug":"/apis/awards/awards-v1/reference-types/deletereferencetype","metadata":{"seo":{"title":"Returns a reference type from the system by its ID.","description":"This method will delete a reference type with the specified ID."}},"httpPath":"/referenceTypes/{tenantId}/{id}"},{"label":"Returns a reference type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reference-types/getreferencetype","routeSlug":"/apis/awards/awards-v1/reference-types/getreferencetype","metadata":{"seo":{"title":"Returns a reference type from the system by its ID.","description":"This method will look up a reference type by the specified ID and return it back."}},"httpPath":"/referenceTypes/{tenantId}/{id}"},{"label":"Partially updates a reference type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reference-types/patchreferencetype","routeSlug":"/apis/awards/awards-v1/reference-types/patchreferencetype","metadata":{"seo":{"title":"Partially updates a reference type with the specified ID.","description":"This method will patch an existing reference type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/referenceTypes/{tenantId}/{id}"},{"label":"Updates a reference type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reference-types/updatereferencetype","routeSlug":"/apis/awards/awards-v1/reference-types/updatereferencetype","metadata":{"seo":{"title":"Updates a reference type with the specified ID.","description":"This method will update an existing reference type with the specified ID."}},"httpPath":"/referenceTypes/{tenantId}/{id}"}]},{"type":"group","label":"References","link":"/apis/awards/awards-v1/references","routeSlug":"/apis/awards/awards-v1/references","items":[{"label":"Creates a new reference record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/references/createreference","routeSlug":"/apis/awards/awards-v1/references/createreference","metadata":{"seo":{"title":"Creates a new reference record that does not already exist.","description":"This method will auto-generate an ID and create a new reference. If an ID is specified for the reference, an error will be thrown."}},"httpPath":"/references/{tenantId}"},{"label":"Returns a list of records with the specified reference_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/references/listreferencesbyapplicationid","routeSlug":"/apis/awards/awards-v1/references/listreferencesbyapplicationid","metadata":{"seo":{"title":"Returns a list of records with the specified reference_id","description":"Returns a list of records with the specified reference_id"}},"httpPath":"/references/{tenantId}/application/{application_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/references/executebatchoperations","routeSlug":"/apis/awards/awards-v1/references/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/references/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/references/listreferencesbycontactid","routeSlug":"/apis/awards/awards-v1/references/listreferencesbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/references/{tenantId}/contact/{contact_id}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/references/previewemail","routeSlug":"/apis/awards/awards-v1/references/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/references/{tenantId}/previewEmail"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/references/processreferences","routeSlug":"/apis/awards/awards-v1/references/processreferences","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/references/{tenantId}/process/{application_id}"},{"label":"Searches for references using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/references/searchforreferences","routeSlug":"/apis/awards/awards-v1/references/searchforreferences","metadata":{"seo":{"title":"Searches for references using predefined parameters","description":"Searches for references using predefined parameters"}},"httpPath":"/references/{tenantId}/search"},{"label":"Submit a reference","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/references/submitreference","routeSlug":"/apis/awards/awards-v1/references/submitreference","metadata":{"seo":{"title":"Submit a reference","description":"Submit a reference"}},"httpPath":"/references/{tenantId}/submit"},{"label":"Returns a reference from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/references/deletereference","routeSlug":"/apis/awards/awards-v1/references/deletereference","metadata":{"seo":{"title":"Returns a reference from the system by its ID.","description":"This method will delete a reference with the specified ID."}},"httpPath":"/references/{tenantId}/{id}"},{"label":"Returns a reference from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/references/getreference","routeSlug":"/apis/awards/awards-v1/references/getreference","metadata":{"seo":{"title":"Returns a reference from the system by its ID.","description":"This method will look up a reference by the specified ID and return it back."}},"httpPath":"/references/{tenantId}/{id}"},{"label":"Partially updates a reference with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/references/patchreference","routeSlug":"/apis/awards/awards-v1/references/patchreference","metadata":{"seo":{"title":"Partially updates a reference with the specified ID.","description":"This method will patch an existing reference with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/references/{tenantId}/{id}"},{"label":"Updates a reference with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/references/updatereference","routeSlug":"/apis/awards/awards-v1/references/updatereference","metadata":{"seo":{"title":"Updates a reference with the specified ID.","description":"This method will update an existing reference with the specified ID."}},"httpPath":"/references/{tenantId}/{id}"}]},{"type":"group","label":"Review Processes","link":"/apis/awards/awards-v1/review-processes","routeSlug":"/apis/awards/awards-v1/review-processes","items":[{"label":"Creates a new review process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/review-processes/createreviewprocess","routeSlug":"/apis/awards/awards-v1/review-processes/createreviewprocess","metadata":{"seo":{"title":"Creates a new review process record that does not already exist.","description":"This method will auto-generate an ID and create a new review process. If an ID is specified for the review process, an error will be thrown."}},"httpPath":"/reviewProcesses/{tenantId}"},{"label":"Returns a list of records with the specified award_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/review-processes/listprocessesbyawardid","routeSlug":"/apis/awards/awards-v1/review-processes/listprocessesbyawardid","metadata":{"seo":{"title":"Returns a list of records with the specified award_id","description":"Returns a list of records with the specified award_id"}},"httpPath":"/reviewProcesses/{tenantId}/award/{award_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/review-processes/executebatchoperations","routeSlug":"/apis/awards/awards-v1/review-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/reviewProcesses/{tenantId}/batch"},{"label":"Gets all of the processes a contact/org is eligible to use","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/review-processes/geteligibleprocesses","routeSlug":"/apis/awards/awards-v1/review-processes/geteligibleprocesses","metadata":{"seo":{"title":"Gets all of the processes a contact/org is eligible to use","description":"Gets all of the processes a contact/org is eligible to use"}},"httpPath":"/reviewProcesses/{tenantId}/eligible/{contactId}"},{"label":"Returns a review process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/review-processes/deletereviewprocess","routeSlug":"/apis/awards/awards-v1/review-processes/deletereviewprocess","metadata":{"seo":{"title":"Returns a review process from the system by its ID.","description":"This method will delete a review process with the specified ID."}},"httpPath":"/reviewProcesses/{tenantId}/{id}"},{"label":"Returns a review process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/review-processes/getreviewprocess","routeSlug":"/apis/awards/awards-v1/review-processes/getreviewprocess","metadata":{"seo":{"title":"Returns a review process from the system by its ID.","description":"This method will look up a review process by the specified ID and return it back."}},"httpPath":"/reviewProcesses/{tenantId}/{id}"},{"label":"Partially updates a review process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/review-processes/patchreviewprocess","routeSlug":"/apis/awards/awards-v1/review-processes/patchreviewprocess","metadata":{"seo":{"title":"Partially updates a review process with the specified ID.","description":"This method will patch an existing review process with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/reviewProcesses/{tenantId}/{id}"},{"label":"Updates a review process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/review-processes/updatereviewprocess","routeSlug":"/apis/awards/awards-v1/review-processes/updatereviewprocess","metadata":{"seo":{"title":"Updates a review process with the specified ID.","description":"This method will update an existing review process with the specified ID."}},"httpPath":"/reviewProcesses/{tenantId}/{id}"}]},{"type":"group","label":"Review Rounds","link":"/apis/awards/awards-v1/review-rounds","routeSlug":"/apis/awards/awards-v1/review-rounds","items":[{"label":"Creates a new review round record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/review-rounds/createreviewround","routeSlug":"/apis/awards/awards-v1/review-rounds/createreviewround","metadata":{"seo":{"title":"Creates a new review round record that does not already exist.","description":"This method will auto-generate an ID and create a new review round. If an ID is specified for the review round, an error will be thrown."}},"httpPath":"/reviewRounds/{tenantId}"},{"label":"Returns a list of records with the specified award_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/review-rounds/listroundsbyawardid","routeSlug":"/apis/awards/awards-v1/review-rounds/listroundsbyawardid","metadata":{"seo":{"title":"Returns a list of records with the specified award_id","description":"Returns a list of records with the specified award_id"}},"httpPath":"/reviewRounds/{tenantId}/award/{award_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/review-rounds/executebatchoperations","routeSlug":"/apis/awards/awards-v1/review-rounds/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/reviewRounds/{tenantId}/batch"},{"label":"Returns a review round from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/review-rounds/deletereviewround","routeSlug":"/apis/awards/awards-v1/review-rounds/deletereviewround","metadata":{"seo":{"title":"Returns a review round from the system by its ID.","description":"This method will delete a review round with the specified ID."}},"httpPath":"/reviewRounds/{tenantId}/{id}"},{"label":"Returns a review round from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/review-rounds/getreviewround","routeSlug":"/apis/awards/awards-v1/review-rounds/getreviewround","metadata":{"seo":{"title":"Returns a review round from the system by its ID.","description":"This method will look up a review round by the specified ID and return it back."}},"httpPath":"/reviewRounds/{tenantId}/{id}"},{"label":"Partially updates a review round with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/review-rounds/patchreviewround","routeSlug":"/apis/awards/awards-v1/review-rounds/patchreviewround","metadata":{"seo":{"title":"Partially updates a review round with the specified ID.","description":"This method will patch an existing review round with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/reviewRounds/{tenantId}/{id}"},{"label":"Updates a review round with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/review-rounds/updatereviewround","routeSlug":"/apis/awards/awards-v1/review-rounds/updatereviewround","metadata":{"seo":{"title":"Updates a review round with the specified ID.","description":"This method will update an existing review round with the specified ID."}},"httpPath":"/reviewRounds/{tenantId}/{id}"}]},{"type":"group","label":"Reviews","link":"/apis/awards/awards-v1/reviews","routeSlug":"/apis/awards/awards-v1/reviews","items":[{"label":"Creates a new review record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reviews/createreview","routeSlug":"/apis/awards/awards-v1/reviews/createreview","metadata":{"seo":{"title":"Creates a new review record that does not already exist.","description":"This method will auto-generate an ID and create a new review. If an ID is specified for the review, an error will be thrown."}},"httpPath":"/reviews/{tenantId}"},{"label":"Returns a list of records with the specified award_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reviews/listreviewsbyawardid","routeSlug":"/apis/awards/awards-v1/reviews/listreviewsbyawardid","metadata":{"seo":{"title":"Returns a list of records with the specified award_id","description":"Returns a list of records with the specified award_id"}},"httpPath":"/reviews/{tenantId}/award/{award_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reviews/executebatchoperations","routeSlug":"/apis/awards/awards-v1/reviews/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/reviews/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reviews/listreviewsbycontactid","routeSlug":"/apis/awards/awards-v1/reviews/listreviewsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/reviews/{tenantId}/contact/{contact_id}"},{"label":"Returns a list of records with the specified review_round_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reviews/listreviewsbyreviewroundidstatus","routeSlug":"/apis/awards/awards-v1/reviews/listreviewsbyreviewroundidstatus","metadata":{"seo":{"title":"Returns a list of records with the specified review_round_id","description":"Returns a list of records with the specified review_round_id"}},"httpPath":"/reviews/{tenantId}/reviewRound/{review_round_id}/{status}"},{"label":"Searches for reviews using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reviews/searchforreviews","routeSlug":"/apis/awards/awards-v1/reviews/searchforreviews","metadata":{"seo":{"title":"Searches for reviews using predefined parameters","description":"Searches for reviews using predefined parameters"}},"httpPath":"/reviews/{tenantId}/search"},{"label":"Submit a review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reviews/submitreview","routeSlug":"/apis/awards/awards-v1/reviews/submitreview","metadata":{"seo":{"title":"Submit a review","description":"Submit a review"}},"httpPath":"/reviews/{tenantId}/submit"},{"label":"Returns a review from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reviews/deletereview","routeSlug":"/apis/awards/awards-v1/reviews/deletereview","metadata":{"seo":{"title":"Returns a review from the system by its ID.","description":"This method will delete a review with the specified ID."}},"httpPath":"/reviews/{tenantId}/{id}"},{"label":"Returns a review from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reviews/getreview","routeSlug":"/apis/awards/awards-v1/reviews/getreview","metadata":{"seo":{"title":"Returns a review from the system by its ID.","description":"This method will look up a review by the specified ID and return it back."}},"httpPath":"/reviews/{tenantId}/{id}"},{"label":"Partially updates a review with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reviews/patchreview","routeSlug":"/apis/awards/awards-v1/reviews/patchreview","metadata":{"seo":{"title":"Partially updates a review with the specified ID.","description":"This method will patch an existing review with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/reviews/{tenantId}/{id}"},{"label":"Updates a review with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/reviews/updatereview","routeSlug":"/apis/awards/awards-v1/reviews/updatereview","metadata":{"seo":{"title":"Updates a review with the specified ID.","description":"This method will update an existing review with the specified ID."}},"httpPath":"/reviews/{tenantId}/{id}"}]},{"type":"group","label":"Settings","link":"/apis/awards/awards-v1/settings","routeSlug":"/apis/awards/awards-v1/settings","items":[{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/settings/deletesetting","routeSlug":"/apis/awards/awards-v1/settings/deletesetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will delete a setting with the specified ID."}},"httpPath":"/settings/{tenantId}"},{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/settings/getsetting","routeSlug":"/apis/awards/awards-v1/settings/getsetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will look up a setting by the specified ID and return it back."}},"httpPath":"/settings/{tenantId}"},{"label":"Partially updates a setting with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/settings/patchsetting","routeSlug":"/apis/awards/awards-v1/settings/patchsetting","metadata":{"seo":{"title":"Partially updates a setting with the specified ID.","description":"This method will patch an existing setting with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/settings/{tenantId}"},{"label":"Creates a new setting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/settings/createsetting","routeSlug":"/apis/awards/awards-v1/settings/createsetting","metadata":{"seo":{"title":"Creates a new setting record that does not already exist.","description":"This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, an error will be thrown."}},"httpPath":"/settings/{tenantId}"},{"label":"Updates a setting with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/settings/updatesetting","routeSlug":"/apis/awards/awards-v1/settings/updatesetting","metadata":{"seo":{"title":"Updates a setting with the specified ID.","description":"This method will update an existing setting with the specified ID."}},"httpPath":"/settings/{tenantId}"}]},{"type":"group","label":"Statistics","link":"/apis/awards/awards-v1/statistics","routeSlug":"/apis/awards/awards-v1/statistics","items":[{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/statistics/executebatchoperations","routeSlug":"/apis/awards/awards-v1/statistics/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/statistics/{tenantId}/batch"},{"label":"Returns a statistic from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/statistics/getstatistic","routeSlug":"/apis/awards/awards-v1/statistics/getstatistic","metadata":{"seo":{"title":"Returns a statistic from the system by its ID.","description":"This method will look up a statistic by the specified ID and return it back."}},"httpPath":"/statistics/{tenantId}/{id}"}]},{"type":"group","label":"Types","link":"/apis/awards/awards-v1/types","routeSlug":"/apis/awards/awards-v1/types","items":[{"label":"Gets all of the types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/types/listtypes","routeSlug":"/apis/awards/awards-v1/types/listtypes","metadata":{"seo":{"title":"Gets all of the types in the system.","description":"This method will scan all types and and return them to the caller."}},"httpPath":"/types/{tenantId}"},{"label":"Creates a new type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/types/createtype","routeSlug":"/apis/awards/awards-v1/types/createtype","metadata":{"seo":{"title":"Creates a new type record that does not already exist.","description":"This method will auto-generate an ID and create a new type. If an ID is specified for the type, an error will be thrown."}},"httpPath":"/types/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/types/executebatchoperations","routeSlug":"/apis/awards/awards-v1/types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/types/{tenantId}/batch"},{"label":"Returns a type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/types/deletetype","routeSlug":"/apis/awards/awards-v1/types/deletetype","metadata":{"seo":{"title":"Returns a type from the system by its ID.","description":"This method will delete a type with the specified ID."}},"httpPath":"/types/{tenantId}/{id}"},{"label":"Returns a type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/types/gettype","routeSlug":"/apis/awards/awards-v1/types/gettype","metadata":{"seo":{"title":"Returns a type from the system by its ID.","description":"This method will look up a type by the specified ID and return it back."}},"httpPath":"/types/{tenantId}/{id}"},{"label":"Partially updates a type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/types/patchtype","routeSlug":"/apis/awards/awards-v1/types/patchtype","metadata":{"seo":{"title":"Partially updates a type with the specified ID.","description":"This method will patch an existing type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/types/{tenantId}/{id}"},{"label":"Updates a type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/awards/awards-v1/types/updatetype","routeSlug":"/apis/awards/awards-v1/types/updatetype","metadata":{"seo":{"title":"Updates a type with the specified ID.","description":"This method will update an existing type with the specified ID."}},"httpPath":"/types/{tenantId}/{id}"}]}]},{"type":"group","label":"Careers","items":[{"type":"link","label":"Career Center","link":"/apis/careers/careers-v1","routeSlug":"/apis/careers/careers-v1"},{"type":"group","label":"Employer Profiles","link":"/apis/careers/careers-v1/employer-profiles","routeSlug":"/apis/careers/careers-v1/employer-profiles","items":[{"label":"Creates a new employer profile record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/employer-profiles/createemployerprofile","routeSlug":"/apis/careers/careers-v1/employer-profiles/createemployerprofile","metadata":{"seo":{"title":"Creates a new employer profile record that does not already exist.","description":"This method will auto-generate an ID and create a new employer profile. If an ID is specified for the employer profile, an error will be thrown."}},"httpPath":"/employerProfiles/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/employer-profiles/executebatchoperations","routeSlug":"/apis/careers/careers-v1/employer-profiles/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/employerProfiles/{tenantId}/batch"},{"label":"Returns a employer profile from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/employer-profiles/deleteemployerprofile","routeSlug":"/apis/careers/careers-v1/employer-profiles/deleteemployerprofile","metadata":{"seo":{"title":"Returns a employer profile from the system by its ID.","description":"This method will delete a employer profile with the specified ID."}},"httpPath":"/employerProfiles/{tenantId}/{id}"},{"label":"Returns a employer profile from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/employer-profiles/getemployerprofile","routeSlug":"/apis/careers/careers-v1/employer-profiles/getemployerprofile","metadata":{"seo":{"title":"Returns a employer profile from the system by its ID.","description":"This method will look up a employer profile by the specified ID and return it back."}},"httpPath":"/employerProfiles/{tenantId}/{id}"},{"label":"Partially updates a employer profile with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/employer-profiles/patchemployerprofile","routeSlug":"/apis/careers/careers-v1/employer-profiles/patchemployerprofile","metadata":{"seo":{"title":"Partially updates a employer profile with the specified ID.","description":"This method will patch an existing employer profile with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/employerProfiles/{tenantId}/{id}"},{"label":"Updates a employer profile with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/employer-profiles/updateemployerprofile","routeSlug":"/apis/careers/careers-v1/employer-profiles/updateemployerprofile","metadata":{"seo":{"title":"Updates a employer profile with the specified ID.","description":"This method will update an existing employer profile with the specified ID."}},"httpPath":"/employerProfiles/{tenantId}/{id}"}]},{"type":"group","label":"Job Boards","link":"/apis/careers/careers-v1/job-boards","routeSlug":"/apis/careers/careers-v1/job-boards","items":[{"label":"Gets all of the job boards in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-boards/listjobboards","routeSlug":"/apis/careers/careers-v1/job-boards/listjobboards","metadata":{"seo":{"title":"Gets all of the job boards in the system.","description":"This method will scan all job boards and and return them to the caller."}},"httpPath":"/jobBoards/{tenantId}"},{"label":"Creates a new job board record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-boards/createjobboard","routeSlug":"/apis/careers/careers-v1/job-boards/createjobboard","metadata":{"seo":{"title":"Creates a new job board record that does not already exist.","description":"This method will auto-generate an ID and create a new job board. If an ID is specified for the job board, an error will be thrown."}},"httpPath":"/jobBoards/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-boards/executebatchoperations","routeSlug":"/apis/careers/careers-v1/job-boards/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/jobBoards/{tenantId}/batch"},{"label":"Gets an entry in the job board","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-boards/getjobboardentry","routeSlug":"/apis/careers/careers-v1/job-boards/getjobboardentry","metadata":{"seo":{"title":"Gets an entry in the job board","description":"Gets an entry in the job board"}},"httpPath":"/jobBoards/{tenantId}/public/entry/{jobBoardId}/{entryId}"},{"label":"Searches the job board","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-boards/searchpublicjobboard","routeSlug":"/apis/careers/careers-v1/job-boards/searchpublicjobboard","metadata":{"seo":{"title":"Searches the job board","description":"Searches the job board"}},"httpPath":"/jobBoards/{tenantId}/public/search/{id}"},{"label":"Sends a message to a job in the jobBoard","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-boards/sendjobboardmessage","routeSlug":"/apis/careers/careers-v1/job-boards/sendjobboardmessage","metadata":{"seo":{"title":"Sends a message to a job in the jobBoard","description":"Sends a message to a job in the jobBoard"}},"httpPath":"/jobBoards/{tenantId}/public/sendMessage/{jobBoardId}/{entryId}"},{"label":"Returns a job board from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-boards/getpublicjobboard","routeSlug":"/apis/careers/careers-v1/job-boards/getpublicjobboard","metadata":{"seo":{"title":"Returns a job board from the system by its ID.","description":"This method will look up a job board by the specified ID and return it back."}},"httpPath":"/jobBoards/{tenantId}/public/{id}"},{"label":"Searches the job board","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-boards/searchjobboard","routeSlug":"/apis/careers/careers-v1/job-boards/searchjobboard","metadata":{"seo":{"title":"Searches the job board","description":"Searches the job board"}},"httpPath":"/jobBoards/{tenantId}/search/{id}"},{"label":"Returns a job board from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-boards/deletejobboard","routeSlug":"/apis/careers/careers-v1/job-boards/deletejobboard","metadata":{"seo":{"title":"Returns a job board from the system by its ID.","description":"This method will delete a job board with the specified ID."}},"httpPath":"/jobBoards/{tenantId}/{id}"},{"label":"Returns a job board from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-boards/getjobboard","routeSlug":"/apis/careers/careers-v1/job-boards/getjobboard","metadata":{"seo":{"title":"Returns a job board from the system by its ID.","description":"This method will look up a job board by the specified ID and return it back."}},"httpPath":"/jobBoards/{tenantId}/{id}"},{"label":"Partially updates a job board with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-boards/patchjobboard","routeSlug":"/apis/careers/careers-v1/job-boards/patchjobboard","metadata":{"seo":{"title":"Partially updates a job board with the specified ID.","description":"This method will patch an existing job board with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/jobBoards/{tenantId}/{id}"},{"label":"Updates a job board with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-boards/updatejobboard","routeSlug":"/apis/careers/careers-v1/job-boards/updatejobboard","metadata":{"seo":{"title":"Updates a job board with the specified ID.","description":"This method will update an existing job board with the specified ID."}},"httpPath":"/jobBoards/{tenantId}/{id}"}]},{"type":"group","label":"Job Posting Applications","link":"/apis/careers/careers-v1/job-posting-applications","routeSlug":"/apis/careers/careers-v1/job-posting-applications","items":[{"label":"Creates a new job posting application record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-posting-applications/createjobpostingapplication","routeSlug":"/apis/careers/careers-v1/job-posting-applications/createjobpostingapplication","metadata":{"seo":{"title":"Creates a new job posting application record that does not already exist.","description":"This method will auto-generate an ID and create a new job posting application. If an ID is specified for the job posting application, an error will be thrown."}},"httpPath":"/jobPostingApplications/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-posting-applications/executebatchoperations","routeSlug":"/apis/careers/careers-v1/job-posting-applications/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/jobPostingApplications/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-posting-applications/listapplicationsbycontactid","routeSlug":"/apis/careers/careers-v1/job-posting-applications/listapplicationsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/jobPostingApplications/{tenantId}/contact/{contact_id}"},{"label":"Returns a job posting application from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-posting-applications/deletejobpostingapplication","routeSlug":"/apis/careers/careers-v1/job-posting-applications/deletejobpostingapplication","metadata":{"seo":{"title":"Returns a job posting application from the system by its ID.","description":"This method will delete a job posting application with the specified ID."}},"httpPath":"/jobPostingApplications/{tenantId}/{id}"},{"label":"Returns a job posting application from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-posting-applications/getjobpostingapplication","routeSlug":"/apis/careers/careers-v1/job-posting-applications/getjobpostingapplication","metadata":{"seo":{"title":"Returns a job posting application from the system by its ID.","description":"This method will look up a job posting application by the specified ID and return it back."}},"httpPath":"/jobPostingApplications/{tenantId}/{id}"},{"label":"Partially updates a job posting application with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-posting-applications/patchjobpostingapplication","routeSlug":"/apis/careers/careers-v1/job-posting-applications/patchjobpostingapplication","metadata":{"seo":{"title":"Partially updates a job posting application with the specified ID.","description":"This method will patch an existing job posting application with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/jobPostingApplications/{tenantId}/{id}"},{"label":"Updates a job posting application with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-posting-applications/updatejobpostingapplication","routeSlug":"/apis/careers/careers-v1/job-posting-applications/updatejobpostingapplication","metadata":{"seo":{"title":"Updates a job posting application with the specified ID.","description":"This method will update an existing job posting application with the specified ID."}},"httpPath":"/jobPostingApplications/{tenantId}/{id}"}]},{"type":"group","label":"Job Posting Processes","link":"/apis/careers/careers-v1/job-posting-processes","routeSlug":"/apis/careers/careers-v1/job-posting-processes","items":[{"label":"Gets all of the job posting processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-posting-processes/listjobpostingprocesses","routeSlug":"/apis/careers/careers-v1/job-posting-processes/listjobpostingprocesses","metadata":{"seo":{"title":"Gets all of the job posting processes in the system.","description":"This method will scan all job posting processes and and return them to the caller."}},"httpPath":"/jobPostingProcesses/{tenantId}"},{"label":"Creates a new job posting process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-posting-processes/createjobpostingprocess","routeSlug":"/apis/careers/careers-v1/job-posting-processes/createjobpostingprocess","metadata":{"seo":{"title":"Creates a new job posting process record that does not already exist.","description":"This method will auto-generate an ID and create a new job posting process. If an ID is specified for the job posting process, an error will be thrown."}},"httpPath":"/jobPostingProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-posting-processes/executebatchoperations","routeSlug":"/apis/careers/careers-v1/job-posting-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/jobPostingProcesses/{tenantId}/batch"},{"label":"Returns a job posting process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-posting-processes/deletejobpostingprocess","routeSlug":"/apis/careers/careers-v1/job-posting-processes/deletejobpostingprocess","metadata":{"seo":{"title":"Returns a job posting process from the system by its ID.","description":"This method will delete a job posting process with the specified ID."}},"httpPath":"/jobPostingProcesses/{tenantId}/{id}"},{"label":"Returns a job posting process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-posting-processes/getjobpostingprocess","routeSlug":"/apis/careers/careers-v1/job-posting-processes/getjobpostingprocess","metadata":{"seo":{"title":"Returns a job posting process from the system by its ID.","description":"This method will look up a job posting process by the specified ID and return it back."}},"httpPath":"/jobPostingProcesses/{tenantId}/{id}"},{"label":"Partially updates a job posting process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-posting-processes/patchjobpostingprocess","routeSlug":"/apis/careers/careers-v1/job-posting-processes/patchjobpostingprocess","metadata":{"seo":{"title":"Partially updates a job posting process with the specified ID.","description":"This method will patch an existing job posting process with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/jobPostingProcesses/{tenantId}/{id}"},{"label":"Updates a job posting process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-posting-processes/updatejobpostingprocess","routeSlug":"/apis/careers/careers-v1/job-posting-processes/updatejobpostingprocess","metadata":{"seo":{"title":"Updates a job posting process with the specified ID.","description":"This method will update an existing job posting process with the specified ID."}},"httpPath":"/jobPostingProcesses/{tenantId}/{id}"}]},{"type":"group","label":"Job Posting Types","link":"/apis/careers/careers-v1/job-posting-types","routeSlug":"/apis/careers/careers-v1/job-posting-types","items":[{"label":"Gets all of the job posting types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-posting-types/listjobpostingtypes","routeSlug":"/apis/careers/careers-v1/job-posting-types/listjobpostingtypes","metadata":{"seo":{"title":"Gets all of the job posting types in the system.","description":"This method will scan all job posting types and and return them to the caller."}},"httpPath":"/jobPostingTypes/{tenantId}"},{"label":"Creates a new job posting type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-posting-types/createjobpostingtype","routeSlug":"/apis/careers/careers-v1/job-posting-types/createjobpostingtype","metadata":{"seo":{"title":"Creates a new job posting type record that does not already exist.","description":"This method will auto-generate an ID and create a new job posting type. If an ID is specified for the job posting type, an error will be thrown."}},"httpPath":"/jobPostingTypes/{tenantId}"},{"label":"Returns a job posting type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-posting-types/deletejobpostingtype","routeSlug":"/apis/careers/careers-v1/job-posting-types/deletejobpostingtype","metadata":{"seo":{"title":"Returns a job posting type from the system by its ID.","description":"This method will delete a job posting type with the specified ID."}},"httpPath":"/jobPostingTypes/{tenantId}/{id}"},{"label":"Returns a job posting type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-posting-types/getjobpostingtype","routeSlug":"/apis/careers/careers-v1/job-posting-types/getjobpostingtype","metadata":{"seo":{"title":"Returns a job posting type from the system by its ID.","description":"This method will look up a job posting type by the specified ID and return it back."}},"httpPath":"/jobPostingTypes/{tenantId}/{id}"},{"label":"Partially updates a job posting type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-posting-types/patchjobpostingtype","routeSlug":"/apis/careers/careers-v1/job-posting-types/patchjobpostingtype","metadata":{"seo":{"title":"Partially updates a job posting type with the specified ID.","description":"This method will patch an existing job posting type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/jobPostingTypes/{tenantId}/{id}"},{"label":"Updates a job posting type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-posting-types/updatejobpostingtype","routeSlug":"/apis/careers/careers-v1/job-posting-types/updatejobpostingtype","metadata":{"seo":{"title":"Updates a job posting type with the specified ID.","description":"This method will update an existing job posting type with the specified ID."}},"httpPath":"/jobPostingTypes/{tenantId}/{id}"}]},{"type":"group","label":"Job Postings","link":"/apis/careers/careers-v1/job-postings","routeSlug":"/apis/careers/careers-v1/job-postings","items":[{"label":"Creates a new job posting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-postings/createjobposting","routeSlug":"/apis/careers/careers-v1/job-postings/createjobposting","metadata":{"seo":{"title":"Creates a new job posting record that does not already exist.","description":"This method will auto-generate an ID and create a new job posting. If an ID is specified for the job posting, an error will be thrown."}},"httpPath":"/jobPostings/{tenantId}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-postings/applytojob","routeSlug":"/apis/careers/careers-v1/job-postings/applytojob","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/jobPostings/{tenantId}/apply/{id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-postings/executebatchoperations","routeSlug":"/apis/careers/careers-v1/job-postings/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/jobPostings/{tenantId}/batch"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-postings/listpostingsbyorganizationid","routeSlug":"/apis/careers/careers-v1/job-postings/listpostingsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/jobPostings/{tenantId}/organization/{organization_id}"},{"label":"Creates a new job posting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-postings/postjob","routeSlug":"/apis/careers/careers-v1/job-postings/postjob","metadata":{"seo":{"title":"Creates a new job posting record that does not already exist.","description":"This method will auto-generate an ID and create a new job posting. If an ID is specified for the job posting, an error will be thrown."}},"httpPath":"/jobPostings/{tenantId}/post"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-postings/previewemail","routeSlug":"/apis/careers/careers-v1/job-postings/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/jobPostings/{tenantId}/previewEmail"},{"label":"Searches for job postings using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-postings/searchforjobpostings","routeSlug":"/apis/careers/careers-v1/job-postings/searchforjobpostings","metadata":{"seo":{"title":"Searches for job postings using predefined parameters","description":"Searches for job postings using predefined parameters"}},"httpPath":"/jobPostings/{tenantId}/search"},{"label":"Returns a job posting from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-postings/deletejobposting","routeSlug":"/apis/careers/careers-v1/job-postings/deletejobposting","metadata":{"seo":{"title":"Returns a job posting from the system by its ID.","description":"This method will delete a job posting with the specified ID."}},"httpPath":"/jobPostings/{tenantId}/{id}"},{"label":"Returns a job posting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-postings/getjobposting","routeSlug":"/apis/careers/careers-v1/job-postings/getjobposting","metadata":{"seo":{"title":"Returns a job posting from the system by its ID.","description":"This method will look up a job posting by the specified ID and return it back."}},"httpPath":"/jobPostings/{tenantId}/{id}"},{"label":"Partially updates a job posting with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-postings/patchjobposting","routeSlug":"/apis/careers/careers-v1/job-postings/patchjobposting","metadata":{"seo":{"title":"Partially updates a job posting with the specified ID.","description":"This method will patch an existing job posting with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/jobPostings/{tenantId}/{id}"},{"label":"Updates a job posting with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/job-postings/updatejobposting","routeSlug":"/apis/careers/careers-v1/job-postings/updatejobposting","metadata":{"seo":{"title":"Updates a job posting with the specified ID.","description":"This method will update an existing job posting with the specified ID."}},"httpPath":"/jobPostings/{tenantId}/{id}"}]},{"type":"group","label":"Packages","link":"/apis/careers/careers-v1/packages","routeSlug":"/apis/careers/careers-v1/packages","items":[{"label":"Gets all of the packages in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/packages/listpackages","routeSlug":"/apis/careers/careers-v1/packages/listpackages","metadata":{"seo":{"title":"Gets all of the packages in the system.","description":"This method will scan all packages and and return them to the caller."}},"httpPath":"/packages/{tenantId}"},{"label":"Creates a new package record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/packages/createpackage","routeSlug":"/apis/careers/careers-v1/packages/createpackage","metadata":{"seo":{"title":"Creates a new package record that does not already exist.","description":"This method will auto-generate an ID and create a new package. If an ID is specified for the package, an error will be thrown."}},"httpPath":"/packages/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/packages/executebatchoperations","routeSlug":"/apis/careers/careers-v1/packages/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/packages/{tenantId}/batch"},{"label":"Returns a package from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/packages/deletepackage","routeSlug":"/apis/careers/careers-v1/packages/deletepackage","metadata":{"seo":{"title":"Returns a package from the system by its ID.","description":"This method will delete a package with the specified ID."}},"httpPath":"/packages/{tenantId}/{id}"},{"label":"Returns a package from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/packages/getpackage","routeSlug":"/apis/careers/careers-v1/packages/getpackage","metadata":{"seo":{"title":"Returns a package from the system by its ID.","description":"This method will look up a package by the specified ID and return it back."}},"httpPath":"/packages/{tenantId}/{id}"},{"label":"Partially updates a package with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/packages/patchpackage","routeSlug":"/apis/careers/careers-v1/packages/patchpackage","metadata":{"seo":{"title":"Partially updates a package with the specified ID.","description":"This method will patch an existing package with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/packages/{tenantId}/{id}"},{"label":"Updates a package with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/packages/updatepackage","routeSlug":"/apis/careers/careers-v1/packages/updatepackage","metadata":{"seo":{"title":"Updates a package with the specified ID.","description":"This method will update an existing package with the specified ID."}},"httpPath":"/packages/{tenantId}/{id}"}]},{"type":"group","label":"Query Definitions","link":"/apis/careers/careers-v1/query-definitions","routeSlug":"/apis/careers/careers-v1/query-definitions","items":[{"label":"Returns a list of records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/query-definitions/getquerydefinitions","routeSlug":"/apis/careers/careers-v1/query-definitions/getquerydefinitions","metadata":{"seo":{"title":"Returns a list of records","description":"Returns a list of records"}},"httpPath":"/queryDefinitions/{tenantId}"}]},{"type":"group","label":"Resume Banks","link":"/apis/careers/careers-v1/resume-banks","routeSlug":"/apis/careers/careers-v1/resume-banks","items":[{"label":"Gets all of the resume banks in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/resume-banks/listresumebanks","routeSlug":"/apis/careers/careers-v1/resume-banks/listresumebanks","metadata":{"seo":{"title":"Gets all of the resume banks in the system.","description":"This method will scan all resume banks and and return them to the caller."}},"httpPath":"/resumeBanks/{tenantId}"},{"label":"Creates a new resume bank record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/resume-banks/createresumebank","routeSlug":"/apis/careers/careers-v1/resume-banks/createresumebank","metadata":{"seo":{"title":"Creates a new resume bank record that does not already exist.","description":"This method will auto-generate an ID and create a new resume bank. If an ID is specified for the resume bank, an error will be thrown."}},"httpPath":"/resumeBanks/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/resume-banks/executebatchoperations","routeSlug":"/apis/careers/careers-v1/resume-banks/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/resumeBanks/{tenantId}/batch"},{"label":"Returns a resume bank from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/resume-banks/deleteresumebank","routeSlug":"/apis/careers/careers-v1/resume-banks/deleteresumebank","metadata":{"seo":{"title":"Returns a resume bank from the system by its ID.","description":"This method will delete a resume bank with the specified ID."}},"httpPath":"/resumeBanks/{tenantId}/{id}"},{"label":"Returns a resume bank from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/resume-banks/getresumebank","routeSlug":"/apis/careers/careers-v1/resume-banks/getresumebank","metadata":{"seo":{"title":"Returns a resume bank from the system by its ID.","description":"This method will look up a resume bank by the specified ID and return it back."}},"httpPath":"/resumeBanks/{tenantId}/{id}"},{"label":"Partially updates a resume bank with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/resume-banks/patchresumebank","routeSlug":"/apis/careers/careers-v1/resume-banks/patchresumebank","metadata":{"seo":{"title":"Partially updates a resume bank with the specified ID.","description":"This method will patch an existing resume bank with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/resumeBanks/{tenantId}/{id}"},{"label":"Updates a resume bank with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/resume-banks/updateresumebank","routeSlug":"/apis/careers/careers-v1/resume-banks/updateresumebank","metadata":{"seo":{"title":"Updates a resume bank with the specified ID.","description":"This method will update an existing resume bank with the specified ID."}},"httpPath":"/resumeBanks/{tenantId}/{id}"}]},{"type":"group","label":"Resumes","link":"/apis/careers/careers-v1/resumes","routeSlug":"/apis/careers/careers-v1/resumes","items":[{"label":"Creates a new resume record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/resumes/createresume","routeSlug":"/apis/careers/careers-v1/resumes/createresume","metadata":{"seo":{"title":"Creates a new resume record that does not already exist.","description":"This method will auto-generate an ID and create a new resume. If an ID is specified for the resume, an error will be thrown."}},"httpPath":"/resumes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/resumes/executebatchoperations","routeSlug":"/apis/careers/careers-v1/resumes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/resumes/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/resumes/listresumesbycontactid","routeSlug":"/apis/careers/careers-v1/resumes/listresumesbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/resumes/{tenantId}/contact/{contact_id}"},{"label":"Searches for resumes using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/resumes/searchforresumes","routeSlug":"/apis/careers/careers-v1/resumes/searchforresumes","metadata":{"seo":{"title":"Searches for resumes using predefined parameters","description":"Searches for resumes using predefined parameters"}},"httpPath":"/resumes/{tenantId}/search"},{"label":"Returns a resume from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/resumes/deleteresume","routeSlug":"/apis/careers/careers-v1/resumes/deleteresume","metadata":{"seo":{"title":"Returns a resume from the system by its ID.","description":"This method will delete a resume with the specified ID."}},"httpPath":"/resumes/{tenantId}/{id}"},{"label":"Returns a resume from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/resumes/getresume","routeSlug":"/apis/careers/careers-v1/resumes/getresume","metadata":{"seo":{"title":"Returns a resume from the system by its ID.","description":"This method will look up a resume by the specified ID and return it back."}},"httpPath":"/resumes/{tenantId}/{id}"},{"label":"Partially updates a resume with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/resumes/patchresume","routeSlug":"/apis/careers/careers-v1/resumes/patchresume","metadata":{"seo":{"title":"Partially updates a resume with the specified ID.","description":"This method will patch an existing resume with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/resumes/{tenantId}/{id}"},{"label":"Updates a resume with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/resumes/updateresume","routeSlug":"/apis/careers/careers-v1/resumes/updateresume","metadata":{"seo":{"title":"Updates a resume with the specified ID.","description":"This method will update an existing resume with the specified ID."}},"httpPath":"/resumes/{tenantId}/{id}"}]},{"type":"group","label":"Settings","link":"/apis/careers/careers-v1/settings","routeSlug":"/apis/careers/careers-v1/settings","items":[{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/settings/deletesetting","routeSlug":"/apis/careers/careers-v1/settings/deletesetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will delete a setting with the specified ID."}},"httpPath":"/settings/{tenantId}"},{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/settings/getsetting","routeSlug":"/apis/careers/careers-v1/settings/getsetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will look up a setting by the specified ID and return it back."}},"httpPath":"/settings/{tenantId}"},{"label":"Partially updates a setting with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/settings/patchsetting","routeSlug":"/apis/careers/careers-v1/settings/patchsetting","metadata":{"seo":{"title":"Partially updates a setting with the specified ID.","description":"This method will patch an existing setting with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/settings/{tenantId}"},{"label":"Creates a new setting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/settings/createsetting","routeSlug":"/apis/careers/careers-v1/settings/createsetting","metadata":{"seo":{"title":"Creates a new setting record that does not already exist.","description":"This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, an error will be thrown."}},"httpPath":"/settings/{tenantId}"},{"label":"Updates a setting with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/settings/updatesetting","routeSlug":"/apis/careers/careers-v1/settings/updatesetting","metadata":{"seo":{"title":"Updates a setting with the specified ID.","description":"This method will update an existing setting with the specified ID."}},"httpPath":"/settings/{tenantId}"}]},{"type":"group","label":"Statistics","link":"/apis/careers/careers-v1/statistics","routeSlug":"/apis/careers/careers-v1/statistics","items":[{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/statistics/executebatchoperations","routeSlug":"/apis/careers/careers-v1/statistics/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/statistics/{tenantId}/batch"},{"label":"Returns a statistic from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/careers/careers-v1/statistics/getstatistic","routeSlug":"/apis/careers/careers-v1/statistics/getstatistic","metadata":{"seo":{"title":"Returns a statistic from the system by its ID.","description":"This method will look up a statistic by the specified ID and return it back."}},"httpPath":"/statistics/{tenantId}/{id}"}]}]},{"type":"group","label":"Collect","items":[{"type":"link","label":"Collect (Finance & Billing)","link":"/apis/collect/collect-v1","routeSlug":"/apis/collect/collect-v1"},{"type":"group","label":"Accounting Projects","link":"/apis/collect/collect-v1/accounting-projects","routeSlug":"/apis/collect/collect-v1/accounting-projects","items":[{"label":"Gets all of the accounting projects in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/accounting-projects/listaccountingprojects","routeSlug":"/apis/collect/collect-v1/accounting-projects/listaccountingprojects","metadata":{"seo":{"title":"Gets all of the accounting projects in the system.","description":"This method will scan all accounting projects and and return them to the caller."}},"httpPath":"/accountingProjects/{tenantId}"},{"label":"Creates a new accounting project record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/accounting-projects/createaccountingproject","routeSlug":"/apis/collect/collect-v1/accounting-projects/createaccountingproject","metadata":{"seo":{"title":"Creates a new accounting project record that does not already exist.","description":"This method will auto-generate an ID and create a new accounting project. If an ID is specified for the accounting project, an error will be thrown."}},"httpPath":"/accountingProjects/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/accounting-projects/executebatchoperations","routeSlug":"/apis/collect/collect-v1/accounting-projects/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/accountingProjects/{tenantId}/batch"},{"label":"Returns a accounting project from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/accounting-projects/deleteaccountingproject","routeSlug":"/apis/collect/collect-v1/accounting-projects/deleteaccountingproject","metadata":{"seo":{"title":"Returns a accounting project from the system by its ID.","description":"This method will delete a accounting project with the specified ID."}},"httpPath":"/accountingProjects/{tenantId}/{id}"},{"label":"Returns a accounting project from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/accounting-projects/getaccountingproject","routeSlug":"/apis/collect/collect-v1/accounting-projects/getaccountingproject","metadata":{"seo":{"title":"Returns a accounting project from the system by its ID.","description":"This method will look up a accounting project by the specified ID and return it back."}},"httpPath":"/accountingProjects/{tenantId}/{id}"},{"label":"Partially updates a accounting project with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/accounting-projects/patchaccountingproject","routeSlug":"/apis/collect/collect-v1/accounting-projects/patchaccountingproject","metadata":{"seo":{"title":"Partially updates a accounting project with the specified ID.","description":"This method will patch an existing accounting project with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/accountingProjects/{tenantId}/{id}"},{"label":"Updates a accounting project with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/accounting-projects/updateaccountingproject","routeSlug":"/apis/collect/collect-v1/accounting-projects/updateaccountingproject","metadata":{"seo":{"title":"Updates a accounting project with the specified ID.","description":"This method will update an existing accounting project with the specified ID."}},"httpPath":"/accountingProjects/{tenantId}/{id}"}]},{"type":"group","label":"Bank Accounts","link":"/apis/collect/collect-v1/bank-accounts","routeSlug":"/apis/collect/collect-v1/bank-accounts","items":[{"label":"Gets all of the bank accounts in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/bank-accounts/listbankaccounts","routeSlug":"/apis/collect/collect-v1/bank-accounts/listbankaccounts","metadata":{"seo":{"title":"Gets all of the bank accounts in the system.","description":"This method will scan all bank accounts and and return them to the caller."}},"httpPath":"/bankAccounts/{tenantId}"},{"label":"Creates a new bank account record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/bank-accounts/createbankaccount","routeSlug":"/apis/collect/collect-v1/bank-accounts/createbankaccount","metadata":{"seo":{"title":"Creates a new bank account record that does not already exist.","description":"This method will auto-generate an ID and create a new bank account. If an ID is specified for the bank account, an error will be thrown."}},"httpPath":"/bankAccounts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/bank-accounts/executebatchoperations","routeSlug":"/apis/collect/collect-v1/bank-accounts/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/bankAccounts/{tenantId}/batch"},{"label":"Returns a bank account from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/bank-accounts/deletebankaccount","routeSlug":"/apis/collect/collect-v1/bank-accounts/deletebankaccount","metadata":{"seo":{"title":"Returns a bank account from the system by its ID.","description":"This method will delete a bank account with the specified ID."}},"httpPath":"/bankAccounts/{tenantId}/{id}"},{"label":"Returns a bank account from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/bank-accounts/getbankaccount","routeSlug":"/apis/collect/collect-v1/bank-accounts/getbankaccount","metadata":{"seo":{"title":"Returns a bank account from the system by its ID.","description":"This method will look up a bank account by the specified ID and return it back."}},"httpPath":"/bankAccounts/{tenantId}/{id}"},{"label":"Partially updates a bank account with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/bank-accounts/patchbankaccount","routeSlug":"/apis/collect/collect-v1/bank-accounts/patchbankaccount","metadata":{"seo":{"title":"Partially updates a bank account with the specified ID.","description":"This method will patch an existing bank account with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/bankAccounts/{tenantId}/{id}"},{"label":"Updates a bank account with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/bank-accounts/updatebankaccount","routeSlug":"/apis/collect/collect-v1/bank-accounts/updatebankaccount","metadata":{"seo":{"title":"Updates a bank account with the specified ID.","description":"This method will update an existing bank account with the specified ID."}},"httpPath":"/bankAccounts/{tenantId}/{id}"}]},{"type":"group","label":"Batch Assignment Settings","link":"/apis/collect/collect-v1/batch-assignment-settings","routeSlug":"/apis/collect/collect-v1/batch-assignment-settings","items":[{"label":"Gets all of the batch assignment settings in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-assignment-settings/listbatchassignmentsettings","routeSlug":"/apis/collect/collect-v1/batch-assignment-settings/listbatchassignmentsettings","metadata":{"seo":{"title":"Gets all of the batch assignment settings in the system.","description":"This method will scan all batch assignment settings and and return them to the caller."}},"httpPath":"/batchAssignmentSettings/{tenantId}"},{"label":"Creates a new batch assignment setting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-assignment-settings/createbatchassignmentsetting","routeSlug":"/apis/collect/collect-v1/batch-assignment-settings/createbatchassignmentsetting","metadata":{"seo":{"title":"Creates a new batch assignment setting record that does not already exist.","description":"This method will auto-generate an ID and create a new batch assignment setting. If an ID is specified for the batch assignment setting, an error will be thrown."}},"httpPath":"/batchAssignmentSettings/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-assignment-settings/executebatchoperations","routeSlug":"/apis/collect/collect-v1/batch-assignment-settings/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/batchAssignmentSettings/{tenantId}/batch"},{"label":"For a given transaction, determines the default batch","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-assignment-settings/calculatedefaultbatchfortransaction","routeSlug":"/apis/collect/collect-v1/batch-assignment-settings/calculatedefaultbatchfortransaction","metadata":{"seo":{"title":"For a given transaction, determines the default batch","description":"For a given transaction, determines the default batch"}},"httpPath":"/batchAssignmentSettings/{tenantId}/defaultBatch/{transactionType}"},{"label":"Returns a batch assignment setting from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-assignment-settings/deletebatchassignmentsetting","routeSlug":"/apis/collect/collect-v1/batch-assignment-settings/deletebatchassignmentsetting","metadata":{"seo":{"title":"Returns a batch assignment setting from the system by its ID.","description":"This method will delete a batch assignment setting with the specified ID."}},"httpPath":"/batchAssignmentSettings/{tenantId}/{id}"},{"label":"Returns a batch assignment setting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-assignment-settings/getbatchassignmentsetting","routeSlug":"/apis/collect/collect-v1/batch-assignment-settings/getbatchassignmentsetting","metadata":{"seo":{"title":"Returns a batch assignment setting from the system by its ID.","description":"This method will look up a batch assignment setting by the specified ID and return it back."}},"httpPath":"/batchAssignmentSettings/{tenantId}/{id}"},{"label":"Partially updates a batch assignment setting with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-assignment-settings/patchbatchassignmentsetting","routeSlug":"/apis/collect/collect-v1/batch-assignment-settings/patchbatchassignmentsetting","metadata":{"seo":{"title":"Partially updates a batch assignment setting with the specified ID.","description":"This method will patch an existing batch assignment setting with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/batchAssignmentSettings/{tenantId}/{id}"},{"label":"Updates a batch assignment setting with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-assignment-settings/updatebatchassignmentsetting","routeSlug":"/apis/collect/collect-v1/batch-assignment-settings/updatebatchassignmentsetting","metadata":{"seo":{"title":"Updates a batch assignment setting with the specified ID.","description":"This method will update an existing batch assignment setting with the specified ID."}},"httpPath":"/batchAssignmentSettings/{tenantId}/{id}"}]},{"type":"group","label":"Batch Downloading","link":"/apis/collect/collect-v1/batch-downloading","routeSlug":"/apis/collect/collect-v1/batch-downloading","items":[{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-downloading/warmupstepfunctions","routeSlug":"/apis/collect/collect-v1/batch-downloading/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"httpPath":"/batchDownloading/warmUpStepFunctions"},{"label":"Starts the process of downloading batches","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-downloading/initiatebatchdownload","routeSlug":"/apis/collect/collect-v1/batch-downloading/initiatebatchdownload","metadata":{"seo":{"title":"Starts the process of downloading batches","description":"Starts the process of downloading batches"}},"httpPath":"/batchDownloading/{tenantId}"},{"label":"Allows for previewing batch template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-downloading/previewbatchtemplate","routeSlug":"/apis/collect/collect-v1/batch-downloading/previewbatchtemplate","metadata":{"seo":{"title":"Allows for previewing batch template","description":"Starts the process of downloading batches"}},"httpPath":"/batchDownloading/{tenantId}/preview"}]},{"type":"group","label":"Batch Posting","link":"/apis/collect/collect-v1/batch-posting","routeSlug":"/apis/collect/collect-v1/batch-posting","items":[{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-posting/warmupstepfunctions","routeSlug":"/apis/collect/collect-v1/batch-posting/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"httpPath":"/batchPosting/warmUpStepFunctions"},{"label":"Previews the batch to ensure it can be posted, and reports any errors","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-posting/previewbatchposting","routeSlug":"/apis/collect/collect-v1/batch-posting/previewbatchposting","metadata":{"seo":{"title":"Previews the batch to ensure it can be posted, and reports any errors","description":"Previews the batch to ensure it can be posted, and reports any errors"}},"httpPath":"/batchPosting/{tenantId}/batchPostingPreviewRequest"},{"label":"Initiates workflow to post multiple batches","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-posting/postbatches","routeSlug":"/apis/collect/collect-v1/batch-posting/postbatches","metadata":{"seo":{"title":"Initiates workflow to post multiple batches","description":"This method will initiate the batch posting process for one or more supplied batches"}},"httpPath":"/batchPosting/{tenantId}/batchPostingRequest"},{"label":"Initiates workflow to unpost multiple batches","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-posting/unpostbatches","routeSlug":"/apis/collect/collect-v1/batch-posting/unpostbatches","metadata":{"seo":{"title":"Initiates workflow to unpost multiple batches","description":"This method will initiate the batch unposting process for one or more supplied batches"}},"httpPath":"/batchPosting/{tenantId}/batchUnpostingRequest"},{"label":"Retrieves a subledger entry for a transaction","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-posting/getsubledgerentryfortransaction","routeSlug":"/apis/collect/collect-v1/batch-posting/getsubledgerentryfortransaction","metadata":{"seo":{"title":"Retrieves a subledger entry for a transaction","description":"Retrieves a subledger entry for a transaction"}},"httpPath":"/batchPosting/{tenantId}/subledgerEntry/{batchId}/{transactionId}"}]},{"type":"group","label":"Batch Templates","link":"/apis/collect/collect-v1/batch-templates","routeSlug":"/apis/collect/collect-v1/batch-templates","items":[{"label":"Gets all of the batch templates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-templates/listbatchtemplates","routeSlug":"/apis/collect/collect-v1/batch-templates/listbatchtemplates","metadata":{"seo":{"title":"Gets all of the batch templates in the system.","description":"This method will scan all batch templates and and return them to the caller."}},"httpPath":"/batchTemplates/{tenantId}"},{"label":"Creates a new batch template record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-templates/createbatchtemplate","routeSlug":"/apis/collect/collect-v1/batch-templates/createbatchtemplate","metadata":{"seo":{"title":"Creates a new batch template record that does not already exist.","description":"This method will auto-generate an ID and create a new batch template. If an ID is specified for the batch template, an error will be thrown."}},"httpPath":"/batchTemplates/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-templates/executebatchoperations","routeSlug":"/apis/collect/collect-v1/batch-templates/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/batchTemplates/{tenantId}/batch"},{"label":"Returns a batch template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-templates/deletebatchtemplate","routeSlug":"/apis/collect/collect-v1/batch-templates/deletebatchtemplate","metadata":{"seo":{"title":"Returns a batch template from the system by its ID.","description":"This method will delete a batch template with the specified ID."}},"httpPath":"/batchTemplates/{tenantId}/{id}"},{"label":"Returns a batch template from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-templates/getbatchtemplate","routeSlug":"/apis/collect/collect-v1/batch-templates/getbatchtemplate","metadata":{"seo":{"title":"Returns a batch template from the system by its ID.","description":"This method will look up a batch template by the specified ID and return it back."}},"httpPath":"/batchTemplates/{tenantId}/{id}"},{"label":"Partially updates a batch template with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-templates/patchbatchtemplate","routeSlug":"/apis/collect/collect-v1/batch-templates/patchbatchtemplate","metadata":{"seo":{"title":"Partially updates a batch template with the specified ID.","description":"This method will patch an existing batch template with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/batchTemplates/{tenantId}/{id}"},{"label":"Updates a batch template with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batch-templates/updatebatchtemplate","routeSlug":"/apis/collect/collect-v1/batch-templates/updatebatchtemplate","metadata":{"seo":{"title":"Updates a batch template with the specified ID.","description":"This method will update an existing batch template with the specified ID."}},"httpPath":"/batchTemplates/{tenantId}/{id}"}]},{"type":"group","label":"Batches","link":"/apis/collect/collect-v1/batches","routeSlug":"/apis/collect/collect-v1/batches","items":[{"label":"Gets all of the batches in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batches/listbatches","routeSlug":"/apis/collect/collect-v1/batches/listbatches","metadata":{"seo":{"title":"Gets all of the batches in the system.","description":"This method will scan all batches and and return them to the caller."}},"httpPath":"/batches/{tenantId}"},{"label":"Creates a new batch record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batches/createbatch","routeSlug":"/apis/collect/collect-v1/batches/createbatch","metadata":{"seo":{"title":"Creates a new batch record that does not already exist.","description":"This method will auto-generate an ID and create a new batch. If an ID is specified for the batch, an error will be thrown."}},"httpPath":"/batches/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batches/executebatchoperations","routeSlug":"/apis/collect/collect-v1/batches/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/batches/{tenantId}/batch"},{"label":"Recursively retrieve batches dependent on a set of batches","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batches/recursivelyretrievedependentbatches","routeSlug":"/apis/collect/collect-v1/batches/recursivelyretrievedependentbatches","metadata":{"seo":{"title":"Recursively retrieve batches dependent on a set of batches","description":"Returns a list of child batches dependent on the batches specified"}},"httpPath":"/batches/{tenantId}/dependents"},{"label":"Returns a list of records with the specified fiscal_year_id and fiscal_period","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batches/listbatchesbyfiscalperiod","routeSlug":"/apis/collect/collect-v1/batches/listbatchesbyfiscalperiod","metadata":{"seo":{"title":"Returns a list of records with the specified fiscal_year_id and fiscal_period","description":"Returns a list of records with the specified fiscal_year_id and fiscal_period"}},"httpPath":"/batches/{tenantId}/fiscal_period/{fiscal_year_id}/{fiscal_period}"},{"label":"Searches for batches using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batches/searchforbatches","routeSlug":"/apis/collect/collect-v1/batches/searchforbatches","metadata":{"seo":{"title":"Searches for batches using predefined parameters","description":"Searches for batches using predefined parameters"}},"httpPath":"/batches/{tenantId}/search"},{"label":"Returns a list of records with the specified status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batches/listbatchesbystatus","routeSlug":"/apis/collect/collect-v1/batches/listbatchesbystatus","metadata":{"seo":{"title":"Returns a list of records with the specified status","description":"Returns a list of records with the specified status"}},"httpPath":"/batches/{tenantId}/status/{status}/{businessUnitId}"},{"label":"Returns a batch from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batches/deletebatch","routeSlug":"/apis/collect/collect-v1/batches/deletebatch","metadata":{"seo":{"title":"Returns a batch from the system by its ID.","description":"This method will delete a batch with the specified ID."}},"httpPath":"/batches/{tenantId}/{id}"},{"label":"Returns a batch from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batches/getbatch","routeSlug":"/apis/collect/collect-v1/batches/getbatch","metadata":{"seo":{"title":"Returns a batch from the system by its ID.","description":"This method will look up a batch by the specified ID and return it back."}},"httpPath":"/batches/{tenantId}/{id}"},{"label":"Partially updates a batch with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batches/patchbatch","routeSlug":"/apis/collect/collect-v1/batches/patchbatch","metadata":{"seo":{"title":"Partially updates a batch with the specified ID.","description":"This method will patch an existing batch with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/batches/{tenantId}/{id}"},{"label":"Updates a batch with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/batches/updatebatch","routeSlug":"/apis/collect/collect-v1/batches/updatebatch","metadata":{"seo":{"title":"Updates a batch with the specified ID.","description":"This method will update an existing batch with the specified ID."}},"httpPath":"/batches/{tenantId}/{id}"}]},{"type":"group","label":"Billing Notices","link":"/apis/collect/collect-v1/billing-notices","routeSlug":"/apis/collect/collect-v1/billing-notices","items":[{"label":"Gets all of the billing notices in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-notices/listbillingnotices","routeSlug":"/apis/collect/collect-v1/billing-notices/listbillingnotices","metadata":{"seo":{"title":"Gets all of the billing notices in the system.","description":"This method will scan all billing notices and and return them to the caller."}},"httpPath":"/billingNotices/{tenantId}"},{"label":"Creates a new billing notice record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-notices/createbillingnotice","routeSlug":"/apis/collect/collect-v1/billing-notices/createbillingnotice","metadata":{"seo":{"title":"Creates a new billing notice record that does not already exist.","description":"This method will auto-generate an ID and create a new billing notice. If an ID is specified for the billing notice, an error will be thrown."}},"httpPath":"/billingNotices/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-notices/executebatchoperations","routeSlug":"/apis/collect/collect-v1/billing-notices/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/billingNotices/{tenantId}/batch"},{"label":"Returns a billing notice from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-notices/deletebillingnotice","routeSlug":"/apis/collect/collect-v1/billing-notices/deletebillingnotice","metadata":{"seo":{"title":"Returns a billing notice from the system by its ID.","description":"This method will delete a billing notice with the specified ID."}},"httpPath":"/billingNotices/{tenantId}/{id}"},{"label":"Returns a billing notice from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-notices/getbillingnotice","routeSlug":"/apis/collect/collect-v1/billing-notices/getbillingnotice","metadata":{"seo":{"title":"Returns a billing notice from the system by its ID.","description":"This method will look up a billing notice by the specified ID and return it back."}},"httpPath":"/billingNotices/{tenantId}/{id}"},{"label":"Partially updates a billing notice with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-notices/patchbillingnotice","routeSlug":"/apis/collect/collect-v1/billing-notices/patchbillingnotice","metadata":{"seo":{"title":"Partially updates a billing notice with the specified ID.","description":"This method will patch an existing billing notice with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/billingNotices/{tenantId}/{id}"},{"label":"Updates a billing notice with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-notices/updatebillingnotice","routeSlug":"/apis/collect/collect-v1/billing-notices/updatebillingnotice","metadata":{"seo":{"title":"Updates a billing notice with the specified ID.","description":"This method will update an existing billing notice with the specified ID."}},"httpPath":"/billingNotices/{tenantId}/{id}"}]},{"type":"group","label":"Billing Run Actions","link":"/apis/collect/collect-v1/billing-run-actions","routeSlug":"/apis/collect/collect-v1/billing-run-actions","items":[{"label":"Creates a new billing run action record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-run-actions/createbillingrunaction","routeSlug":"/apis/collect/collect-v1/billing-run-actions/createbillingrunaction","metadata":{"seo":{"title":"Creates a new billing run action record that does not already exist.","description":"This method will auto-generate an ID and create a new billing run action. If an ID is specified for the billing run action, an error will be thrown."}},"httpPath":"/billingRunActions/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-run-actions/executebatchoperations","routeSlug":"/apis/collect/collect-v1/billing-run-actions/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/billingRunActions/{tenantId}/batch"},{"label":"Returns a list of records with the specified billing_run_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-run-actions/listactionsbybillingrunid","routeSlug":"/apis/collect/collect-v1/billing-run-actions/listactionsbybillingrunid","metadata":{"seo":{"title":"Returns a list of records with the specified billing_run_id","description":"Returns a list of records with the specified billing_run_id"}},"httpPath":"/billingRunActions/{tenantId}/billingRun/{billing_run_id}"},{"label":"Returns a billing run action from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-run-actions/deletebillingrunaction","routeSlug":"/apis/collect/collect-v1/billing-run-actions/deletebillingrunaction","metadata":{"seo":{"title":"Returns a billing run action from the system by its ID.","description":"This method will delete a billing run action with the specified ID."}},"httpPath":"/billingRunActions/{tenantId}/{id}"},{"label":"Returns a billing run action from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-run-actions/getbillingrunaction","routeSlug":"/apis/collect/collect-v1/billing-run-actions/getbillingrunaction","metadata":{"seo":{"title":"Returns a billing run action from the system by its ID.","description":"This method will look up a billing run action by the specified ID and return it back."}},"httpPath":"/billingRunActions/{tenantId}/{id}"},{"label":"Partially updates a billing run action with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-run-actions/patchbillingrunaction","routeSlug":"/apis/collect/collect-v1/billing-run-actions/patchbillingrunaction","metadata":{"seo":{"title":"Partially updates a billing run action with the specified ID.","description":"This method will patch an existing billing run action with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/billingRunActions/{tenantId}/{id}"},{"label":"Updates a billing run action with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-run-actions/updatebillingrunaction","routeSlug":"/apis/collect/collect-v1/billing-run-actions/updatebillingrunaction","metadata":{"seo":{"title":"Updates a billing run action with the specified ID.","description":"This method will update an existing billing run action with the specified ID."}},"httpPath":"/billingRunActions/{tenantId}/{id}"}]},{"type":"group","label":"Billing Runs","link":"/apis/collect/collect-v1/billing-runs","routeSlug":"/apis/collect/collect-v1/billing-runs","items":[{"label":"Creates a new billing run record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-runs/createbillingrun","routeSlug":"/apis/collect/collect-v1/billing-runs/createbillingrun","metadata":{"seo":{"title":"Creates a new billing run record that does not already exist.","description":"This method will auto-generate an ID and create a new billing run. If an ID is specified for the billing run, an error will be thrown."}},"httpPath":"/billingRuns/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-runs/executebatchoperations","routeSlug":"/apis/collect/collect-v1/billing-runs/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/billingRuns/{tenantId}/batch"},{"label":"Generates a billing run from a template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-runs/generatebillingrunfromtemplate","routeSlug":"/apis/collect/collect-v1/billing-runs/generatebillingrunfromtemplate","metadata":{"seo":{"title":"Generates a billing run from a template","description":"Generates a billing run from a template"}},"httpPath":"/billingRuns/{tenantId}/fromTemplate/{templateId}/{referenceDate}"},{"label":"Returns a list of records with the specified recurring_billing_run_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-runs/listrunsbyrecurringbillingrunid","routeSlug":"/apis/collect/collect-v1/billing-runs/listrunsbyrecurringbillingrunid","metadata":{"seo":{"title":"Returns a list of records with the specified recurring_billing_run_id","description":"Returns a list of records with the specified recurring_billing_run_id"}},"httpPath":"/billingRuns/{tenantId}/recurringBillingRun/{recurring_billing_run_id}"},{"label":"Refreshes a billing run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-runs/refreshbillingrun","routeSlug":"/apis/collect/collect-v1/billing-runs/refreshbillingrun","metadata":{"seo":{"title":"Refreshes a billing run","description":"Refreshes a billing run"}},"httpPath":"/billingRuns/{tenantId}/refresh/{id}"},{"label":"Searches for billing runs using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-runs/searchforbillingruns","routeSlug":"/apis/collect/collect-v1/billing-runs/searchforbillingruns","metadata":{"seo":{"title":"Searches for billing runs using predefined parameters","description":"Searches for billing runs using predefined parameters"}},"httpPath":"/billingRuns/{tenantId}/search"},{"label":"Returns a billing run from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-runs/deletebillingrun","routeSlug":"/apis/collect/collect-v1/billing-runs/deletebillingrun","metadata":{"seo":{"title":"Returns a billing run from the system by its ID.","description":"This method will delete a billing run with the specified ID."}},"httpPath":"/billingRuns/{tenantId}/{id}"},{"label":"Returns a billing run from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-runs/getbillingrun","routeSlug":"/apis/collect/collect-v1/billing-runs/getbillingrun","metadata":{"seo":{"title":"Returns a billing run from the system by its ID.","description":"This method will look up a billing run by the specified ID and return it back."}},"httpPath":"/billingRuns/{tenantId}/{id}"},{"label":"Partially updates a billing run with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-runs/patchbillingrun","routeSlug":"/apis/collect/collect-v1/billing-runs/patchbillingrun","metadata":{"seo":{"title":"Partially updates a billing run with the specified ID.","description":"This method will patch an existing billing run with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/billingRuns/{tenantId}/{id}"},{"label":"Updates a billing run with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-runs/updatebillingrun","routeSlug":"/apis/collect/collect-v1/billing-runs/updatebillingrun","metadata":{"seo":{"title":"Updates a billing run with the specified ID.","description":"This method will update an existing billing run with the specified ID."}},"httpPath":"/billingRuns/{tenantId}/{id}"}]},{"type":"group","label":"Billing Templates","link":"/apis/collect/collect-v1/billing-templates","routeSlug":"/apis/collect/collect-v1/billing-templates","items":[{"label":"Gets all of the billing templates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-templates/listbillingtemplates","routeSlug":"/apis/collect/collect-v1/billing-templates/listbillingtemplates","metadata":{"seo":{"title":"Gets all of the billing templates in the system.","description":"This method will scan all billing templates and and return them to the caller."}},"httpPath":"/billingTemplates/{tenantId}"},{"label":"Creates a new billing template record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-templates/createbillingtemplate","routeSlug":"/apis/collect/collect-v1/billing-templates/createbillingtemplate","metadata":{"seo":{"title":"Creates a new billing template record that does not already exist.","description":"This method will auto-generate an ID and create a new billing template. If an ID is specified for the billing template, an error will be thrown."}},"httpPath":"/billingTemplates/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-templates/executebatchoperations","routeSlug":"/apis/collect/collect-v1/billing-templates/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/billingTemplates/{tenantId}/batch"},{"label":"Returns a billing template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-templates/deletebillingtemplate","routeSlug":"/apis/collect/collect-v1/billing-templates/deletebillingtemplate","metadata":{"seo":{"title":"Returns a billing template from the system by its ID.","description":"This method will delete a billing template with the specified ID."}},"httpPath":"/billingTemplates/{tenantId}/{id}"},{"label":"Returns a billing template from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-templates/getbillingtemplate","routeSlug":"/apis/collect/collect-v1/billing-templates/getbillingtemplate","metadata":{"seo":{"title":"Returns a billing template from the system by its ID.","description":"This method will look up a billing template by the specified ID and return it back."}},"httpPath":"/billingTemplates/{tenantId}/{id}"},{"label":"Partially updates a billing template with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-templates/patchbillingtemplate","routeSlug":"/apis/collect/collect-v1/billing-templates/patchbillingtemplate","metadata":{"seo":{"title":"Partially updates a billing template with the specified ID.","description":"This method will patch an existing billing template with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/billingTemplates/{tenantId}/{id}"},{"label":"Updates a billing template with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/billing-templates/updatebillingtemplate","routeSlug":"/apis/collect/collect-v1/billing-templates/updatebillingtemplate","metadata":{"seo":{"title":"Updates a billing template with the specified ID.","description":"This method will update an existing billing template with the specified ID."}},"httpPath":"/billingTemplates/{tenantId}/{id}"}]},{"type":"group","label":"Business Units","link":"/apis/collect/collect-v1/business-units","routeSlug":"/apis/collect/collect-v1/business-units","items":[{"label":"Gets all of the business units in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/business-units/listbusinessunits","routeSlug":"/apis/collect/collect-v1/business-units/listbusinessunits","metadata":{"seo":{"title":"Gets all of the business units in the system.","description":"This method will scan all business units and and return them to the caller."}},"httpPath":"/businessUnits/{tenantId}"},{"label":"Creates a new business unit record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/business-units/createbusinessunit","routeSlug":"/apis/collect/collect-v1/business-units/createbusinessunit","metadata":{"seo":{"title":"Creates a new business unit record that does not already exist.","description":"This method will auto-generate an ID and create a new business unit. If an ID is specified for the business unit, an error will be thrown."}},"httpPath":"/businessUnits/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/business-units/executebatchoperations","routeSlug":"/apis/collect/collect-v1/business-units/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/businessUnits/{tenantId}/batch"},{"label":"Returns a business unit from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/business-units/deletebusinessunit","routeSlug":"/apis/collect/collect-v1/business-units/deletebusinessunit","metadata":{"seo":{"title":"Returns a business unit from the system by its ID.","description":"This method will delete a business unit with the specified ID."}},"httpPath":"/businessUnits/{tenantId}/{id}"},{"label":"Returns a business unit from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/business-units/getbusinessunit","routeSlug":"/apis/collect/collect-v1/business-units/getbusinessunit","metadata":{"seo":{"title":"Returns a business unit from the system by its ID.","description":"This method will look up a business unit by the specified ID and return it back."}},"httpPath":"/businessUnits/{tenantId}/{id}"},{"label":"Partially updates a business unit with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/business-units/patchbusinessunit","routeSlug":"/apis/collect/collect-v1/business-units/patchbusinessunit","metadata":{"seo":{"title":"Partially updates a business unit with the specified ID.","description":"This method will patch an existing business unit with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/businessUnits/{tenantId}/{id}"},{"label":"Updates a business unit with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/business-units/updatebusinessunit","routeSlug":"/apis/collect/collect-v1/business-units/updatebusinessunit","metadata":{"seo":{"title":"Updates a business unit with the specified ID.","description":"This method will update an existing business unit with the specified ID."}},"httpPath":"/businessUnits/{tenantId}/{id}"}]},{"type":"group","label":"Check Request Processes","link":"/apis/collect/collect-v1/check-request-processes","routeSlug":"/apis/collect/collect-v1/check-request-processes","items":[{"label":"Gets all of the check request processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-processes/listcheckrequestprocesses","routeSlug":"/apis/collect/collect-v1/check-request-processes/listcheckrequestprocesses","metadata":{"seo":{"title":"Gets all of the check request processes in the system.","description":"This method will scan all check request processes and and return them to the caller."}},"httpPath":"/checkRequestProcesses/{tenantId}"},{"label":"Creates a new check request process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-processes/createcheckrequestprocess","routeSlug":"/apis/collect/collect-v1/check-request-processes/createcheckrequestprocess","metadata":{"seo":{"title":"Creates a new check request process record that does not already exist.","description":"This method will auto-generate an ID and create a new check request process. If an ID is specified for the check request process, an error will be thrown."}},"httpPath":"/checkRequestProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-processes/executebatchoperations","routeSlug":"/apis/collect/collect-v1/check-request-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/checkRequestProcesses/{tenantId}/batch"},{"label":"Returns a check request process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-processes/deletecheckrequestprocess","routeSlug":"/apis/collect/collect-v1/check-request-processes/deletecheckrequestprocess","metadata":{"seo":{"title":"Returns a check request process from the system by its ID.","description":"This method will delete a check request process with the specified ID."}},"httpPath":"/checkRequestProcesses/{tenantId}/{id}"},{"label":"Returns a check request process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-processes/getcheckrequestprocess","routeSlug":"/apis/collect/collect-v1/check-request-processes/getcheckrequestprocess","metadata":{"seo":{"title":"Returns a check request process from the system by its ID.","description":"This method will look up a check request process by the specified ID and return it back."}},"httpPath":"/checkRequestProcesses/{tenantId}/{id}"},{"label":"Partially updates a check request process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-processes/patchcheckrequestprocess","routeSlug":"/apis/collect/collect-v1/check-request-processes/patchcheckrequestprocess","metadata":{"seo":{"title":"Partially updates a check request process with the specified ID.","description":"This method will patch an existing check request process with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/checkRequestProcesses/{tenantId}/{id}"},{"label":"Updates a check request process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-processes/updatecheckrequestprocess","routeSlug":"/apis/collect/collect-v1/check-request-processes/updatecheckrequestprocess","metadata":{"seo":{"title":"Updates a check request process with the specified ID.","description":"This method will update an existing check request process with the specified ID."}},"httpPath":"/checkRequestProcesses/{tenantId}/{id}"}]},{"type":"group","label":"Check Request Templates","link":"/apis/collect/collect-v1/check-request-templates","routeSlug":"/apis/collect/collect-v1/check-request-templates","items":[{"label":"Gets all of the check request templates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-templates/listcheckrequesttemplates","routeSlug":"/apis/collect/collect-v1/check-request-templates/listcheckrequesttemplates","metadata":{"seo":{"title":"Gets all of the check request templates in the system.","description":"This method will scan all check request templates and and return them to the caller."}},"httpPath":"/checkRequestTemplates/{tenantId}"},{"label":"Creates a new check request template record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-templates/createcheckrequesttemplate","routeSlug":"/apis/collect/collect-v1/check-request-templates/createcheckrequesttemplate","metadata":{"seo":{"title":"Creates a new check request template record that does not already exist.","description":"This method will auto-generate an ID and create a new check request template. If an ID is specified for the check request template, an error will be thrown."}},"httpPath":"/checkRequestTemplates/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-templates/executebatchoperations","routeSlug":"/apis/collect/collect-v1/check-request-templates/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/checkRequestTemplates/{tenantId}/batch"},{"label":"Returns a check request template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-templates/deletecheckrequesttemplate","routeSlug":"/apis/collect/collect-v1/check-request-templates/deletecheckrequesttemplate","metadata":{"seo":{"title":"Returns a check request template from the system by its ID.","description":"This method will delete a check request template with the specified ID."}},"httpPath":"/checkRequestTemplates/{tenantId}/{id}"},{"label":"Returns a check request template from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-templates/getcheckrequesttemplate","routeSlug":"/apis/collect/collect-v1/check-request-templates/getcheckrequesttemplate","metadata":{"seo":{"title":"Returns a check request template from the system by its ID.","description":"This method will look up a check request template by the specified ID and return it back."}},"httpPath":"/checkRequestTemplates/{tenantId}/{id}"},{"label":"Partially updates a check request template with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-templates/patchcheckrequesttemplate","routeSlug":"/apis/collect/collect-v1/check-request-templates/patchcheckrequesttemplate","metadata":{"seo":{"title":"Partially updates a check request template with the specified ID.","description":"This method will patch an existing check request template with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/checkRequestTemplates/{tenantId}/{id}"},{"label":"Updates a check request template with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-request-templates/updatecheckrequesttemplate","routeSlug":"/apis/collect/collect-v1/check-request-templates/updatecheckrequesttemplate","metadata":{"seo":{"title":"Updates a check request template with the specified ID.","description":"This method will update an existing check request template with the specified ID."}},"httpPath":"/checkRequestTemplates/{tenantId}/{id}"}]},{"type":"group","label":"Check Requests","link":"/apis/collect/collect-v1/check-requests","routeSlug":"/apis/collect/collect-v1/check-requests","items":[{"label":"Gets all of the check requests in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-requests/listcheckrequests","routeSlug":"/apis/collect/collect-v1/check-requests/listcheckrequests","metadata":{"seo":{"title":"Gets all of the check requests in the system.","description":"This method will scan all check requests and and return them to the caller."}},"httpPath":"/checkRequests/{tenantId}"},{"label":"Creates a new check request record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-requests/createcheckrequest","routeSlug":"/apis/collect/collect-v1/check-requests/createcheckrequest","metadata":{"seo":{"title":"Creates a new check request record that does not already exist.","description":"This method will auto-generate an ID and create a new check request. If an ID is specified for the check request, an error will be thrown."}},"httpPath":"/checkRequests/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-requests/executebatchoperations","routeSlug":"/apis/collect/collect-v1/check-requests/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/checkRequests/{tenantId}/batch"},{"label":"Process the check request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-requests/processcheckrequest","routeSlug":"/apis/collect/collect-v1/check-requests/processcheckrequest","metadata":{"seo":{"title":"Process the check request","description":"Process the check request"}},"httpPath":"/checkRequests/{tenantId}/process"},{"label":"Render the check request","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-requests/rendercheckrequest","routeSlug":"/apis/collect/collect-v1/check-requests/rendercheckrequest","metadata":{"seo":{"title":"Render the check request","description":"Render the check request"}},"httpPath":"/checkRequests/{tenantId}/render"},{"label":"Searches for check requests using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-requests/searchforcheckrequests","routeSlug":"/apis/collect/collect-v1/check-requests/searchforcheckrequests","metadata":{"seo":{"title":"Searches for check requests using predefined parameters","description":"Searches for check requests using predefined parameters"}},"httpPath":"/checkRequests/{tenantId}/search"},{"label":"Returns a check request from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-requests/deletecheckrequest","routeSlug":"/apis/collect/collect-v1/check-requests/deletecheckrequest","metadata":{"seo":{"title":"Returns a check request from the system by its ID.","description":"This method will delete a check request with the specified ID."}},"httpPath":"/checkRequests/{tenantId}/{id}"},{"label":"Returns a check request from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-requests/getcheckrequest","routeSlug":"/apis/collect/collect-v1/check-requests/getcheckrequest","metadata":{"seo":{"title":"Returns a check request from the system by its ID.","description":"This method will look up a check request by the specified ID and return it back."}},"httpPath":"/checkRequests/{tenantId}/{id}"},{"label":"Partially updates a check request with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-requests/patchcheckrequest","routeSlug":"/apis/collect/collect-v1/check-requests/patchcheckrequest","metadata":{"seo":{"title":"Partially updates a check request with the specified ID.","description":"This method will patch an existing check request with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/checkRequests/{tenantId}/{id}"},{"label":"Updates a check request with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/check-requests/updatecheckrequest","routeSlug":"/apis/collect/collect-v1/check-requests/updatecheckrequest","metadata":{"seo":{"title":"Updates a check request with the specified ID.","description":"This method will update an existing check request with the specified ID."}},"httpPath":"/checkRequests/{tenantId}/{id}"}]},{"type":"group","label":"Cogs Entries","link":"/apis/collect/collect-v1/cogs-entries","routeSlug":"/apis/collect/collect-v1/cogs-entries","items":[{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/cogs-entries/executebatchoperations","routeSlug":"/apis/collect/collect-v1/cogs-entries/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/cogsEntries/{tenantId}/batch"},{"label":"Returns a list of COGS entries in a fiscal period","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/cogs-entries/listcogsentriesbyfiscalperiod","routeSlug":"/apis/collect/collect-v1/cogs-entries/listcogsentriesbyfiscalperiod","metadata":{"seo":{"title":"Returns a list of COGS entries in a fiscal period","description":"Returns a list of COGS entries in a fiscal period"}},"httpPath":"/cogsEntries/{tenantId}/fiscalperiod/{fiscal_year_id}/{fiscal_period}"},{"label":"Returns a list of COGS entries for a transaction ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/cogs-entries/listcogsentriesforinventorytransaction","routeSlug":"/apis/collect/collect-v1/cogs-entries/listcogsentriesforinventorytransaction","metadata":{"seo":{"title":"Returns a list of COGS entries for a transaction ID","description":"Returns a list of COGS entries for a transaction ID"}},"httpPath":"/cogsEntries/{tenantId}/inventoryTransaction/{inventoryTransactionId}"},{"label":"Returns a list of COGS entries for an order id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/cogs-entries/listcogsentriesfororder","routeSlug":"/apis/collect/collect-v1/cogs-entries/listcogsentriesfororder","metadata":{"seo":{"title":"Returns a list of COGS entries for an order id","description":"Returns a list of COGS entries for an order id"}},"httpPath":"/cogsEntries/{tenantId}/order/{orderId}"},{"label":"Returns a cogs entry from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/cogs-entries/deletecogsentry","routeSlug":"/apis/collect/collect-v1/cogs-entries/deletecogsentry","metadata":{"seo":{"title":"Returns a cogs entry from the system by its ID.","description":"This method will delete a cogs entry with the specified ID."}},"httpPath":"/cogsEntries/{tenantId}/{id}"},{"label":"Returns a cogs entry from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/cogs-entries/getcogsentry","routeSlug":"/apis/collect/collect-v1/cogs-entries/getcogsentry","metadata":{"seo":{"title":"Returns a cogs entry from the system by its ID.","description":"This method will look up a cogs entry by the specified ID and return it back."}},"httpPath":"/cogsEntries/{tenantId}/{id}"},{"label":"Partially updates a cogs entry with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/cogs-entries/patchcogsentry","routeSlug":"/apis/collect/collect-v1/cogs-entries/patchcogsentry","metadata":{"seo":{"title":"Partially updates a cogs entry with the specified ID.","description":"This method will patch an existing cogs entry with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/cogsEntries/{tenantId}/{id}"},{"label":"Updates a cogs entry with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/cogs-entries/updatecogsentry","routeSlug":"/apis/collect/collect-v1/cogs-entries/updatecogsentry","metadata":{"seo":{"title":"Updates a cogs entry with the specified ID.","description":"This method will update an existing cogs entry with the specified ID."}},"httpPath":"/cogsEntries/{tenantId}/{id}"}]},{"type":"group","label":"Credit Memos","link":"/apis/collect/collect-v1/credit-memos","routeSlug":"/apis/collect/collect-v1/credit-memos","items":[{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credit-memos/warmupstepfunctions","routeSlug":"/apis/collect/collect-v1/credit-memos/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"httpPath":"/creditMemos/warmUpStepFunctions"},{"label":"Processes a new credit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credit-memos/processcreditmemo","routeSlug":"/apis/collect/collect-v1/credit-memos/processcreditmemo","metadata":{"seo":{"title":"Processes a new credit memo","description":"This method will auto-generate an ID and create a new credit memo. If an ID is specified for the credit memo, an error will be thrown."}},"httpPath":"/creditMemos/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credit-memos/executebatchoperations","routeSlug":"/apis/collect/collect-v1/credit-memos/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/creditMemos/{tenantId}/batch"},{"label":"Returns a list of records with the specified batch_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credit-memos/listmemosbybatchid","routeSlug":"/apis/collect/collect-v1/credit-memos/listmemosbybatchid","metadata":{"seo":{"title":"Returns a list of records with the specified batch_id","description":"Returns a list of records with the specified batch_id"}},"httpPath":"/creditMemos/{tenantId}/batch/{batch_id}"},{"label":"Searches for credit memos using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credit-memos/searchforcreditmemos","routeSlug":"/apis/collect/collect-v1/credit-memos/searchforcreditmemos","metadata":{"seo":{"title":"Searches for credit memos using predefined parameters","description":"Searches for credit memos using predefined parameters"}},"httpPath":"/creditMemos/{tenantId}/search"},{"label":"Gets all of the credit memos in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credit-memos/listcreditmemos","routeSlug":"/apis/collect/collect-v1/credit-memos/listcreditmemos","metadata":{"seo":{"title":"Gets all of the credit memos in the system.","description":"This method will scan all credit memos and and return them to the caller."}},"httpPath":"/creditMemos/{tenantId}/sync"},{"label":"Creates a new credit that doesn't already exist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credit-memos/processcreditmemosync","routeSlug":"/apis/collect/collect-v1/credit-memos/processcreditmemosync","metadata":{"seo":{"title":"Creates a new credit that doesn't already exist","description":"This method will auto-generate an ID and create a new credit memo. If an ID is specified for the credit memo, an error will be thrown."}},"httpPath":"/creditMemos/{tenantId}/sync"},{"label":"Returns a credit memo from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credit-memos/getcreditmemo","routeSlug":"/apis/collect/collect-v1/credit-memos/getcreditmemo","metadata":{"seo":{"title":"Returns a credit memo from the system by its ID.","description":"This method will look up a credit memo by the specified ID and return it back."}},"httpPath":"/creditMemos/{tenantId}/{id}"},{"label":"Partially updates a credit memo with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credit-memos/patchcreditmemo","routeSlug":"/apis/collect/collect-v1/credit-memos/patchcreditmemo","metadata":{"seo":{"title":"Partially updates a credit memo with the specified ID.","description":"This method will patch an existing credit memo with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/creditMemos/{tenantId}/{id}"},{"label":"Updates a credit memo with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credit-memos/updatecreditmemo","routeSlug":"/apis/collect/collect-v1/credit-memos/updatecreditmemo","metadata":{"seo":{"title":"Updates a credit memo with the specified ID.","description":"This method will update an existing credit memo with the specified ID."}},"httpPath":"/creditMemos/{tenantId}/{id}"}]},{"type":"group","label":"Credits","link":"/apis/collect/collect-v1/credits","routeSlug":"/apis/collect/collect-v1/credits","items":[{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/warmupstepfunctions","routeSlug":"/apis/collect/collect-v1/credits/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"httpPath":"/credits/warmUpStepFunctions"},{"label":"Gets all of the credits in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/listcredits","routeSlug":"/apis/collect/collect-v1/credits/listcredits","metadata":{"seo":{"title":"Gets all of the credits in the system.","description":"This method will scan all credits and and return them to the caller."}},"httpPath":"/credits/{tenantId}"},{"label":"Creates a new credit record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/processcredit","routeSlug":"/apis/collect/collect-v1/credits/processcredit","metadata":{"seo":{"title":"Creates a new credit record that does not already exist.","description":"This method will auto-generate an ID and create a new credit. If an ID is specified for the credit, an error will be thrown."}},"httpPath":"/credits/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/executebatchoperations","routeSlug":"/apis/collect/collect-v1/credits/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/credits/{tenantId}/batch"},{"label":"Returns a list of records with the specified batch_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/listcreditsbybatchid","routeSlug":"/apis/collect/collect-v1/credits/listcreditsbybatchid","metadata":{"seo":{"title":"Returns a list of records with the specified batch_id","description":"Returns a list of records with the specified batch_id"}},"httpPath":"/credits/{tenantId}/batch/{batch_id}"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/listcreditsbycontactid","routeSlug":"/apis/collect/collect-v1/credits/listcreditsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/credits/{tenantId}/contact/{contact_id}"},{"label":"Creates a new credit record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/createcredit","routeSlug":"/apis/collect/collect-v1/credits/createcredit","metadata":{"seo":{"title":"Creates a new credit record that does not already exist.","description":"This method will auto-generate an ID and create a new credit. If an ID is specified for the credit, an error will be thrown."}},"httpPath":"/credits/{tenantId}/manual"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/listcreditsbyorganizationid","routeSlug":"/apis/collect/collect-v1/credits/listcreditsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/credits/{tenantId}/organization/{organization_id}"},{"label":"Returns a list of records with the specified owner_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/listcreditsbyownerid","routeSlug":"/apis/collect/collect-v1/credits/listcreditsbyownerid","metadata":{"seo":{"title":"Returns a list of records with the specified owner_id","description":"Returns a list of records with the specified owner_id"}},"httpPath":"/credits/{tenantId}/owner/{owner_type}/{owner_id}"},{"label":"Searches for credits using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/searchforcredits","routeSlug":"/apis/collect/collect-v1/credits/searchforcredits","metadata":{"seo":{"title":"Searches for credits using predefined parameters","description":"Searches for credits using predefined parameters"}},"httpPath":"/credits/{tenantId}/search"},{"label":"Creates a new credit that doesn't already exist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/processcreditsync","routeSlug":"/apis/collect/collect-v1/credits/processcreditsync","metadata":{"seo":{"title":"Creates a new credit that doesn't already exist","description":"This method will auto-generate an ID and create a new credit. If an ID is specified for the credit, an error will be thrown."}},"httpPath":"/credits/{tenantId}/sync"},{"label":"Returns a credit from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/deletecredit","routeSlug":"/apis/collect/collect-v1/credits/deletecredit","metadata":{"seo":{"title":"Returns a credit from the system by its ID.","description":"This method will delete a credit with the specified ID."}},"httpPath":"/credits/{tenantId}/{id}"},{"label":"Returns a credit from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/getcredit","routeSlug":"/apis/collect/collect-v1/credits/getcredit","metadata":{"seo":{"title":"Returns a credit from the system by its ID.","description":"This method will look up a credit by the specified ID and return it back."}},"httpPath":"/credits/{tenantId}/{id}"},{"label":"Partially updates a credit with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/patchcredit","routeSlug":"/apis/collect/collect-v1/credits/patchcredit","metadata":{"seo":{"title":"Partially updates a credit with the specified ID.","description":"This method will patch an existing credit with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/credits/{tenantId}/{id}"},{"label":"Updates a credit with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/credits/updatecredit","routeSlug":"/apis/collect/collect-v1/credits/updatecredit","metadata":{"seo":{"title":"Updates a credit with the specified ID.","description":"This method will update an existing credit with the specified ID."}},"httpPath":"/credits/{tenantId}/{id}"}]},{"type":"group","label":"Currency Mapping Policies","link":"/apis/collect/collect-v1/currency-mapping-policies","routeSlug":"/apis/collect/collect-v1/currency-mapping-policies","items":[{"label":"Gets all of the currency mapping policies in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/currency-mapping-policies/listcurrencymappingpolicies","routeSlug":"/apis/collect/collect-v1/currency-mapping-policies/listcurrencymappingpolicies","metadata":{"seo":{"title":"Gets all of the currency mapping policies in the system.","description":"This method will scan all currency mapping policies and and return them to the caller."}},"httpPath":"/currencyMappingPolicies/{tenantId}"},{"label":"Creates a new currency mapping policy record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/currency-mapping-policies/createcurrencymappingpolicy","routeSlug":"/apis/collect/collect-v1/currency-mapping-policies/createcurrencymappingpolicy","metadata":{"seo":{"title":"Creates a new currency mapping policy record that does not already exist.","description":"This method will auto-generate an ID and create a new currency mapping policy. If an ID is specified for the currency mapping policy, an error will be thrown."}},"httpPath":"/currencyMappingPolicies/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/currency-mapping-policies/executebatchoperations","routeSlug":"/apis/collect/collect-v1/currency-mapping-policies/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/currencyMappingPolicies/{tenantId}/batch"},{"label":"Returns a currency mapping policy from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/currency-mapping-policies/deletecurrencymappingpolicy","routeSlug":"/apis/collect/collect-v1/currency-mapping-policies/deletecurrencymappingpolicy","metadata":{"seo":{"title":"Returns a currency mapping policy from the system by its ID.","description":"This method will delete a currency mapping policy with the specified ID."}},"httpPath":"/currencyMappingPolicies/{tenantId}/{id}"},{"label":"Returns a currency mapping policy from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/currency-mapping-policies/getcurrencymappingpolicy","routeSlug":"/apis/collect/collect-v1/currency-mapping-policies/getcurrencymappingpolicy","metadata":{"seo":{"title":"Returns a currency mapping policy from the system by its ID.","description":"This method will look up a currency mapping policy by the specified ID and return it back."}},"httpPath":"/currencyMappingPolicies/{tenantId}/{id}"},{"label":"Partially updates a currency mapping policy with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/currency-mapping-policies/patchcurrencymappingpolicy","routeSlug":"/apis/collect/collect-v1/currency-mapping-policies/patchcurrencymappingpolicy","metadata":{"seo":{"title":"Partially updates a currency mapping policy with the specified ID.","description":"This method will patch an existing currency mapping policy with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/currencyMappingPolicies/{tenantId}/{id}"},{"label":"Updates a currency mapping policy with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/currency-mapping-policies/updatecurrencymappingpolicy","routeSlug":"/apis/collect/collect-v1/currency-mapping-policies/updatecurrencymappingpolicy","metadata":{"seo":{"title":"Updates a currency mapping policy with the specified ID.","description":"This method will update an existing currency mapping policy with the specified ID."}},"httpPath":"/currencyMappingPolicies/{tenantId}/{id}"}]},{"type":"group","label":"Debit Memos","link":"/apis/collect/collect-v1/debit-memos","routeSlug":"/apis/collect/collect-v1/debit-memos","items":[{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/debit-memos/warmupstepfunctions","routeSlug":"/apis/collect/collect-v1/debit-memos/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"httpPath":"/debitMemos/warmUpStepFunctions"},{"label":"Gets all of the debit memos in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/debit-memos/listdebitmemos","routeSlug":"/apis/collect/collect-v1/debit-memos/listdebitmemos","metadata":{"seo":{"title":"Gets all of the debit memos in the system.","description":"This method will scan all debit memos and and return them to the caller."}},"httpPath":"/debitMemos/{tenantId}"},{"label":"Processes a new debit memo","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/debit-memos/processdebitmemo","routeSlug":"/apis/collect/collect-v1/debit-memos/processdebitmemo","metadata":{"seo":{"title":"Processes a new debit memo","description":"This method will auto-generate an ID and create a new debit memo. If an ID is specified for the debit memo, an error will be thrown."}},"httpPath":"/debitMemos/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/debit-memos/executebatchoperations","routeSlug":"/apis/collect/collect-v1/debit-memos/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/debitMemos/{tenantId}/batch"},{"label":"Returns a list of records with the specified batch_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/debit-memos/listmemosbybatchid","routeSlug":"/apis/collect/collect-v1/debit-memos/listmemosbybatchid","metadata":{"seo":{"title":"Returns a list of records with the specified batch_id","description":"Returns a list of records with the specified batch_id"}},"httpPath":"/debitMemos/{tenantId}/batch/{batch_id}"},{"label":"Searches for debit memos using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/debit-memos/searchfordebitmemos","routeSlug":"/apis/collect/collect-v1/debit-memos/searchfordebitmemos","metadata":{"seo":{"title":"Searches for debit memos using predefined parameters","description":"Searches for debit memos using predefined parameters"}},"httpPath":"/debitMemos/{tenantId}/search"},{"label":"Creates a new debit that doesn't already exist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/debit-memos/processdebitmemosync","routeSlug":"/apis/collect/collect-v1/debit-memos/processdebitmemosync","metadata":{"seo":{"title":"Creates a new debit that doesn't already exist","description":"This method will auto-generate an ID and create a new debit memo. If an ID is specified for the debit memo, an error will be thrown."}},"httpPath":"/debitMemos/{tenantId}/sync"},{"label":"Returns a debit memo from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/debit-memos/getdebitmemo","routeSlug":"/apis/collect/collect-v1/debit-memos/getdebitmemo","metadata":{"seo":{"title":"Returns a debit memo from the system by its ID.","description":"This method will look up a debit memo by the specified ID and return it back."}},"httpPath":"/debitMemos/{tenantId}/{id}"},{"label":"Partially updates a debit memo with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/debit-memos/patchdebitmemo","routeSlug":"/apis/collect/collect-v1/debit-memos/patchdebitmemo","metadata":{"seo":{"title":"Partially updates a debit memo with the specified ID.","description":"This method will patch an existing debit memo with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/debitMemos/{tenantId}/{id}"},{"label":"Updates a debit memo with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/debit-memos/updatedebitmemo","routeSlug":"/apis/collect/collect-v1/debit-memos/updatedebitmemo","metadata":{"seo":{"title":"Updates a debit memo with the specified ID.","description":"This method will update an existing debit memo with the specified ID."}},"httpPath":"/debitMemos/{tenantId}/{id}"}]},{"type":"group","label":"Departments","link":"/apis/collect/collect-v1/departments","routeSlug":"/apis/collect/collect-v1/departments","items":[{"label":"Gets all of the departments in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/departments/listdepartments","routeSlug":"/apis/collect/collect-v1/departments/listdepartments","metadata":{"seo":{"title":"Gets all of the departments in the system.","description":"This method will scan all departments and and return them to the caller."}},"httpPath":"/departments/{tenantId}"},{"label":"Creates a new department record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/departments/createdepartment","routeSlug":"/apis/collect/collect-v1/departments/createdepartment","metadata":{"seo":{"title":"Creates a new department record that does not already exist.","description":"This method will auto-generate an ID and create a new department. If an ID is specified for the department, an error will be thrown."}},"httpPath":"/departments/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/departments/executebatchoperations","routeSlug":"/apis/collect/collect-v1/departments/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/departments/{tenantId}/batch"},{"label":"Returns a department from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/departments/deletedepartment","routeSlug":"/apis/collect/collect-v1/departments/deletedepartment","metadata":{"seo":{"title":"Returns a department from the system by its ID.","description":"This method will delete a department with the specified ID."}},"httpPath":"/departments/{tenantId}/{id}"},{"label":"Returns a department from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/departments/getdepartment","routeSlug":"/apis/collect/collect-v1/departments/getdepartment","metadata":{"seo":{"title":"Returns a department from the system by its ID.","description":"This method will look up a department by the specified ID and return it back."}},"httpPath":"/departments/{tenantId}/{id}"},{"label":"Partially updates a department with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/departments/patchdepartment","routeSlug":"/apis/collect/collect-v1/departments/patchdepartment","metadata":{"seo":{"title":"Partially updates a department with the specified ID.","description":"This method will patch an existing department with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/departments/{tenantId}/{id}"},{"label":"Updates a department with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/departments/updatedepartment","routeSlug":"/apis/collect/collect-v1/departments/updatedepartment","metadata":{"seo":{"title":"Updates a department with the specified ID.","description":"This method will update an existing department with the specified ID."}},"httpPath":"/departments/{tenantId}/{id}"}]},{"type":"group","label":"Donation Products","link":"/apis/collect/collect-v1/donation-products","routeSlug":"/apis/collect/collect-v1/donation-products","items":[{"label":"Gets all of the donation products in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/donation-products/listdonationproducts","routeSlug":"/apis/collect/collect-v1/donation-products/listdonationproducts","metadata":{"seo":{"title":"Gets all of the donation products in the system.","description":"This method will scan all donation products and and return them to the caller."}},"httpPath":"/donationProducts/{tenantId}"},{"label":"Creates a new donation product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/donation-products/createdonationproduct","routeSlug":"/apis/collect/collect-v1/donation-products/createdonationproduct","metadata":{"seo":{"title":"Creates a new donation product record that does not already exist.","description":"This method will auto-generate an ID and create a new donation product. If an ID is specified for the donation product, an error will be thrown."}},"httpPath":"/donationProducts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/donation-products/executebatchoperations","routeSlug":"/apis/collect/collect-v1/donation-products/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/donationProducts/{tenantId}/batch"},{"label":"Returns a donation product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/donation-products/deletedonationproduct","routeSlug":"/apis/collect/collect-v1/donation-products/deletedonationproduct","metadata":{"seo":{"title":"Returns a donation product from the system by its ID.","description":"This method will delete a donation product with the specified ID."}},"httpPath":"/donationProducts/{tenantId}/{id}"},{"label":"Returns a donation product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/donation-products/getdonationproduct","routeSlug":"/apis/collect/collect-v1/donation-products/getdonationproduct","metadata":{"seo":{"title":"Returns a donation product from the system by its ID.","description":"This method will look up a donation product by the specified ID and return it back."}},"httpPath":"/donationProducts/{tenantId}/{id}"},{"label":"Partially updates a donation product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/donation-products/patchdonationproduct","routeSlug":"/apis/collect/collect-v1/donation-products/patchdonationproduct","metadata":{"seo":{"title":"Partially updates a donation product with the specified ID.","description":"This method will patch an existing donation product with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/donationProducts/{tenantId}/{id}"},{"label":"Updates a donation product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/donation-products/updatedonationproduct","routeSlug":"/apis/collect/collect-v1/donation-products/updatedonationproduct","metadata":{"seo":{"title":"Updates a donation product with the specified ID.","description":"This method will update an existing donation product with the specified ID."}},"httpPath":"/donationProducts/{tenantId}/{id}"}]},{"type":"group","label":"Exchange Rates","link":"/apis/collect/collect-v1/exchange-rates","routeSlug":"/apis/collect/collect-v1/exchange-rates","items":[{"label":"Gets all of the exchange rates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/exchange-rates/listexchangerates","routeSlug":"/apis/collect/collect-v1/exchange-rates/listexchangerates","metadata":{"seo":{"title":"Gets all of the exchange rates in the system.","description":"This method will scan all exchange rates and and return them to the caller."}},"httpPath":"/exchangeRates/{tenantId}"},{"label":"Creates a new exchange rate record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/exchange-rates/createexchangerate","routeSlug":"/apis/collect/collect-v1/exchange-rates/createexchangerate","metadata":{"seo":{"title":"Creates a new exchange rate record that does not already exist.","description":"This method will auto-generate an ID and create a new exchange rate. If an ID is specified for the exchange rate, an error will be thrown."}},"httpPath":"/exchangeRates/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/exchange-rates/executebatchoperations","routeSlug":"/apis/collect/collect-v1/exchange-rates/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/exchangeRates/{tenantId}/batch"},{"label":"Returns a exchange rate from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/exchange-rates/deleteexchangerate","routeSlug":"/apis/collect/collect-v1/exchange-rates/deleteexchangerate","metadata":{"seo":{"title":"Returns a exchange rate from the system by its ID.","description":"This method will delete a exchange rate with the specified ID."}},"httpPath":"/exchangeRates/{tenantId}/{id}"},{"label":"Returns a exchange rate from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/exchange-rates/getexchangerate","routeSlug":"/apis/collect/collect-v1/exchange-rates/getexchangerate","metadata":{"seo":{"title":"Returns a exchange rate from the system by its ID.","description":"This method will look up a exchange rate by the specified ID and return it back."}},"httpPath":"/exchangeRates/{tenantId}/{id}"},{"label":"Partially updates a exchange rate with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/exchange-rates/patchexchangerate","routeSlug":"/apis/collect/collect-v1/exchange-rates/patchexchangerate","metadata":{"seo":{"title":"Partially updates a exchange rate with the specified ID.","description":"This method will patch an existing exchange rate with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/exchangeRates/{tenantId}/{id}"},{"label":"Updates a exchange rate with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/exchange-rates/updateexchangerate","routeSlug":"/apis/collect/collect-v1/exchange-rates/updateexchangerate","metadata":{"seo":{"title":"Updates a exchange rate with the specified ID.","description":"This method will update an existing exchange rate with the specified ID."}},"httpPath":"/exchangeRates/{tenantId}/{id}"}]},{"type":"group","label":"External Payments","link":"/apis/collect/collect-v1/external-payments","routeSlug":"/apis/collect/collect-v1/external-payments","items":[{"label":"Creates a new external payment record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/external-payments/createexternalpayment","routeSlug":"/apis/collect/collect-v1/external-payments/createexternalpayment","metadata":{"seo":{"title":"Creates a new external payment record that does not already exist.","description":"This method will auto-generate an ID and create a new external payment. If an ID is specified for the external payment, an error will be thrown."}},"httpPath":"/externalPayments/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/external-payments/executebatchoperations","routeSlug":"/apis/collect/collect-v1/external-payments/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/externalPayments/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/external-payments/listpaymentsbycontactid","routeSlug":"/apis/collect/collect-v1/external-payments/listpaymentsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/externalPayments/{tenantId}/contact/{contact_id}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/external-payments/listpaymentsbyorganizationid","routeSlug":"/apis/collect/collect-v1/external-payments/listpaymentsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/externalPayments/{tenantId}/organization/{organization_id}"},{"label":"Returns a external payment from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/external-payments/deleteexternalpayment","routeSlug":"/apis/collect/collect-v1/external-payments/deleteexternalpayment","metadata":{"seo":{"title":"Returns a external payment from the system by its ID.","description":"This method will delete a external payment with the specified ID."}},"httpPath":"/externalPayments/{tenantId}/{id}"},{"label":"Returns a external payment from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/external-payments/getexternalpayment","routeSlug":"/apis/collect/collect-v1/external-payments/getexternalpayment","metadata":{"seo":{"title":"Returns a external payment from the system by its ID.","description":"This method will look up a external payment by the specified ID and return it back."}},"httpPath":"/externalPayments/{tenantId}/{id}"},{"label":"Partially updates a external payment with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/external-payments/patchexternalpayment","routeSlug":"/apis/collect/collect-v1/external-payments/patchexternalpayment","metadata":{"seo":{"title":"Partially updates a external payment with the specified ID.","description":"This method will patch an existing external payment with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/externalPayments/{tenantId}/{id}"},{"label":"Updates a external payment with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/external-payments/updateexternalpayment","routeSlug":"/apis/collect/collect-v1/external-payments/updateexternalpayment","metadata":{"seo":{"title":"Updates a external payment with the specified ID.","description":"This method will update an existing external payment with the specified ID."}},"httpPath":"/externalPayments/{tenantId}/{id}"}]},{"type":"group","label":"Fiscal Years","link":"/apis/collect/collect-v1/fiscal-years","routeSlug":"/apis/collect/collect-v1/fiscal-years","items":[{"label":"Gets all of the fiscal years in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/listfiscalyears","routeSlug":"/apis/collect/collect-v1/fiscal-years/listfiscalyears","metadata":{"seo":{"title":"Gets all of the fiscal years in the system.","description":"This method will scan all fiscal years and and return them to the caller."}},"httpPath":"/fiscalYears/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/executebatchoperations","routeSlug":"/apis/collect/collect-v1/fiscal-years/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/fiscalYears/{tenantId}/batch"},{"label":"Returns a list of records with the specified business_unit_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/listyearsbybusinessunitid","routeSlug":"/apis/collect/collect-v1/fiscal-years/listyearsbybusinessunitid","metadata":{"seo":{"title":"Returns a list of records with the specified business_unit_id","description":"Returns a list of records with the specified business_unit_id"}},"httpPath":"/fiscalYears/{tenantId}/businessUnit/{business_unit_id}"},{"label":"Creates the next fiscal year for a business unit","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/generatenewfiscalyear","routeSlug":"/apis/collect/collect-v1/fiscal-years/generatenewfiscalyear","metadata":{"seo":{"title":"Creates the next fiscal year for a business unit","description":"This method will automatically create a fiscal year for a business unit in the future"}},"httpPath":"/fiscalYears/{tenantId}/businessUnit/{business_unit_id}"},{"label":"Initiates workflow to close a fiscal period","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/closefiscalperiods","routeSlug":"/apis/collect/collect-v1/fiscal-years/closefiscalperiods","metadata":{"seo":{"title":"Initiates workflow to close a fiscal period","description":"This method will initiate the fiscal period close process"}},"httpPath":"/fiscalYears/{tenantId}/close/{fiscalYearId}/{fiscalPeriod}"},{"label":"Gets the current fiscal year and period","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/getcurrentfiscalperiod","routeSlug":"/apis/collect/collect-v1/fiscal-years/getcurrentfiscalperiod","metadata":{"seo":{"title":"Gets the current fiscal year and period","description":"This method looks at all of the fiscal years and periods and finds the first \"open\" one, which is the current"}},"httpPath":"/fiscalYears/{tenantId}/current/{businessUnitId}"},{"label":"Gets the fiscal year and fiscal period for a particular date","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/getfiscalperiodfordate","routeSlug":"/apis/collect/collect-v1/fiscal-years/getfiscalperiodfordate","metadata":{"seo":{"title":"Gets the fiscal year and fiscal period for a particular date","description":"This method will return a fiscal year and fiscal period object"}},"httpPath":"/fiscalYears/{tenantId}/fiscalPeriod/{businessUnitId}/{date}"},{"label":"Initiates workflow to reopen a fiscal period","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/reopenfiscalperiods","routeSlug":"/apis/collect/collect-v1/fiscal-years/reopenfiscalperiods","metadata":{"seo":{"title":"Initiates workflow to reopen a fiscal period","description":"This method will initiate the fiscal period reopen process"}},"httpPath":"/fiscalYears/{tenantId}/reopen/{fiscalYearId}/{fiscalPeriod}"},{"label":"Returns a fiscal year from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/deletefiscalyear","routeSlug":"/apis/collect/collect-v1/fiscal-years/deletefiscalyear","metadata":{"seo":{"title":"Returns a fiscal year from the system by its ID.","description":"This method will delete a fiscal year with the specified ID."}},"httpPath":"/fiscalYears/{tenantId}/{id}"},{"label":"Returns a fiscal year from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/getfiscalyear","routeSlug":"/apis/collect/collect-v1/fiscal-years/getfiscalyear","metadata":{"seo":{"title":"Returns a fiscal year from the system by its ID.","description":"This method will look up a fiscal year by the specified ID and return it back."}},"httpPath":"/fiscalYears/{tenantId}/{id}"},{"label":"Partially updates a fiscal year with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/patchfiscalyear","routeSlug":"/apis/collect/collect-v1/fiscal-years/patchfiscalyear","metadata":{"seo":{"title":"Partially updates a fiscal year with the specified ID.","description":"This method will patch an existing fiscal year with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/fiscalYears/{tenantId}/{id}"},{"label":"Updates a fiscal year with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/fiscal-years/updatefiscalyear","routeSlug":"/apis/collect/collect-v1/fiscal-years/updatefiscalyear","metadata":{"seo":{"title":"Updates a fiscal year with the specified ID.","description":"This method will update an existing fiscal year with the specified ID."}},"httpPath":"/fiscalYears/{tenantId}/{id}"}]},{"type":"group","label":"Gateway Entities","link":"/apis/collect/collect-v1/gateway-entities","routeSlug":"/apis/collect/collect-v1/gateway-entities","items":[{"label":"Returns a gateway entity from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/gateway-entities/getgatewayentity","routeSlug":"/apis/collect/collect-v1/gateway-entities/getgatewayentity","metadata":{"seo":{"title":"Returns a gateway entity from the system by its ID.","description":"This method will look up a gateway entity by the specified ID and return it back."}},"httpPath":"/gatewayEntities/{tenantId}/{id}"}]},{"type":"group","label":"Gateway Entries","link":"/apis/collect/collect-v1/gateway-entries","routeSlug":"/apis/collect/collect-v1/gateway-entries","items":[{"label":"Returns a gateway entry from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/gateway-entries/getgatewayentry","routeSlug":"/apis/collect/collect-v1/gateway-entries/getgatewayentry","metadata":{"seo":{"title":"Returns a gateway entry from the system by its ID.","description":"This method will look up a gateway entry by the specified ID and return it back."}},"httpPath":"/gatewayEntries/{tenantId}/{id}"}]},{"type":"group","label":"Gateway Fees","link":"/apis/collect/collect-v1/gateway-fees","routeSlug":"/apis/collect/collect-v1/gateway-fees","items":[{"label":"Returns a gateway fee from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/gateway-fees/getgatewayfee","routeSlug":"/apis/collect/collect-v1/gateway-fees/getgatewayfee","metadata":{"seo":{"title":"Returns a gateway fee from the system by its ID.","description":"This method will look up a gateway fee by the specified ID and return it back."}},"httpPath":"/gatewayFees/{tenantId}/{id}"}]},{"type":"group","label":"Gl Accounts","link":"/apis/collect/collect-v1/gl-accounts","routeSlug":"/apis/collect/collect-v1/gl-accounts","items":[{"label":"Gets all of the gl accounts in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/gl-accounts/listglaccounts","routeSlug":"/apis/collect/collect-v1/gl-accounts/listglaccounts","metadata":{"seo":{"title":"Gets all of the gl accounts in the system.","description":"This method will scan all gl accounts and and return them to the caller."}},"httpPath":"/glAccounts/{tenantId}"},{"label":"Creates a new gl account record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/gl-accounts/createglaccount","routeSlug":"/apis/collect/collect-v1/gl-accounts/createglaccount","metadata":{"seo":{"title":"Creates a new gl account record that does not already exist.","description":"This method will auto-generate an ID and create a new gl account. If an ID is specified for the gl account, an error will be thrown."}},"httpPath":"/glAccounts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/gl-accounts/executebatchoperations","routeSlug":"/apis/collect/collect-v1/gl-accounts/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/glAccounts/{tenantId}/batch"},{"label":"Returns a gl account from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/gl-accounts/deleteglaccount","routeSlug":"/apis/collect/collect-v1/gl-accounts/deleteglaccount","metadata":{"seo":{"title":"Returns a gl account from the system by its ID.","description":"This method will delete a gl account with the specified ID."}},"httpPath":"/glAccounts/{tenantId}/{id}"},{"label":"Returns a gl account from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/gl-accounts/getglaccount","routeSlug":"/apis/collect/collect-v1/gl-accounts/getglaccount","metadata":{"seo":{"title":"Returns a gl account from the system by its ID.","description":"This method will look up a gl account by the specified ID and return it back."}},"httpPath":"/glAccounts/{tenantId}/{id}"},{"label":"Partially updates a gl account with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/gl-accounts/patchglaccount","routeSlug":"/apis/collect/collect-v1/gl-accounts/patchglaccount","metadata":{"seo":{"title":"Partially updates a gl account with the specified ID.","description":"This method will patch an existing gl account with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/glAccounts/{tenantId}/{id}"},{"label":"Updates a gl account with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/gl-accounts/updateglaccount","routeSlug":"/apis/collect/collect-v1/gl-accounts/updateglaccount","metadata":{"seo":{"title":"Updates a gl account with the specified ID.","description":"This method will update an existing gl account with the specified ID."}},"httpPath":"/glAccounts/{tenantId}/{id}"}]},{"type":"group","label":"Installment Plans","link":"/apis/collect/collect-v1/installment-plans","routeSlug":"/apis/collect/collect-v1/installment-plans","items":[{"label":"Gets all of the installment plans in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-plans/listinstallmentplans","routeSlug":"/apis/collect/collect-v1/installment-plans/listinstallmentplans","metadata":{"seo":{"title":"Gets all of the installment plans in the system.","description":"This method will scan all installment plans and and return them to the caller."}},"httpPath":"/installmentPlans/{tenantId}"},{"label":"Creates a new installment plan record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-plans/createinstallmentplan","routeSlug":"/apis/collect/collect-v1/installment-plans/createinstallmentplan","metadata":{"seo":{"title":"Creates a new installment plan record that does not already exist.","description":"This method will auto-generate an ID and create a new installment plan. If an ID is specified for the installment plan, an error will be thrown."}},"httpPath":"/installmentPlans/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-plans/executebatchoperations","routeSlug":"/apis/collect/collect-v1/installment-plans/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/installmentPlans/{tenantId}/batch"},{"label":"Returns a installment plan from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-plans/deleteinstallmentplan","routeSlug":"/apis/collect/collect-v1/installment-plans/deleteinstallmentplan","metadata":{"seo":{"title":"Returns a installment plan from the system by its ID.","description":"This method will delete a installment plan with the specified ID."}},"httpPath":"/installmentPlans/{tenantId}/{id}"},{"label":"Returns a installment plan from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-plans/getinstallmentplan","routeSlug":"/apis/collect/collect-v1/installment-plans/getinstallmentplan","metadata":{"seo":{"title":"Returns a installment plan from the system by its ID.","description":"This method will look up a installment plan by the specified ID and return it back."}},"httpPath":"/installmentPlans/{tenantId}/{id}"},{"label":"Partially updates a installment plan with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-plans/patchinstallmentplan","routeSlug":"/apis/collect/collect-v1/installment-plans/patchinstallmentplan","metadata":{"seo":{"title":"Partially updates a installment plan with the specified ID.","description":"This method will patch an existing installment plan with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/installmentPlans/{tenantId}/{id}"},{"label":"Updates a installment plan with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-plans/updateinstallmentplan","routeSlug":"/apis/collect/collect-v1/installment-plans/updateinstallmentplan","metadata":{"seo":{"title":"Updates a installment plan with the specified ID.","description":"This method will update an existing installment plan with the specified ID."}},"httpPath":"/installmentPlans/{tenantId}/{id}"}]},{"type":"group","label":"Installment Schedules","link":"/apis/collect/collect-v1/installment-schedules","routeSlug":"/apis/collect/collect-v1/installment-schedules","items":[{"label":"Gets all of the installment schedules in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-schedules/listinstallmentschedules","routeSlug":"/apis/collect/collect-v1/installment-schedules/listinstallmentschedules","metadata":{"seo":{"title":"Gets all of the installment schedules in the system.","description":"This method will scan all installment schedules and and return them to the caller."}},"httpPath":"/installmentSchedules/{tenantId}"},{"label":"Creates a new installment schedule record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-schedules/createinstallmentschedule","routeSlug":"/apis/collect/collect-v1/installment-schedules/createinstallmentschedule","metadata":{"seo":{"title":"Creates a new installment schedule record that does not already exist.","description":"This method will auto-generate an ID and create a new installment schedule. If an ID is specified for the installment schedule, an error will be thrown."}},"httpPath":"/installmentSchedules/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-schedules/executebatchoperations","routeSlug":"/apis/collect/collect-v1/installment-schedules/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/installmentSchedules/{tenantId}/batch"},{"label":"Returns all installment schedules by order id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-schedules/listinstallmentschedulesbyorderid","routeSlug":"/apis/collect/collect-v1/installment-schedules/listinstallmentschedulesbyorderid","metadata":{"seo":{"title":"Returns all installment schedules by order id","description":"Returns all installment schedules by order id"}},"httpPath":"/installmentSchedules/{tenantId}/order/{orderId}"},{"label":"Process Installment Schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-schedules/processinstallmentschedule","routeSlug":"/apis/collect/collect-v1/installment-schedules/processinstallmentschedule","metadata":{"seo":{"title":"Process Installment Schedule","description":"Will process the schedule, creating invoices/payments or orders as necessary"}},"httpPath":"/installmentSchedules/{tenantId}/process"},{"label":"Returns a installment schedule from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-schedules/deleteinstallmentschedule","routeSlug":"/apis/collect/collect-v1/installment-schedules/deleteinstallmentschedule","metadata":{"seo":{"title":"Returns a installment schedule from the system by its ID.","description":"This method will delete a installment schedule with the specified ID."}},"httpPath":"/installmentSchedules/{tenantId}/{id}"},{"label":"Returns a installment schedule from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-schedules/getinstallmentschedule","routeSlug":"/apis/collect/collect-v1/installment-schedules/getinstallmentschedule","metadata":{"seo":{"title":"Returns a installment schedule from the system by its ID.","description":"This method will look up a installment schedule by the specified ID and return it back."}},"httpPath":"/installmentSchedules/{tenantId}/{id}"},{"label":"Partially updates a installment schedule with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-schedules/patchinstallmentschedule","routeSlug":"/apis/collect/collect-v1/installment-schedules/patchinstallmentschedule","metadata":{"seo":{"title":"Partially updates a installment schedule with the specified ID.","description":"This method will patch an existing installment schedule with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/installmentSchedules/{tenantId}/{id}"},{"label":"Updates a installment schedule with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/installment-schedules/updateinstallmentschedule","routeSlug":"/apis/collect/collect-v1/installment-schedules/updateinstallmentschedule","metadata":{"seo":{"title":"Updates a installment schedule with the specified ID.","description":"This method will update an existing installment schedule with the specified ID."}},"httpPath":"/installmentSchedules/{tenantId}/{id}"}]},{"type":"group","label":"Invoice Payment Terms","link":"/apis/collect/collect-v1/invoice-payment-terms","routeSlug":"/apis/collect/collect-v1/invoice-payment-terms","items":[{"label":"Gets all of the invoice payment terms in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-payment-terms/listinvoicepaymentterms","routeSlug":"/apis/collect/collect-v1/invoice-payment-terms/listinvoicepaymentterms","metadata":{"seo":{"title":"Gets all of the invoice payment terms in the system.","description":"This method will scan all invoice payment terms and and return them to the caller."}},"httpPath":"/invoicePaymentTerms/{tenantId}"},{"label":"Creates a new invoice payment term record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-payment-terms/createinvoicepaymentterm","routeSlug":"/apis/collect/collect-v1/invoice-payment-terms/createinvoicepaymentterm","metadata":{"seo":{"title":"Creates a new invoice payment term record that does not already exist.","description":"This method will auto-generate an ID and create a new invoice payment term. If an ID is specified for the invoice payment term, an error will be thrown."}},"httpPath":"/invoicePaymentTerms/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-payment-terms/executebatchoperations","routeSlug":"/apis/collect/collect-v1/invoice-payment-terms/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/invoicePaymentTerms/{tenantId}/batch"},{"label":"Returns a invoice payment term from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-payment-terms/deleteinvoicepaymentterm","routeSlug":"/apis/collect/collect-v1/invoice-payment-terms/deleteinvoicepaymentterm","metadata":{"seo":{"title":"Returns a invoice payment term from the system by its ID.","description":"This method will delete a invoice payment term with the specified ID."}},"httpPath":"/invoicePaymentTerms/{tenantId}/{id}"},{"label":"Returns a invoice payment term from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-payment-terms/getinvoicepaymentterm","routeSlug":"/apis/collect/collect-v1/invoice-payment-terms/getinvoicepaymentterm","metadata":{"seo":{"title":"Returns a invoice payment term from the system by its ID.","description":"This method will look up a invoice payment term by the specified ID and return it back."}},"httpPath":"/invoicePaymentTerms/{tenantId}/{id}"},{"label":"Partially updates a invoice payment term with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-payment-terms/patchinvoicepaymentterm","routeSlug":"/apis/collect/collect-v1/invoice-payment-terms/patchinvoicepaymentterm","metadata":{"seo":{"title":"Partially updates a invoice payment term with the specified ID.","description":"This method will patch an existing invoice payment term with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/invoicePaymentTerms/{tenantId}/{id}"},{"label":"Updates a invoice payment term with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-payment-terms/updateinvoicepaymentterm","routeSlug":"/apis/collect/collect-v1/invoice-payment-terms/updateinvoicepaymentterm","metadata":{"seo":{"title":"Updates a invoice payment term with the specified ID.","description":"This method will update an existing invoice payment term with the specified ID."}},"httpPath":"/invoicePaymentTerms/{tenantId}/{id}"}]},{"type":"group","label":"Invoice Templates","link":"/apis/collect/collect-v1/invoice-templates","routeSlug":"/apis/collect/collect-v1/invoice-templates","items":[{"label":"Gets all of the invoice templates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-templates/listinvoicetemplates","routeSlug":"/apis/collect/collect-v1/invoice-templates/listinvoicetemplates","metadata":{"seo":{"title":"Gets all of the invoice templates in the system.","description":"This method will scan all invoice templates and and return them to the caller."}},"httpPath":"/invoiceTemplates/{tenantId}"},{"label":"Creates a new invoice template record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-templates/createinvoicetemplate","routeSlug":"/apis/collect/collect-v1/invoice-templates/createinvoicetemplate","metadata":{"seo":{"title":"Creates a new invoice template record that does not already exist.","description":"This method will auto-generate an ID and create a new invoice template. If an ID is specified for the invoice template, an error will be thrown."}},"httpPath":"/invoiceTemplates/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-templates/executebatchoperations","routeSlug":"/apis/collect/collect-v1/invoice-templates/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/invoiceTemplates/{tenantId}/batch"},{"label":"Returns a invoice template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-templates/deleteinvoicetemplate","routeSlug":"/apis/collect/collect-v1/invoice-templates/deleteinvoicetemplate","metadata":{"seo":{"title":"Returns a invoice template from the system by its ID.","description":"This method will delete a invoice template with the specified ID."}},"httpPath":"/invoiceTemplates/{tenantId}/{id}"},{"label":"Returns a invoice template from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-templates/getinvoicetemplate","routeSlug":"/apis/collect/collect-v1/invoice-templates/getinvoicetemplate","metadata":{"seo":{"title":"Returns a invoice template from the system by its ID.","description":"This method will look up a invoice template by the specified ID and return it back."}},"httpPath":"/invoiceTemplates/{tenantId}/{id}"},{"label":"Partially updates a invoice template with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-templates/patchinvoicetemplate","routeSlug":"/apis/collect/collect-v1/invoice-templates/patchinvoicetemplate","metadata":{"seo":{"title":"Partially updates a invoice template with the specified ID.","description":"This method will patch an existing invoice template with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/invoiceTemplates/{tenantId}/{id}"},{"label":"Updates a invoice template with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-templates/updateinvoicetemplate","routeSlug":"/apis/collect/collect-v1/invoice-templates/updateinvoicetemplate","metadata":{"seo":{"title":"Updates a invoice template with the specified ID.","description":"This method will update an existing invoice template with the specified ID."}},"httpPath":"/invoiceTemplates/{tenantId}/{id}"}]},{"type":"group","label":"Invoice Types","link":"/apis/collect/collect-v1/invoice-types","routeSlug":"/apis/collect/collect-v1/invoice-types","items":[{"label":"Gets all of the invoice types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-types/listinvoicetypes","routeSlug":"/apis/collect/collect-v1/invoice-types/listinvoicetypes","metadata":{"seo":{"title":"Gets all of the invoice types in the system.","description":"This method will scan all invoice types and and return them to the caller."}},"httpPath":"/invoiceTypes/{tenantId}"},{"label":"Creates a new invoice type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-types/createinvoicetype","routeSlug":"/apis/collect/collect-v1/invoice-types/createinvoicetype","metadata":{"seo":{"title":"Creates a new invoice type record that does not already exist.","description":"This method will auto-generate an ID and create a new invoice type. If an ID is specified for the invoice type, an error will be thrown."}},"httpPath":"/invoiceTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-types/executebatchoperations","routeSlug":"/apis/collect/collect-v1/invoice-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/invoiceTypes/{tenantId}/batch"},{"label":"Returns a invoice type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-types/deleteinvoicetype","routeSlug":"/apis/collect/collect-v1/invoice-types/deleteinvoicetype","metadata":{"seo":{"title":"Returns a invoice type from the system by its ID.","description":"This method will delete a invoice type with the specified ID."}},"httpPath":"/invoiceTypes/{tenantId}/{id}"},{"label":"Returns a invoice type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-types/getinvoicetype","routeSlug":"/apis/collect/collect-v1/invoice-types/getinvoicetype","metadata":{"seo":{"title":"Returns a invoice type from the system by its ID.","description":"This method will look up a invoice type by the specified ID and return it back."}},"httpPath":"/invoiceTypes/{tenantId}/{id}"},{"label":"Partially updates a invoice type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-types/patchinvoicetype","routeSlug":"/apis/collect/collect-v1/invoice-types/patchinvoicetype","metadata":{"seo":{"title":"Partially updates a invoice type with the specified ID.","description":"This method will patch an existing invoice type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/invoiceTypes/{tenantId}/{id}"},{"label":"Updates a invoice type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoice-types/updateinvoicetype","routeSlug":"/apis/collect/collect-v1/invoice-types/updateinvoicetype","metadata":{"seo":{"title":"Updates a invoice type with the specified ID.","description":"This method will update an existing invoice type with the specified ID."}},"httpPath":"/invoiceTypes/{tenantId}/{id}"}]},{"type":"group","label":"Invoices","link":"/apis/collect/collect-v1/invoices","routeSlug":"/apis/collect/collect-v1/invoices","items":[{"label":"Returns the default invoice template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/getdefaultinvoicetemplate","routeSlug":"/apis/collect/collect-v1/invoices/getdefaultinvoicetemplate","metadata":{"seo":{"title":"Returns the default invoice template","description":"Returns the default invoice template"}},"httpPath":"/invoices/defaultTemplate/invoice"},{"label":"Returns the default invoice template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/getdefaultinvoicetemplateandemail","routeSlug":"/apis/collect/collect-v1/invoices/getdefaultinvoicetemplateandemail","metadata":{"seo":{"title":"Returns the default invoice template","description":"Returns the default invoice template"}},"httpPath":"/invoices/defaultTemplateAndEmail/invoice"},{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/warmupstepfunctions","routeSlug":"/apis/collect/collect-v1/invoices/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"httpPath":"/invoices/warmUpStepFunctions"},{"label":"Creates a new invoice record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/processinvoice","routeSlug":"/apis/collect/collect-v1/invoices/processinvoice","metadata":{"seo":{"title":"Creates a new invoice record that does not already exist.","description":"This method will auto-generate an ID and create a new invoice. If an ID is specified for the invoice, an error will be thrown."}},"httpPath":"/invoices/{tenantId}"},{"label":"Processes an invoice adjustment for the invoice with the specified ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/adjustinvoiceamountssync","routeSlug":"/apis/collect/collect-v1/invoices/adjustinvoiceamountssync","metadata":{"seo":{"title":"Processes an invoice adjustment for the invoice with the specified ID","description":"This method will start an workflow to adjust an invoice, returning an execution token."}},"httpPath":"/invoices/{tenantId}/adjustment/sync/{id}"},{"label":"Processes an invoice adjustment for the invoice with the specified ID","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/adjustinvoiceamounts","routeSlug":"/apis/collect/collect-v1/invoices/adjustinvoiceamounts","metadata":{"seo":{"title":"Processes an invoice adjustment for the invoice with the specified ID","description":"This method will start an workflow to adjust an invoice, returning an execution token."}},"httpPath":"/invoices/{tenantId}/adjustment/{id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/executebatchoperations","routeSlug":"/apis/collect/collect-v1/invoices/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/invoices/{tenantId}/batch"},{"label":"Returns a list of records with the specified batch_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/listinvoicesbybatchid","routeSlug":"/apis/collect/collect-v1/invoices/listinvoicesbybatchid","metadata":{"seo":{"title":"Returns a list of records with the specified batch_id","description":"Returns a list of records with the specified batch_id"}},"httpPath":"/invoices/{tenantId}/batch/{batch_id}"},{"label":"Returns a list of records with the specified bill_to_contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/listinvoicesbybilltocontactid","routeSlug":"/apis/collect/collect-v1/invoices/listinvoicesbybilltocontactid","metadata":{"seo":{"title":"Returns a list of records with the specified bill_to_contact_id","description":"Returns a list of records with the specified bill_to_contact_id"}},"httpPath":"/invoices/{tenantId}/billToContact/{bill_to_contact_id}"},{"label":"Returns a list of records with the specified bill_to_organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/listinvoicesbybilltoorganizationid","routeSlug":"/apis/collect/collect-v1/invoices/listinvoicesbybilltoorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified bill_to_organization_id","description":"Returns a list of records with the specified bill_to_organization_id"}},"httpPath":"/invoices/{tenantId}/billToOrganization/{bill_to_organization_id}"},{"label":"Emails an HTML version of the invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/emailinvoice","routeSlug":"/apis/collect/collect-v1/invoices/emailinvoice","metadata":{"seo":{"title":"Emails an HTML version of the invoice","description":"Send an email of the invoice"}},"httpPath":"/invoices/{tenantId}/email/{id}"},{"label":"Returns a list of records with the specified number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/listinvoicesbynumber","routeSlug":"/apis/collect/collect-v1/invoices/listinvoicesbynumber","metadata":{"seo":{"title":"Returns a list of records with the specified number","description":"Returns a list of records with the specified number"}},"httpPath":"/invoices/{tenantId}/number/{number}"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/listinvoicesbyorderid","routeSlug":"/apis/collect/collect-v1/invoices/listinvoicesbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"httpPath":"/invoices/{tenantId}/order/{order_id}"},{"label":"Returns a list of records with the specified owner","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/listinvoicesbyowner","routeSlug":"/apis/collect/collect-v1/invoices/listinvoicesbyowner","metadata":{"seo":{"title":"Returns a list of records with the specified owner","description":"Returns a list of records with the specified owner"}},"httpPath":"/invoices/{tenantId}/owner/{ownerType}/{ownerId}"},{"label":"Gets the URL for public payment of the invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/getpublicpaymentlink","routeSlug":"/apis/collect/collect-v1/invoices/getpublicpaymentlink","metadata":{"seo":{"title":"Gets the URL for public payment of the invoice","description":"Returns a link that can be used to share an invoice and payable"}},"httpPath":"/invoices/{tenantId}/paymentLink/{id}"},{"label":"Gets all of the invoices in the system for a given contact.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/listinvoicesforportal","routeSlug":"/apis/collect/collect-v1/invoices/listinvoicesforportal","metadata":{"seo":{"title":"Gets all of the invoices in the system for a given contact.","description":"This method will scan all invoices and and return them to the caller for a given contact."}},"httpPath":"/invoices/{tenantId}/portal/contact/{portalContactId}"},{"label":"Gets the amount of open invoices for a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/getcontactbalance","routeSlug":"/apis/collect/collect-v1/invoices/getcontactbalance","metadata":{"seo":{"title":"Gets the amount of open invoices for a contact","description":"Gets the amount of open invoices for a contact"}},"httpPath":"/invoices/{tenantId}/portal/contact/{portalContactId}/balance"},{"label":"Returns a invoice from the system by its ID for a given contact.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/getinvoiceforportal","routeSlug":"/apis/collect/collect-v1/invoices/getinvoiceforportal","metadata":{"seo":{"title":"Returns a invoice from the system by its ID for a given contact.","description":"This method will look up a invoice by the specified ID and return it back (for a portal contact)"}},"httpPath":"/invoices/{tenantId}/portal/contact/{portalContactId}/{id}"},{"label":"Gets all of the invoices in the system for a given organization.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/listinvoicesforportalbyorganization","routeSlug":"/apis/collect/collect-v1/invoices/listinvoicesforportalbyorganization","metadata":{"seo":{"title":"Gets all of the invoices in the system for a given organization.","description":"This method will scan all invoices and and return them to the caller for a given organization."}},"httpPath":"/invoices/{tenantId}/portal/organization/{portalOrganizationId}"},{"label":"Gets the amount of open invoices for a organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/getorganizationbalance","routeSlug":"/apis/collect/collect-v1/invoices/getorganizationbalance","metadata":{"seo":{"title":"Gets the amount of open invoices for a organization","description":"Gets the amount of open invoices for a organization"}},"httpPath":"/invoices/{tenantId}/portal/organization/{portalOrganizationId}/balance"},{"label":"Returns a invoice from the system by its ID for a given organization.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/getinvoiceforportal","routeSlug":"/apis/collect/collect-v1/invoices/getinvoiceforportal","metadata":{"seo":{"title":"Returns a invoice from the system by its ID for a given organization.","description":"This method will look up a invoice by the specified ID and return it back (for a portal organization)"}},"httpPath":"/invoices/{tenantId}/portal/organization/{portalOrganizationId}/{id}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/previewemail","routeSlug":"/apis/collect/collect-v1/invoices/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/invoices/{tenantId}/previewEmail"},{"label":"Sends out a preview of the notification template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/previewtemplate","routeSlug":"/apis/collect/collect-v1/invoices/previewtemplate","metadata":{"seo":{"title":"Sends out a preview of the notification template","description":"Sends out a preview of the notification template"}},"httpPath":"/invoices/{tenantId}/previewTemplate"},{"label":"Generates a PDF and returns the public link for download","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/downloadpdf","routeSlug":"/apis/collect/collect-v1/invoices/downloadpdf","metadata":{"seo":{"title":"Generates a PDF and returns the public link for download","description":"Generates a PDF and returns the public link for download"}},"httpPath":"/invoices/{tenantId}/print/{id}"},{"label":"Gets Public Invoice information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/getinvoicepublicly","routeSlug":"/apis/collect/collect-v1/invoices/getinvoicepublicly","metadata":{"seo":{"title":"Gets Public Invoice information","description":"Public endpoint that allows for retrieval of invoice information, provided the accurate sharing secret is supplied"}},"httpPath":"/invoices/{tenantId}/public/{id}"},{"label":"Finds all legacy invoices with an open balance and regenerates them","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/regeneratelegacyopeninvoices","routeSlug":"/apis/collect/collect-v1/invoices/regeneratelegacyopeninvoices","metadata":{"seo":{"title":"Finds all legacy invoices with an open balance and regenerates them","description":"Finds all legacy invoices with an open balance and regenerates them"}},"httpPath":"/invoices/{tenantId}/regenerateOpenInvoices/{business_unit_id}"},{"label":"Generates a PDF and returns the public link for download","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/renderinvoiceemail","routeSlug":"/apis/collect/collect-v1/invoices/renderinvoiceemail","metadata":{"seo":{"title":"Generates a PDF and returns the public link for download","description":"Generates a PDF and returns the public link for download"}},"httpPath":"/invoices/{tenantId}/renderEmail/{id}"},{"label":"Searches for invoices using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/searchforinvoices","routeSlug":"/apis/collect/collect-v1/invoices/searchforinvoices","metadata":{"seo":{"title":"Searches for invoices using predefined parameters","description":"Searches for invoices using predefined parameters"}},"httpPath":"/invoices/{tenantId}/search"},{"label":"This is a synchronous processing and should be used exclusively. The old way (via step function) is deprecated.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/processinvoicesync","routeSlug":"/apis/collect/collect-v1/invoices/processinvoicesync","metadata":{"seo":{"title":"This is a synchronous processing and should be used exclusively. The old way (via step function) is deprecated.","description":"Processes an invoice"}},"httpPath":"/invoices/{tenantId}/sync"},{"label":"Returns a invoice from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/deleteinvoice","routeSlug":"/apis/collect/collect-v1/invoices/deleteinvoice","metadata":{"seo":{"title":"Returns a invoice from the system by its ID.","description":"This method will delete a invoice with the specified ID."}},"httpPath":"/invoices/{tenantId}/{id}"},{"label":"Returns a invoice from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/getinvoice","routeSlug":"/apis/collect/collect-v1/invoices/getinvoice","metadata":{"seo":{"title":"Returns a invoice from the system by its ID.","description":"This method will look up a invoice by the specified ID and return it back."}},"httpPath":"/invoices/{tenantId}/{id}"},{"label":"Partially updates a invoice with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/patchinvoice","routeSlug":"/apis/collect/collect-v1/invoices/patchinvoice","metadata":{"seo":{"title":"Partially updates a invoice with the specified ID.","description":"This method will patch an existing invoice with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/invoices/{tenantId}/{id}"},{"label":"Updates a invoice with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/invoices/updateinvoice","routeSlug":"/apis/collect/collect-v1/invoices/updateinvoice","metadata":{"seo":{"title":"Updates a invoice with the specified ID.","description":"This method will update an existing invoice with the specified ID."}},"httpPath":"/invoices/{tenantId}/{id}"}]},{"type":"group","label":"Late Fee Rules","link":"/apis/collect/collect-v1/late-fee-rules","routeSlug":"/apis/collect/collect-v1/late-fee-rules","items":[{"label":"Gets all of the late fee rules in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fee-rules/listlatefeerules","routeSlug":"/apis/collect/collect-v1/late-fee-rules/listlatefeerules","metadata":{"seo":{"title":"Gets all of the late fee rules in the system.","description":"This method will scan all late fee rules and and return them to the caller."}},"httpPath":"/lateFeeRules/{tenantId}"},{"label":"Creates a new late fee rule record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fee-rules/createlatefeerule","routeSlug":"/apis/collect/collect-v1/late-fee-rules/createlatefeerule","metadata":{"seo":{"title":"Creates a new late fee rule record that does not already exist.","description":"This method will auto-generate an ID and create a new late fee rule. If an ID is specified for the late fee rule, an error will be thrown."}},"httpPath":"/lateFeeRules/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fee-rules/executebatchoperations","routeSlug":"/apis/collect/collect-v1/late-fee-rules/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/lateFeeRules/{tenantId}/batch"},{"label":"Returns a late fee rule from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fee-rules/deletelatefeerule","routeSlug":"/apis/collect/collect-v1/late-fee-rules/deletelatefeerule","metadata":{"seo":{"title":"Returns a late fee rule from the system by its ID.","description":"This method will delete a late fee rule with the specified ID."}},"httpPath":"/lateFeeRules/{tenantId}/{id}"},{"label":"Returns a late fee rule from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fee-rules/getlatefeerule","routeSlug":"/apis/collect/collect-v1/late-fee-rules/getlatefeerule","metadata":{"seo":{"title":"Returns a late fee rule from the system by its ID.","description":"This method will look up a late fee rule by the specified ID and return it back."}},"httpPath":"/lateFeeRules/{tenantId}/{id}"},{"label":"Partially updates a late fee rule with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fee-rules/patchlatefeerule","routeSlug":"/apis/collect/collect-v1/late-fee-rules/patchlatefeerule","metadata":{"seo":{"title":"Partially updates a late fee rule with the specified ID.","description":"This method will patch an existing late fee rule with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/lateFeeRules/{tenantId}/{id}"},{"label":"Updates a late fee rule with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fee-rules/updatelatefeerule","routeSlug":"/apis/collect/collect-v1/late-fee-rules/updatelatefeerule","metadata":{"seo":{"title":"Updates a late fee rule with the specified ID.","description":"This method will update an existing late fee rule with the specified ID."}},"httpPath":"/lateFeeRules/{tenantId}/{id}"}]},{"type":"group","label":"Late Fees","link":"/apis/collect/collect-v1/late-fees","routeSlug":"/apis/collect/collect-v1/late-fees","items":[{"label":"Gets all of the late fees in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fees/listlatefees","routeSlug":"/apis/collect/collect-v1/late-fees/listlatefees","metadata":{"seo":{"title":"Gets all of the late fees in the system.","description":"This method will scan all late fees and and return them to the caller."}},"httpPath":"/lateFees/{tenantId}"},{"label":"Creates a new late fee record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fees/createlatefee","routeSlug":"/apis/collect/collect-v1/late-fees/createlatefee","metadata":{"seo":{"title":"Creates a new late fee record that does not already exist.","description":"This method will auto-generate an ID and create a new late fee. If an ID is specified for the late fee, an error will be thrown."}},"httpPath":"/lateFees/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fees/executebatchoperations","routeSlug":"/apis/collect/collect-v1/late-fees/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/lateFees/{tenantId}/batch"},{"label":"Returns a late fee from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fees/deletelatefee","routeSlug":"/apis/collect/collect-v1/late-fees/deletelatefee","metadata":{"seo":{"title":"Returns a late fee from the system by its ID.","description":"This method will delete a late fee with the specified ID."}},"httpPath":"/lateFees/{tenantId}/{id}"},{"label":"Returns a late fee from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fees/getlatefee","routeSlug":"/apis/collect/collect-v1/late-fees/getlatefee","metadata":{"seo":{"title":"Returns a late fee from the system by its ID.","description":"This method will look up a late fee by the specified ID and return it back."}},"httpPath":"/lateFees/{tenantId}/{id}"},{"label":"Partially updates a late fee with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fees/patchlatefee","routeSlug":"/apis/collect/collect-v1/late-fees/patchlatefee","metadata":{"seo":{"title":"Partially updates a late fee with the specified ID.","description":"This method will patch an existing late fee with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/lateFees/{tenantId}/{id}"},{"label":"Updates a late fee with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/late-fees/updatelatefee","routeSlug":"/apis/collect/collect-v1/late-fees/updatelatefee","metadata":{"seo":{"title":"Updates a late fee with the specified ID.","description":"This method will update an existing late fee with the specified ID."}},"httpPath":"/lateFees/{tenantId}/{id}"}]},{"type":"group","label":"Legacy Import Products","link":"/apis/collect/collect-v1/legacy-import-products","routeSlug":"/apis/collect/collect-v1/legacy-import-products","items":[{"label":"Gets all of the legacy import products in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/legacy-import-products/listlegacyimportproducts","routeSlug":"/apis/collect/collect-v1/legacy-import-products/listlegacyimportproducts","metadata":{"seo":{"title":"Gets all of the legacy import products in the system.","description":"This method will scan all legacy import products and and return them to the caller."}},"httpPath":"/legacyImportProducts/{tenantId}"},{"label":"Creates a new legacy import product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/legacy-import-products/createlegacyimportproduct","routeSlug":"/apis/collect/collect-v1/legacy-import-products/createlegacyimportproduct","metadata":{"seo":{"title":"Creates a new legacy import product record that does not already exist.","description":"This method will auto-generate an ID and create a new legacy import product. If an ID is specified for the legacy import product, an error will be thrown."}},"httpPath":"/legacyImportProducts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/legacy-import-products/executebatchoperations","routeSlug":"/apis/collect/collect-v1/legacy-import-products/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/legacyImportProducts/{tenantId}/batch"},{"label":"Returns a legacy import product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/legacy-import-products/deletelegacyimportproduct","routeSlug":"/apis/collect/collect-v1/legacy-import-products/deletelegacyimportproduct","metadata":{"seo":{"title":"Returns a legacy import product from the system by its ID.","description":"This method will delete a legacy import product with the specified ID."}},"httpPath":"/legacyImportProducts/{tenantId}/{id}"},{"label":"Returns a legacy import product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/legacy-import-products/getlegacyimportproduct","routeSlug":"/apis/collect/collect-v1/legacy-import-products/getlegacyimportproduct","metadata":{"seo":{"title":"Returns a legacy import product from the system by its ID.","description":"This method will look up a legacy import product by the specified ID and return it back."}},"httpPath":"/legacyImportProducts/{tenantId}/{id}"},{"label":"Partially updates a legacy import product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/legacy-import-products/patchlegacyimportproduct","routeSlug":"/apis/collect/collect-v1/legacy-import-products/patchlegacyimportproduct","metadata":{"seo":{"title":"Partially updates a legacy import product with the specified ID.","description":"This method will patch an existing legacy import product with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/legacyImportProducts/{tenantId}/{id}"},{"label":"Updates a legacy import product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/legacy-import-products/updatelegacyimportproduct","routeSlug":"/apis/collect/collect-v1/legacy-import-products/updatelegacyimportproduct","metadata":{"seo":{"title":"Updates a legacy import product with the specified ID.","description":"This method will update an existing legacy import product with the specified ID."}},"httpPath":"/legacyImportProducts/{tenantId}/{id}"}]},{"type":"group","label":"Merchant Accounts","link":"/apis/collect/collect-v1/merchant-accounts","routeSlug":"/apis/collect/collect-v1/merchant-accounts","items":[{"label":"Gets all of the merchant accounts in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/merchant-accounts/listmerchantaccounts","routeSlug":"/apis/collect/collect-v1/merchant-accounts/listmerchantaccounts","metadata":{"seo":{"title":"Gets all of the merchant accounts in the system.","description":"This method will scan all merchant accounts and and return them to the caller."}},"httpPath":"/merchantAccounts/{tenantId}"},{"label":"Creates a new merchant account record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/merchant-accounts/createmerchantaccount","routeSlug":"/apis/collect/collect-v1/merchant-accounts/createmerchantaccount","metadata":{"seo":{"title":"Creates a new merchant account record that does not already exist.","description":"This method will auto-generate an ID and create a new merchant account. If an ID is specified for the merchant account, an error will be thrown."}},"httpPath":"/merchantAccounts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/merchant-accounts/executebatchoperations","routeSlug":"/apis/collect/collect-v1/merchant-accounts/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/merchantAccounts/{tenantId}/batch"},{"label":"Gets all of the merchant accounts in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/merchant-accounts/listmerchantaccountspublic","routeSlug":"/apis/collect/collect-v1/merchant-accounts/listmerchantaccountspublic","metadata":{"seo":{"title":"Gets all of the merchant accounts in the system.","description":"This method will scan all merchant accounts and and return them to the caller."}},"httpPath":"/merchantAccounts/{tenantId}/public"},{"label":"Returns a merchant account from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/merchant-accounts/deletemerchantaccount","routeSlug":"/apis/collect/collect-v1/merchant-accounts/deletemerchantaccount","metadata":{"seo":{"title":"Returns a merchant account from the system by its ID.","description":"This method will delete a merchant account with the specified ID."}},"httpPath":"/merchantAccounts/{tenantId}/{id}"},{"label":"Returns a merchant account from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/merchant-accounts/getmerchantaccount","routeSlug":"/apis/collect/collect-v1/merchant-accounts/getmerchantaccount","metadata":{"seo":{"title":"Returns a merchant account from the system by its ID.","description":"This method will look up a merchant account by the specified ID and return it back."}},"httpPath":"/merchantAccounts/{tenantId}/{id}"},{"label":"Partially updates a merchant account with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/merchant-accounts/patchmerchantaccount","routeSlug":"/apis/collect/collect-v1/merchant-accounts/patchmerchantaccount","metadata":{"seo":{"title":"Partially updates a merchant account with the specified ID.","description":"This method will patch an existing merchant account with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/merchantAccounts/{tenantId}/{id}"},{"label":"Updates a merchant account with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/merchant-accounts/updatemerchantaccount","routeSlug":"/apis/collect/collect-v1/merchant-accounts/updatemerchantaccount","metadata":{"seo":{"title":"Updates a merchant account with the specified ID.","description":"This method will update an existing merchant account with the specified ID."}},"httpPath":"/merchantAccounts/{tenantId}/{id}"}]},{"type":"group","label":"Miscellaneous Products","link":"/apis/collect/collect-v1/miscellaneous-products","routeSlug":"/apis/collect/collect-v1/miscellaneous-products","items":[{"label":"Gets all of the miscellaneous products in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/miscellaneous-products/listmiscellaneousproducts","routeSlug":"/apis/collect/collect-v1/miscellaneous-products/listmiscellaneousproducts","metadata":{"seo":{"title":"Gets all of the miscellaneous products in the system.","description":"This method will scan all miscellaneous products and and return them to the caller."}},"httpPath":"/miscellaneousProducts/{tenantId}"},{"label":"Creates a new miscellaneous product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/miscellaneous-products/createmiscellaneousproduct","routeSlug":"/apis/collect/collect-v1/miscellaneous-products/createmiscellaneousproduct","metadata":{"seo":{"title":"Creates a new miscellaneous product record that does not already exist.","description":"This method will auto-generate an ID and create a new miscellaneous product. If an ID is specified for the miscellaneous product, an error will be thrown."}},"httpPath":"/miscellaneousProducts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/miscellaneous-products/executebatchoperations","routeSlug":"/apis/collect/collect-v1/miscellaneous-products/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/miscellaneousProducts/{tenantId}/batch"},{"label":"Returns a miscellaneous product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/miscellaneous-products/deletemiscellaneousproduct","routeSlug":"/apis/collect/collect-v1/miscellaneous-products/deletemiscellaneousproduct","metadata":{"seo":{"title":"Returns a miscellaneous product from the system by its ID.","description":"This method will delete a miscellaneous product with the specified ID."}},"httpPath":"/miscellaneousProducts/{tenantId}/{id}"},{"label":"Returns a miscellaneous product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/miscellaneous-products/getmiscellaneousproduct","routeSlug":"/apis/collect/collect-v1/miscellaneous-products/getmiscellaneousproduct","metadata":{"seo":{"title":"Returns a miscellaneous product from the system by its ID.","description":"This method will look up a miscellaneous product by the specified ID and return it back."}},"httpPath":"/miscellaneousProducts/{tenantId}/{id}"},{"label":"Partially updates a miscellaneous product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/miscellaneous-products/patchmiscellaneousproduct","routeSlug":"/apis/collect/collect-v1/miscellaneous-products/patchmiscellaneousproduct","metadata":{"seo":{"title":"Partially updates a miscellaneous product with the specified ID.","description":"This method will patch an existing miscellaneous product with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/miscellaneousProducts/{tenantId}/{id}"},{"label":"Updates a miscellaneous product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/miscellaneous-products/updatemiscellaneousproduct","routeSlug":"/apis/collect/collect-v1/miscellaneous-products/updatemiscellaneousproduct","metadata":{"seo":{"title":"Updates a miscellaneous product with the specified ID.","description":"This method will update an existing miscellaneous product with the specified ID."}},"httpPath":"/miscellaneousProducts/{tenantId}/{id}"}]},{"type":"group","label":"Payment Receipt Templates","link":"/apis/collect/collect-v1/payment-receipt-templates","routeSlug":"/apis/collect/collect-v1/payment-receipt-templates","items":[{"label":"Gets all of the payment receipt templates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payment-receipt-templates/listpaymentreceipttemplates","routeSlug":"/apis/collect/collect-v1/payment-receipt-templates/listpaymentreceipttemplates","metadata":{"seo":{"title":"Gets all of the payment receipt templates in the system.","description":"This method will scan all payment receipt templates and and return them to the caller."}},"httpPath":"/paymentReceiptTemplates/{tenantId}"},{"label":"Creates a new payment receipt template record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payment-receipt-templates/createpaymentreceipttemplate","routeSlug":"/apis/collect/collect-v1/payment-receipt-templates/createpaymentreceipttemplate","metadata":{"seo":{"title":"Creates a new payment receipt template record that does not already exist.","description":"This method will auto-generate an ID and create a new payment receipt template. If an ID is specified for the payment receipt template, an error will be thrown."}},"httpPath":"/paymentReceiptTemplates/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payment-receipt-templates/executebatchoperations","routeSlug":"/apis/collect/collect-v1/payment-receipt-templates/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/paymentReceiptTemplates/{tenantId}/batch"},{"label":"Returns a payment receipt template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payment-receipt-templates/deletepaymentreceipttemplate","routeSlug":"/apis/collect/collect-v1/payment-receipt-templates/deletepaymentreceipttemplate","metadata":{"seo":{"title":"Returns a payment receipt template from the system by its ID.","description":"This method will delete a payment receipt template with the specified ID."}},"httpPath":"/paymentReceiptTemplates/{tenantId}/{id}"},{"label":"Returns a payment receipt template from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payment-receipt-templates/getpaymentreceipttemplate","routeSlug":"/apis/collect/collect-v1/payment-receipt-templates/getpaymentreceipttemplate","metadata":{"seo":{"title":"Returns a payment receipt template from the system by its ID.","description":"This method will look up a payment receipt template by the specified ID and return it back."}},"httpPath":"/paymentReceiptTemplates/{tenantId}/{id}"},{"label":"Partially updates a payment receipt template with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payment-receipt-templates/patchpaymentreceipttemplate","routeSlug":"/apis/collect/collect-v1/payment-receipt-templates/patchpaymentreceipttemplate","metadata":{"seo":{"title":"Partially updates a payment receipt template with the specified ID.","description":"This method will patch an existing payment receipt template with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/paymentReceiptTemplates/{tenantId}/{id}"},{"label":"Updates a payment receipt template with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payment-receipt-templates/updatepaymentreceipttemplate","routeSlug":"/apis/collect/collect-v1/payment-receipt-templates/updatepaymentreceipttemplate","metadata":{"seo":{"title":"Updates a payment receipt template with the specified ID.","description":"This method will update an existing payment receipt template with the specified ID."}},"httpPath":"/paymentReceiptTemplates/{tenantId}/{id}"}]},{"type":"group","label":"Payments","link":"/apis/collect/collect-v1/payments","routeSlug":"/apis/collect/collect-v1/payments","items":[{"label":"Returns the default payment template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/getdefaultpaymentreceipttemplate","routeSlug":"/apis/collect/collect-v1/payments/getdefaultpaymentreceipttemplate","metadata":{"seo":{"title":"Returns the default payment template","description":"Returns the default payment template"}},"httpPath":"/payments/defaultTemplate/paymentReceipt"},{"label":"Returns the default payment template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/getdefaultpaymenttemplateandemail","routeSlug":"/apis/collect/collect-v1/payments/getdefaultpaymenttemplateandemail","metadata":{"seo":{"title":"Returns the default payment template","description":"Returns the default payment template"}},"httpPath":"/payments/defaultTemplateAndEmail/payment"},{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/warmupstepfunctions","routeSlug":"/apis/collect/collect-v1/payments/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"httpPath":"/payments/warmUpStepFunctions"},{"label":"Processes a payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/processpayment","routeSlug":"/apis/collect/collect-v1/payments/processpayment","metadata":{"seo":{"title":"Processes a payment","description":"This method will auto-generate an ID and create a new payment. If an ID is specified for the payment, an error will be thrown."}},"httpPath":"/payments/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/executebatchoperations","routeSlug":"/apis/collect/collect-v1/payments/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/payments/{tenantId}/batch"},{"label":"Returns a list of records with the specified batch_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/listpaymentsbybatchid","routeSlug":"/apis/collect/collect-v1/payments/listpaymentsbybatchid","metadata":{"seo":{"title":"Returns a list of records with the specified batch_id","description":"Returns a list of records with the specified batch_id"}},"httpPath":"/payments/{tenantId}/batch/{batch_id}"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/listpaymentsbycontactid","routeSlug":"/apis/collect/collect-v1/payments/listpaymentsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/payments/{tenantId}/contact/{contact_id}"},{"label":"Emails an HTML version of the payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/emailpayment","routeSlug":"/apis/collect/collect-v1/payments/emailpayment","metadata":{"seo":{"title":"Emails an HTML version of the payment","description":"Send an email of the payment"}},"httpPath":"/payments/{tenantId}/email/{id}"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/listpaymentsbyorderid","routeSlug":"/apis/collect/collect-v1/payments/listpaymentsbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"httpPath":"/payments/{tenantId}/order/{order_id}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/listpaymentsbyorganizationid","routeSlug":"/apis/collect/collect-v1/payments/listpaymentsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/payments/{tenantId}/organization/{organization_id}"},{"label":"Returns a list of records with the specified owner","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/listpaymentsbyowner","routeSlug":"/apis/collect/collect-v1/payments/listpaymentsbyowner","metadata":{"seo":{"title":"Returns a list of records with the specified owner","description":"Returns a list of records with the specified owner"}},"httpPath":"/payments/{tenantId}/owner/{ownerType}/{ownerId}"},{"label":"Gets all of the payments in the system for a given contact.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/listpaymentsforportal","routeSlug":"/apis/collect/collect-v1/payments/listpaymentsforportal","metadata":{"seo":{"title":"Gets all of the payments in the system for a given contact.","description":"This method will scan all payments and and return them to the caller for a given contact."}},"httpPath":"/payments/{tenantId}/portal/contact/{portalContactId}"},{"label":"Returns a payment from the system by its ID for a given contact.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/getpaymentforportal","routeSlug":"/apis/collect/collect-v1/payments/getpaymentforportal","metadata":{"seo":{"title":"Returns a payment from the system by its ID for a given contact.","description":"This method will look up a payment by the specified ID and return it back (for a portal contact)"}},"httpPath":"/payments/{tenantId}/portal/contact/{portalContactId}/{id}"},{"label":"Gets all of the payments in the system for a given organization.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/listpaymentsforportalbyorganization","routeSlug":"/apis/collect/collect-v1/payments/listpaymentsforportalbyorganization","metadata":{"seo":{"title":"Gets all of the payments in the system for a given organization.","description":"This method will scan all payments and and return them to the caller for a given organization."}},"httpPath":"/payments/{tenantId}/portal/organization/{portalOrganizationId}"},{"label":"Returns a payment from the system by its ID for a given organization.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/getpaymentforportal","routeSlug":"/apis/collect/collect-v1/payments/getpaymentforportal","metadata":{"seo":{"title":"Returns a payment from the system by its ID for a given organization.","description":"This method will look up a payment by the specified ID and return it back (for a portal organization)"}},"httpPath":"/payments/{tenantId}/portal/organization/{portalOrganizationId}/{id}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/previewemail","routeSlug":"/apis/collect/collect-v1/payments/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/payments/{tenantId}/previewEmail"},{"label":"Sends out a preview of the notification template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/previewtemplate","routeSlug":"/apis/collect/collect-v1/payments/previewtemplate","metadata":{"seo":{"title":"Sends out a preview of the notification template","description":"Sends out a preview of the notification template"}},"httpPath":"/payments/{tenantId}/previewTemplate"},{"label":"Generates a PDF and returns the public link for download","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/downloadpdf","routeSlug":"/apis/collect/collect-v1/payments/downloadpdf","metadata":{"seo":{"title":"Generates a PDF and returns the public link for download","description":"Generates a PDF and returns the public link for download"}},"httpPath":"/payments/{tenantId}/print/{id}"},{"label":"Processes a public payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/processpublicpayment","routeSlug":"/apis/collect/collect-v1/payments/processpublicpayment","metadata":{"seo":{"title":"Processes a public payment","description":"Allows for publicly payable invoices by taking a payment and processing it anonymously"}},"httpPath":"/payments/{tenantId}/public"},{"label":"Processes a public payment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/processpublicpaymentsync","routeSlug":"/apis/collect/collect-v1/payments/processpublicpaymentsync","metadata":{"seo":{"title":"Processes a public payment","description":"Allows for publicly payable invoices by taking a payment and processing it anonymously"}},"httpPath":"/payments/{tenantId}/public/sync"},{"label":"Generates a PDF and returns the public link for download","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/renderpaymentemail","routeSlug":"/apis/collect/collect-v1/payments/renderpaymentemail","metadata":{"seo":{"title":"Generates a PDF and returns the public link for download","description":"Generates a PDF and returns the public link for download"}},"httpPath":"/payments/{tenantId}/renderEmail/{id}"},{"label":"Searches for payments using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/searchforpayments","routeSlug":"/apis/collect/collect-v1/payments/searchforpayments","metadata":{"seo":{"title":"Searches for payments using predefined parameters","description":"Searches for payments using predefined parameters"}},"httpPath":"/payments/{tenantId}/search"},{"label":"This is a synchronous processing and should be used exclusively. The old way (via step function) is deprecated.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/processpaymentsync","routeSlug":"/apis/collect/collect-v1/payments/processpaymentsync","metadata":{"seo":{"title":"This is a synchronous processing and should be used exclusively. The old way (via step function) is deprecated.","description":"Processes an payment"}},"httpPath":"/payments/{tenantId}/sync"},{"label":"Returns a payment from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/deletepayment","routeSlug":"/apis/collect/collect-v1/payments/deletepayment","metadata":{"seo":{"title":"Returns a payment from the system by its ID.","description":"This method will delete a payment with the specified ID."}},"httpPath":"/payments/{tenantId}/{id}"},{"label":"Returns a payment from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/getpayment","routeSlug":"/apis/collect/collect-v1/payments/getpayment","metadata":{"seo":{"title":"Returns a payment from the system by its ID.","description":"This method will look up a payment by the specified ID and return it back."}},"httpPath":"/payments/{tenantId}/{id}"},{"label":"Partially updates a payment with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/patchpayment","routeSlug":"/apis/collect/collect-v1/payments/patchpayment","metadata":{"seo":{"title":"Partially updates a payment with the specified ID.","description":"This method will patch an existing payment with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/payments/{tenantId}/{id}"},{"label":"Updates a payment with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/updatepayment","routeSlug":"/apis/collect/collect-v1/payments/updatepayment","metadata":{"seo":{"title":"Updates a payment with the specified ID.","description":"This method will update an existing payment with the specified ID."}},"httpPath":"/payments/{tenantId}/{id}"},{"label":"Initiates a payment reversal","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/reversepaymentsync","routeSlug":"/apis/collect/collect-v1/payments/reversepaymentsync","metadata":{"seo":{"title":"Initiates a payment reversal","description":"This method will start a reversal payment process"}},"httpPath":"/payments/{tenantId}/{id}/reverse/sync/{batch_id}"},{"label":"Initiates a payment reversal","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/reversepayment","routeSlug":"/apis/collect/collect-v1/payments/reversepayment","metadata":{"seo":{"title":"Initiates a payment reversal","description":"This method will start a reversal payment process"}},"httpPath":"/payments/{tenantId}/{id}/reverse/{batch_id}"},{"label":"Initiates a payment void","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/voidpayment","routeSlug":"/apis/collect/collect-v1/payments/voidpayment","metadata":{"seo":{"title":"Initiates a payment void","description":"This method will start a void payment process"}},"httpPath":"/payments/{tenantId}/{id}/void"},{"label":"Initiates a payment void","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/payments/voidpaymentsync","routeSlug":"/apis/collect/collect-v1/payments/voidpaymentsync","metadata":{"seo":{"title":"Initiates a payment void","description":"This method will start a void payment process"}},"httpPath":"/payments/{tenantId}/{id}/void/sync"}]},{"type":"group","label":"Product Financial Configs","link":"/apis/collect/collect-v1/product-financial-configs","routeSlug":"/apis/collect/collect-v1/product-financial-configs","items":[{"label":"Gets all of the product financial configs in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/product-financial-configs/listproductfinancialconfigs","routeSlug":"/apis/collect/collect-v1/product-financial-configs/listproductfinancialconfigs","metadata":{"seo":{"title":"Gets all of the product financial configs in the system.","description":"This method will scan all product financial configs and and return them to the caller."}},"httpPath":"/productFinancialConfigs/{tenantId}"},{"label":"Creates a new product financial config record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/product-financial-configs/createproductfinancialconfig","routeSlug":"/apis/collect/collect-v1/product-financial-configs/createproductfinancialconfig","metadata":{"seo":{"title":"Creates a new product financial config record that does not already exist.","description":"This method will auto-generate an ID and create a new product financial config. If an ID is specified for the product financial config, an error will be thrown."}},"httpPath":"/productFinancialConfigs/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/product-financial-configs/executebatchoperations","routeSlug":"/apis/collect/collect-v1/product-financial-configs/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/productFinancialConfigs/{tenantId}/batch"},{"label":"Returns a product financial configs from the system by its product type/ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/product-financial-configs/getproductfinancialconfigsbyproductid","routeSlug":"/apis/collect/collect-v1/product-financial-configs/getproductfinancialconfigsbyproductid","metadata":{"seo":{"title":"Returns a product financial configs from the system by its product type/ID.","description":"This method will look up a product financial configs by the specified ID and return it back."}},"httpPath":"/productFinancialConfigs/{tenantId}/product/{productType}/{productId}"},{"label":"Returns a product financial config from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/product-financial-configs/deleteproductfinancialconfig","routeSlug":"/apis/collect/collect-v1/product-financial-configs/deleteproductfinancialconfig","metadata":{"seo":{"title":"Returns a product financial config from the system by its ID.","description":"This method will delete a product financial config with the specified ID."}},"httpPath":"/productFinancialConfigs/{tenantId}/{id}"},{"label":"Returns a product financial config from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/product-financial-configs/getproductfinancialconfig","routeSlug":"/apis/collect/collect-v1/product-financial-configs/getproductfinancialconfig","metadata":{"seo":{"title":"Returns a product financial config from the system by its ID.","description":"This method will look up a product financial config by the specified ID and return it back."}},"httpPath":"/productFinancialConfigs/{tenantId}/{id}"},{"label":"Partially updates a product financial config with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/product-financial-configs/patchproductfinancialconfig","routeSlug":"/apis/collect/collect-v1/product-financial-configs/patchproductfinancialconfig","metadata":{"seo":{"title":"Partially updates a product financial config with the specified ID.","description":"This method will patch an existing product financial config with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/productFinancialConfigs/{tenantId}/{id}"},{"label":"Updates a product financial config with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/product-financial-configs/updateproductfinancialconfig","routeSlug":"/apis/collect/collect-v1/product-financial-configs/updateproductfinancialconfig","metadata":{"seo":{"title":"Updates a product financial config with the specified ID.","description":"This method will update an existing product financial config with the specified ID."}},"httpPath":"/productFinancialConfigs/{tenantId}/{id}"}]},{"type":"group","label":"Query Definitions","link":"/apis/collect/collect-v1/query-definitions","routeSlug":"/apis/collect/collect-v1/query-definitions","items":[{"label":"Returns a list of records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/query-definitions/getquerydefinitions","routeSlug":"/apis/collect/collect-v1/query-definitions/getquerydefinitions","metadata":{"seo":{"title":"Returns a list of records","description":"Returns a list of records"}},"httpPath":"/queryDefinitions/{tenantId}"}]},{"type":"group","label":"Recurring Batches","link":"/apis/collect/collect-v1/recurring-batches","routeSlug":"/apis/collect/collect-v1/recurring-batches","items":[{"label":"Gets all of the recurring batches in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-batches/listrecurringbatches","routeSlug":"/apis/collect/collect-v1/recurring-batches/listrecurringbatches","metadata":{"seo":{"title":"Gets all of the recurring batches in the system.","description":"This method will scan all recurring batches and and return them to the caller."}},"httpPath":"/recurringBatches/{tenantId}"},{"label":"Creates a new recurring batch record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-batches/createrecurringbatch","routeSlug":"/apis/collect/collect-v1/recurring-batches/createrecurringbatch","metadata":{"seo":{"title":"Creates a new recurring batch record that does not already exist.","description":"This method will auto-generate an ID and create a new recurring batch. If an ID is specified for the recurring batch, an error will be thrown."}},"httpPath":"/recurringBatches/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-batches/executebatchoperations","routeSlug":"/apis/collect/collect-v1/recurring-batches/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/recurringBatches/{tenantId}/batch"},{"label":"Returns a recurring batch from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-batches/deleterecurringbatch","routeSlug":"/apis/collect/collect-v1/recurring-batches/deleterecurringbatch","metadata":{"seo":{"title":"Returns a recurring batch from the system by its ID.","description":"This method will delete a recurring batch with the specified ID."}},"httpPath":"/recurringBatches/{tenantId}/{id}"},{"label":"Returns a recurring batch from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-batches/getrecurringbatch","routeSlug":"/apis/collect/collect-v1/recurring-batches/getrecurringbatch","metadata":{"seo":{"title":"Returns a recurring batch from the system by its ID.","description":"This method will look up a recurring batch by the specified ID and return it back."}},"httpPath":"/recurringBatches/{tenantId}/{id}"},{"label":"Partially updates a recurring batch with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-batches/patchrecurringbatch","routeSlug":"/apis/collect/collect-v1/recurring-batches/patchrecurringbatch","metadata":{"seo":{"title":"Partially updates a recurring batch with the specified ID.","description":"This method will patch an existing recurring batch with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/recurringBatches/{tenantId}/{id}"},{"label":"Updates a recurring batch with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-batches/updaterecurringbatch","routeSlug":"/apis/collect/collect-v1/recurring-batches/updaterecurringbatch","metadata":{"seo":{"title":"Updates a recurring batch with the specified ID.","description":"This method will update an existing recurring batch with the specified ID."}},"httpPath":"/recurringBatches/{tenantId}/{id}"}]},{"type":"group","label":"Recurring Billing Runs","link":"/apis/collect/collect-v1/recurring-billing-runs","routeSlug":"/apis/collect/collect-v1/recurring-billing-runs","items":[{"label":"Gets all of the recurring billing runs in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-billing-runs/listrecurringbillingruns","routeSlug":"/apis/collect/collect-v1/recurring-billing-runs/listrecurringbillingruns","metadata":{"seo":{"title":"Gets all of the recurring billing runs in the system.","description":"This method will scan all recurring billing runs and and return them to the caller."}},"httpPath":"/recurringBillingRuns/{tenantId}"},{"label":"Creates a new recurring billing run record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-billing-runs/createrecurringbillingrun","routeSlug":"/apis/collect/collect-v1/recurring-billing-runs/createrecurringbillingrun","metadata":{"seo":{"title":"Creates a new recurring billing run record that does not already exist.","description":"This method will auto-generate an ID and create a new recurring billing run. If an ID is specified for the recurring billing run, an error will be thrown."}},"httpPath":"/recurringBillingRuns/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-billing-runs/executebatchoperations","routeSlug":"/apis/collect/collect-v1/recurring-billing-runs/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/recurringBillingRuns/{tenantId}/batch"},{"label":"Returns a list of records with the specified template_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-billing-runs/listrunsbytemplateid","routeSlug":"/apis/collect/collect-v1/recurring-billing-runs/listrunsbytemplateid","metadata":{"seo":{"title":"Returns a list of records with the specified template_id","description":"Returns a list of records with the specified template_id"}},"httpPath":"/recurringBillingRuns/{tenantId}/template/{template_id}"},{"label":"Returns a recurring billing run from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-billing-runs/deleterecurringbillingrun","routeSlug":"/apis/collect/collect-v1/recurring-billing-runs/deleterecurringbillingrun","metadata":{"seo":{"title":"Returns a recurring billing run from the system by its ID.","description":"This method will delete a recurring billing run with the specified ID."}},"httpPath":"/recurringBillingRuns/{tenantId}/{id}"},{"label":"Returns a recurring billing run from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-billing-runs/getrecurringbillingrun","routeSlug":"/apis/collect/collect-v1/recurring-billing-runs/getrecurringbillingrun","metadata":{"seo":{"title":"Returns a recurring billing run from the system by its ID.","description":"This method will look up a recurring billing run by the specified ID and return it back."}},"httpPath":"/recurringBillingRuns/{tenantId}/{id}"},{"label":"Partially updates a recurring billing run with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-billing-runs/patchrecurringbillingrun","routeSlug":"/apis/collect/collect-v1/recurring-billing-runs/patchrecurringbillingrun","metadata":{"seo":{"title":"Partially updates a recurring billing run with the specified ID.","description":"This method will patch an existing recurring billing run with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/recurringBillingRuns/{tenantId}/{id}"},{"label":"Updates a recurring billing run with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/recurring-billing-runs/updaterecurringbillingrun","routeSlug":"/apis/collect/collect-v1/recurring-billing-runs/updaterecurringbillingrun","metadata":{"seo":{"title":"Updates a recurring billing run with the specified ID.","description":"This method will update an existing recurring billing run with the specified ID."}},"httpPath":"/recurringBillingRuns/{tenantId}/{id}"}]},{"type":"group","label":"Refund Receipt Templates","link":"/apis/collect/collect-v1/refund-receipt-templates","routeSlug":"/apis/collect/collect-v1/refund-receipt-templates","items":[{"label":"Gets all of the refund receipt templates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refund-receipt-templates/listrefundreceipttemplates","routeSlug":"/apis/collect/collect-v1/refund-receipt-templates/listrefundreceipttemplates","metadata":{"seo":{"title":"Gets all of the refund receipt templates in the system.","description":"This method will scan all refund receipt templates and and return them to the caller."}},"httpPath":"/refundReceiptTemplates/{tenantId}"},{"label":"Creates a new refund receipt template record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refund-receipt-templates/createrefundreceipttemplate","routeSlug":"/apis/collect/collect-v1/refund-receipt-templates/createrefundreceipttemplate","metadata":{"seo":{"title":"Creates a new refund receipt template record that does not already exist.","description":"This method will auto-generate an ID and create a new refund receipt template. If an ID is specified for the refund receipt template, an error will be thrown."}},"httpPath":"/refundReceiptTemplates/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refund-receipt-templates/executebatchoperations","routeSlug":"/apis/collect/collect-v1/refund-receipt-templates/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/refundReceiptTemplates/{tenantId}/batch"},{"label":"Returns a refund receipt template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refund-receipt-templates/deleterefundreceipttemplate","routeSlug":"/apis/collect/collect-v1/refund-receipt-templates/deleterefundreceipttemplate","metadata":{"seo":{"title":"Returns a refund receipt template from the system by its ID.","description":"This method will delete a refund receipt template with the specified ID."}},"httpPath":"/refundReceiptTemplates/{tenantId}/{id}"},{"label":"Returns a refund receipt template from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refund-receipt-templates/getrefundreceipttemplate","routeSlug":"/apis/collect/collect-v1/refund-receipt-templates/getrefundreceipttemplate","metadata":{"seo":{"title":"Returns a refund receipt template from the system by its ID.","description":"This method will look up a refund receipt template by the specified ID and return it back."}},"httpPath":"/refundReceiptTemplates/{tenantId}/{id}"},{"label":"Partially updates a refund receipt template with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refund-receipt-templates/patchrefundreceipttemplate","routeSlug":"/apis/collect/collect-v1/refund-receipt-templates/patchrefundreceipttemplate","metadata":{"seo":{"title":"Partially updates a refund receipt template with the specified ID.","description":"This method will patch an existing refund receipt template with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/refundReceiptTemplates/{tenantId}/{id}"},{"label":"Updates a refund receipt template with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refund-receipt-templates/updaterefundreceipttemplate","routeSlug":"/apis/collect/collect-v1/refund-receipt-templates/updaterefundreceipttemplate","metadata":{"seo":{"title":"Updates a refund receipt template with the specified ID.","description":"This method will update an existing refund receipt template with the specified ID."}},"httpPath":"/refundReceiptTemplates/{tenantId}/{id}"}]},{"type":"group","label":"Refunds","link":"/apis/collect/collect-v1/refunds","routeSlug":"/apis/collect/collect-v1/refunds","items":[{"label":"Returns the default refund template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/getdefaultrefundtemplate","routeSlug":"/apis/collect/collect-v1/refunds/getdefaultrefundtemplate","metadata":{"seo":{"title":"Returns the default refund template","description":"Returns the default refund template"}},"httpPath":"/refunds/defaultTemplate/refund"},{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/warmupstepfunctions","routeSlug":"/apis/collect/collect-v1/refunds/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"httpPath":"/refunds/warmUpStepFunctions"},{"label":"Gets all of the refunds in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/listrefunds","routeSlug":"/apis/collect/collect-v1/refunds/listrefunds","metadata":{"seo":{"title":"Gets all of the refunds in the system.","description":"This method will scan all refunds and and return them to the caller."}},"httpPath":"/refunds/{tenantId}"},{"label":"Creates a new refund that doesn't already exist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/processrefund","routeSlug":"/apis/collect/collect-v1/refunds/processrefund","metadata":{"seo":{"title":"Creates a new refund that doesn't already exist","description":"This method will auto-generate an ID and create a new refund. If an ID is specified for the refund, an error will be thrown."}},"httpPath":"/refunds/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/executebatchoperations","routeSlug":"/apis/collect/collect-v1/refunds/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/refunds/{tenantId}/batch"},{"label":"Returns a list of records with the specified batch_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/listrefundsbybatchid","routeSlug":"/apis/collect/collect-v1/refunds/listrefundsbybatchid","metadata":{"seo":{"title":"Returns a list of records with the specified batch_id","description":"Returns a list of records with the specified batch_id"}},"httpPath":"/refunds/{tenantId}/batch/{batch_id}"},{"label":"Sends out a preview of the notification template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/previewtemplate","routeSlug":"/apis/collect/collect-v1/refunds/previewtemplate","metadata":{"seo":{"title":"Sends out a preview of the notification template","description":"Sends out a preview of the notification template"}},"httpPath":"/refunds/{tenantId}/previewTemplate"},{"label":"Generates a PDF and returns the public link for download","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/downloadpdf","routeSlug":"/apis/collect/collect-v1/refunds/downloadpdf","metadata":{"seo":{"title":"Generates a PDF and returns the public link for download","description":"Generates a PDF and returns the public link for download"}},"httpPath":"/refunds/{tenantId}/print/{id}"},{"label":"Searches for refunds using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/searchforrefunds","routeSlug":"/apis/collect/collect-v1/refunds/searchforrefunds","metadata":{"seo":{"title":"Searches for refunds using predefined parameters","description":"Searches for refunds using predefined parameters"}},"httpPath":"/refunds/{tenantId}/search"},{"label":"Creates a new refund that doesn't already exist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/processrefundsync","routeSlug":"/apis/collect/collect-v1/refunds/processrefundsync","metadata":{"seo":{"title":"Creates a new refund that doesn't already exist","description":"This method will auto-generate an ID and create a new refund. If an ID is specified for the refund, an error will be thrown."}},"httpPath":"/refunds/{tenantId}/sync"},{"label":"Returns a refund from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/getrefund","routeSlug":"/apis/collect/collect-v1/refunds/getrefund","metadata":{"seo":{"title":"Returns a refund from the system by its ID.","description":"This method will look up a refund by the specified ID and return it back."}},"httpPath":"/refunds/{tenantId}/{id}"},{"label":"Partially updates a refund with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/patchrefund","routeSlug":"/apis/collect/collect-v1/refunds/patchrefund","metadata":{"seo":{"title":"Partially updates a refund with the specified ID.","description":"This method will patch an existing refund with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/refunds/{tenantId}/{id}"},{"label":"Updates a refund with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/refunds/updaterefund","routeSlug":"/apis/collect/collect-v1/refunds/updaterefund","metadata":{"seo":{"title":"Updates a refund with the specified ID.","description":"This method will update an existing refund with the specified ID."}},"httpPath":"/refunds/{tenantId}/{id}"}]},{"type":"group","label":"Revenue Recognition Schedules","link":"/apis/collect/collect-v1/revenue-recognition-schedules","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules","items":[{"label":"Gets all of the revenue recognition schedules in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/listrevenuerecognitionschedules","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/listrevenuerecognitionschedules","metadata":{"seo":{"title":"Gets all of the revenue recognition schedules in the system.","description":"This method will scan all revenue recognition schedules and and return them to the caller."}},"httpPath":"/revenueRecognitionSchedules/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/executebatchoperations","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/revenueRecognitionSchedules/{tenantId}/batch"},{"label":"Returns a list of records with the specified batch_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbybatchid","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbybatchid","metadata":{"seo":{"title":"Returns a list of records with the specified batch_id","description":"Returns a list of records with the specified batch_id"}},"httpPath":"/revenueRecognitionSchedules/{tenantId}/batch/{batch_id}"},{"label":"Returns a list of OPEN records with the specified business_unit_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/listopenschedulesbybusinessunitid","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/listopenschedulesbybusinessunitid","metadata":{"seo":{"title":"Returns a list of OPEN records with the specified business_unit_id","description":"Returns a list of OPEN records with the specified business_unit_id"}},"httpPath":"/revenueRecognitionSchedules/{tenantId}/businessUnit/{business_unit_id}/open"},{"label":"Returns a list of records with the specified credit_memo_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbycreditmemoid","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbycreditmemoid","metadata":{"seo":{"title":"Returns a list of records with the specified credit_memo_id","description":"Returns a list of records with the specified credit_memo_id"}},"httpPath":"/revenueRecognitionSchedules/{tenantId}/creditMemo/{credit_memo_id}"},{"label":"Returns a list of records with the specified debit_memo_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbydebitmemoid","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbydebitmemoid","metadata":{"seo":{"title":"Returns a list of records with the specified debit_memo_id","description":"Returns a list of records with the specified debit_memo_id"}},"httpPath":"/revenueRecognitionSchedules/{tenantId}/debitMemo/{debit_memo_id}"},{"label":"Returns a list of records with the specified invoice_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbyinvoiceid","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbyinvoiceid","metadata":{"seo":{"title":"Returns a list of records with the specified invoice_id","description":"Returns a list of records with the specified invoice_id"}},"httpPath":"/revenueRecognitionSchedules/{tenantId}/invoice/{invoice_id}"},{"label":"Returns a list of records with the specified membership_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbymembershipid","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbymembershipid","metadata":{"seo":{"title":"Returns a list of records with the specified membership_id","description":"Returns a list of records with the specified membership_id"}},"httpPath":"/revenueRecognitionSchedules/{tenantId}/membership/{membership_id}"},{"label":"Returns a list of records with the specified payment_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbypaymentid","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbypaymentid","metadata":{"seo":{"title":"Returns a list of records with the specified payment_id","description":"Returns a list of records with the specified payment_id"}},"httpPath":"/revenueRecognitionSchedules/{tenantId}/payment/{payment_id}"},{"label":"Returns a list of records with the specified write_off_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbywriteoffid","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/listschedulesbywriteoffid","metadata":{"seo":{"title":"Returns a list of records with the specified write_off_id","description":"Returns a list of records with the specified write_off_id"}},"httpPath":"/revenueRecognitionSchedules/{tenantId}/writeOff/{write_off_id}"},{"label":"Returns a revenue recognition schedule from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/getrevenuerecognitionschedule","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/getrevenuerecognitionschedule","metadata":{"seo":{"title":"Returns a revenue recognition schedule from the system by its ID.","description":"This method will look up a revenue recognition schedule by the specified ID and return it back."}},"httpPath":"/revenueRecognitionSchedules/{tenantId}/{id}"},{"label":"Partially updates a revenue recognition schedule with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/patchrevenuerecognitionschedule","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/patchrevenuerecognitionschedule","metadata":{"seo":{"title":"Partially updates a revenue recognition schedule with the specified ID.","description":"This method will patch an existing revenue recognition schedule with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/revenueRecognitionSchedules/{tenantId}/{id}"},{"label":"Updates a revenue recognition schedule with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/revenue-recognition-schedules/updaterevenuerecognitionschedule","routeSlug":"/apis/collect/collect-v1/revenue-recognition-schedules/updaterevenuerecognitionschedule","metadata":{"seo":{"title":"Updates a revenue recognition schedule with the specified ID.","description":"This method will update an existing revenue recognition schedule with the specified ID."}},"httpPath":"/revenueRecognitionSchedules/{tenantId}/{id}"}]},{"type":"group","label":"Settings","link":"/apis/collect/collect-v1/settings","routeSlug":"/apis/collect/collect-v1/settings","items":[{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/settings/deletesetting","routeSlug":"/apis/collect/collect-v1/settings/deletesetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will delete a setting with the specified ID."}},"httpPath":"/settings/{tenantId}"},{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/settings/getsetting","routeSlug":"/apis/collect/collect-v1/settings/getsetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will look up a setting by the specified ID and return it back."}},"httpPath":"/settings/{tenantId}"},{"label":"Partially updates a setting with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/settings/patchsetting","routeSlug":"/apis/collect/collect-v1/settings/patchsetting","metadata":{"seo":{"title":"Partially updates a setting with the specified ID.","description":"This method will patch an existing setting with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/settings/{tenantId}"},{"label":"Creates a new setting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/settings/createsetting","routeSlug":"/apis/collect/collect-v1/settings/createsetting","metadata":{"seo":{"title":"Creates a new setting record that does not already exist.","description":"This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, an error will be thrown."}},"httpPath":"/settings/{tenantId}"},{"label":"Updates a setting with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/settings/updatesetting","routeSlug":"/apis/collect/collect-v1/settings/updatesetting","metadata":{"seo":{"title":"Updates a setting with the specified ID.","description":"This method will update an existing setting with the specified ID."}},"httpPath":"/settings/{tenantId}"},{"label":"Get public settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/settings/getpublicsettings","routeSlug":"/apis/collect/collect-v1/settings/getpublicsettings","metadata":{"seo":{"title":"Get public settings","description":"For a given contact, finds the Stripe customer. If none exists, one is created."}},"httpPath":"/settings/{tenantId}/public/settings"}]},{"type":"group","label":"Statement Templates","link":"/apis/collect/collect-v1/statement-templates","routeSlug":"/apis/collect/collect-v1/statement-templates","items":[{"label":"Gets all of the statement templates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statement-templates/liststatementtemplates","routeSlug":"/apis/collect/collect-v1/statement-templates/liststatementtemplates","metadata":{"seo":{"title":"Gets all of the statement templates in the system.","description":"This method will scan all statement templates and and return them to the caller."}},"httpPath":"/statementTemplates/{tenantId}"},{"label":"Creates a new statement template record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statement-templates/createstatementtemplate","routeSlug":"/apis/collect/collect-v1/statement-templates/createstatementtemplate","metadata":{"seo":{"title":"Creates a new statement template record that does not already exist.","description":"This method will auto-generate an ID and create a new statement template. If an ID is specified for the statement template, an error will be thrown."}},"httpPath":"/statementTemplates/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statement-templates/executebatchoperations","routeSlug":"/apis/collect/collect-v1/statement-templates/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/statementTemplates/{tenantId}/batch"},{"label":"Returns a statement template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statement-templates/deletestatementtemplate","routeSlug":"/apis/collect/collect-v1/statement-templates/deletestatementtemplate","metadata":{"seo":{"title":"Returns a statement template from the system by its ID.","description":"This method will delete a statement template with the specified ID."}},"httpPath":"/statementTemplates/{tenantId}/{id}"},{"label":"Returns a statement template from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statement-templates/getstatementtemplate","routeSlug":"/apis/collect/collect-v1/statement-templates/getstatementtemplate","metadata":{"seo":{"title":"Returns a statement template from the system by its ID.","description":"This method will look up a statement template by the specified ID and return it back."}},"httpPath":"/statementTemplates/{tenantId}/{id}"},{"label":"Partially updates a statement template with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statement-templates/patchstatementtemplate","routeSlug":"/apis/collect/collect-v1/statement-templates/patchstatementtemplate","metadata":{"seo":{"title":"Partially updates a statement template with the specified ID.","description":"This method will patch an existing statement template with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/statementTemplates/{tenantId}/{id}"},{"label":"Updates a statement template with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statement-templates/updatestatementtemplate","routeSlug":"/apis/collect/collect-v1/statement-templates/updatestatementtemplate","metadata":{"seo":{"title":"Updates a statement template with the specified ID.","description":"This method will update an existing statement template with the specified ID."}},"httpPath":"/statementTemplates/{tenantId}/{id}"}]},{"type":"group","label":"Statements","link":"/apis/collect/collect-v1/statements","routeSlug":"/apis/collect/collect-v1/statements","items":[{"label":"Creates a new statement record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/createstatement","routeSlug":"/apis/collect/collect-v1/statements/createstatement","metadata":{"seo":{"title":"Creates a new statement record that does not already exist.","description":"This method will auto-generate an ID and create a new statement. If an ID is specified for the statement, an error will be thrown."}},"httpPath":"/statements/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/executebatchoperations","routeSlug":"/apis/collect/collect-v1/statements/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/statements/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/liststatementsbycontactid","routeSlug":"/apis/collect/collect-v1/statements/liststatementsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/statements/{tenantId}/contact/{contact_id}"},{"label":"Returns the default customer balance statement template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/getdefaultcustomerbalancestatementtemplate","routeSlug":"/apis/collect/collect-v1/statements/getdefaultcustomerbalancestatementtemplate","metadata":{"seo":{"title":"Returns the default customer balance statement template","description":"Returns the default customer balance statement template"}},"httpPath":"/statements/{tenantId}/defaultStatementTemplate"},{"label":"Generate/Send Customer Statement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/generatecustomerbalancestatement","routeSlug":"/apis/collect/collect-v1/statements/generatecustomerbalancestatement","metadata":{"seo":{"title":"Generate/Send Customer Statement","description":"Generates and optionally sends a customer statement"}},"httpPath":"/statements/{tenantId}/generate"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/liststatementsbyorganizationid","routeSlug":"/apis/collect/collect-v1/statements/liststatementsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/statements/{tenantId}/organization/{organization_id}"},{"label":"Sends out a preview of the notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/previewemail","routeSlug":"/apis/collect/collect-v1/statements/previewemail","metadata":{"seo":{"title":"Sends out a preview of the notification email","description":"Sends out a preview of the notification email"}},"httpPath":"/statements/{tenantId}/previewEmail"},{"label":"Sends out a preview of the notification template","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/previewtemplate","routeSlug":"/apis/collect/collect-v1/statements/previewtemplate","metadata":{"seo":{"title":"Sends out a preview of the notification template","description":"Sends out a preview of the notification template"}},"httpPath":"/statements/{tenantId}/previewTemplate"},{"label":"Returns a statement from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/deletestatement","routeSlug":"/apis/collect/collect-v1/statements/deletestatement","metadata":{"seo":{"title":"Returns a statement from the system by its ID.","description":"This method will delete a statement with the specified ID."}},"httpPath":"/statements/{tenantId}/{id}"},{"label":"Returns a statement from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/getstatement","routeSlug":"/apis/collect/collect-v1/statements/getstatement","metadata":{"seo":{"title":"Returns a statement from the system by its ID.","description":"This method will look up a statement by the specified ID and return it back."}},"httpPath":"/statements/{tenantId}/{id}"},{"label":"Partially updates a statement with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/patchstatement","routeSlug":"/apis/collect/collect-v1/statements/patchstatement","metadata":{"seo":{"title":"Partially updates a statement with the specified ID.","description":"This method will patch an existing statement with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/statements/{tenantId}/{id}"},{"label":"Updates a statement with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statements/updatestatement","routeSlug":"/apis/collect/collect-v1/statements/updatestatement","metadata":{"seo":{"title":"Updates a statement with the specified ID.","description":"This method will update an existing statement with the specified ID."}},"httpPath":"/statements/{tenantId}/{id}"}]},{"type":"group","label":"Statistics","link":"/apis/collect/collect-v1/statistics","routeSlug":"/apis/collect/collect-v1/statistics","items":[{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statistics/executebatchoperations","routeSlug":"/apis/collect/collect-v1/statistics/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/statistics/{tenantId}/batch"},{"label":"Returns a statistic from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/statistics/getstatistic","routeSlug":"/apis/collect/collect-v1/statistics/getstatistic","metadata":{"seo":{"title":"Returns a statistic from the system by its ID.","description":"This method will look up a statistic by the specified ID and return it back."}},"httpPath":"/statistics/{tenantId}/{id}"}]},{"type":"group","label":"Stored Payment Methods","link":"/apis/collect/collect-v1/stored-payment-methods","routeSlug":"/apis/collect/collect-v1/stored-payment-methods","items":[{"label":"Creates a new stored payment method record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/createstoredpaymentmethod","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/createstoredpaymentmethod","metadata":{"seo":{"title":"Creates a new stored payment method record that does not already exist.","description":"This method will auto-generate an ID and create a new stored payment method. If an ID is specified for the stored payment method, an error will be thrown."}},"httpPath":"/storedPaymentMethods/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/executebatchoperations","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/storedPaymentMethods/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/listmethodsbycontactid","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/listmethodsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/storedPaymentMethods/{tenantId}/contact/{contact_id}"},{"label":"Gets all of the stored payment methods in the system for a given contact.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/liststoredpaymentmethodsforportal","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/liststoredpaymentmethodsforportal","metadata":{"seo":{"title":"Gets all of the stored payment methods in the system for a given contact.","description":"This method will scan all stored payment methods and and return them to the caller for a given contact."}},"httpPath":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}"},{"label":"Creates a new stored payment method record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/createstoredpaymentmethodforportal","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/createstoredpaymentmethodforportal","metadata":{"seo":{"title":"Creates a new stored payment method record that does not already exist.","description":"This method will auto-generate an ID and create a new stored payment method. If an ID is specified for the stored payment method, an error will be thrown."}},"httpPath":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}"},{"label":"Returns a stored payment method from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/deletestoredpaymentmethodforportal","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/deletestoredpaymentmethodforportal","metadata":{"seo":{"title":"Returns a stored payment method from the system by its ID.","description":"This method will delete a stored payment method with the specified ID."}},"httpPath":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}/{id}"},{"label":"Returns a stored payment method from the system by its ID for a given contact.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/getstoredpaymentmethodforportal","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/getstoredpaymentmethodforportal","metadata":{"seo":{"title":"Returns a stored payment method from the system by its ID for a given contact.","description":"This method will look up a stored payment method by the specified ID and return it back (for a portal contact)"}},"httpPath":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}/{id}"},{"label":"Updates a stored payment method with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/updatestoredpaymentmethodforportal","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/updatestoredpaymentmethodforportal","metadata":{"seo":{"title":"Updates a stored payment method with the specified ID.","description":"This method will update an existing stored payment method with the specified ID."}},"httpPath":"/storedPaymentMethods/{tenantId}/portal/contact/{portalContactId}/{id}"},{"label":"Returns a stored payment method from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/deletestoredpaymentmethod","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/deletestoredpaymentmethod","metadata":{"seo":{"title":"Returns a stored payment method from the system by its ID.","description":"This method will delete a stored payment method with the specified ID."}},"httpPath":"/storedPaymentMethods/{tenantId}/{id}"},{"label":"Returns a stored payment method from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/getstoredpaymentmethod","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/getstoredpaymentmethod","metadata":{"seo":{"title":"Returns a stored payment method from the system by its ID.","description":"This method will look up a stored payment method by the specified ID and return it back."}},"httpPath":"/storedPaymentMethods/{tenantId}/{id}"},{"label":"Partially updates a stored payment method with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/patchstoredpaymentmethod","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/patchstoredpaymentmethod","metadata":{"seo":{"title":"Partially updates a stored payment method with the specified ID.","description":"This method will patch an existing stored payment method with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/storedPaymentMethods/{tenantId}/{id}"},{"label":"Updates a stored payment method with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/stored-payment-methods/updatestoredpaymentmethod","routeSlug":"/apis/collect/collect-v1/stored-payment-methods/updatestoredpaymentmethod","metadata":{"seo":{"title":"Updates a stored payment method with the specified ID.","description":"This method will update an existing stored payment method with the specified ID."}},"httpPath":"/storedPaymentMethods/{tenantId}/{id}"}]},{"type":"group","label":"Subledger Entries","link":"/apis/collect/collect-v1/subledger-entries","routeSlug":"/apis/collect/collect-v1/subledger-entries","items":[{"label":"Creates a new subledger entry record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/createsubledgerentry","routeSlug":"/apis/collect/collect-v1/subledger-entries/createsubledgerentry","metadata":{"seo":{"title":"Creates a new subledger entry record that does not already exist.","description":"This method will auto-generate an ID and create a new subledger entry. If an ID is specified for the subledger entry, an error will be thrown."}},"httpPath":"/subledgerEntries/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/executebatchoperations","routeSlug":"/apis/collect/collect-v1/subledger-entries/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/subledgerEntries/{tenantId}/batch"},{"label":"Returns a list of records with the specified batch_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/listentriesbybatchid","routeSlug":"/apis/collect/collect-v1/subledger-entries/listentriesbybatchid","metadata":{"seo":{"title":"Returns a list of records with the specified batch_id","description":"Returns a list of records with the specified batch_id"}},"httpPath":"/subledgerEntries/{tenantId}/batch/{batch_id}"},{"label":"Returns a list of records with the specified cogs_entry_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/listentriesbycogsentryid","routeSlug":"/apis/collect/collect-v1/subledger-entries/listentriesbycogsentryid","metadata":{"seo":{"title":"Returns a list of records with the specified cogs_entry_id","description":"Returns a list of records with the specified cogs_entry_id"}},"httpPath":"/subledgerEntries/{tenantId}/cogsEntry/{cogs_entry_id}"},{"label":"Returns a list of records with the specified credit_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/listentriesbycreditid","routeSlug":"/apis/collect/collect-v1/subledger-entries/listentriesbycreditid","metadata":{"seo":{"title":"Returns a list of records with the specified credit_id","description":"Returns a list of records with the specified credit_id"}},"httpPath":"/subledgerEntries/{tenantId}/credit/{credit_id}"},{"label":"Returns a list of records with the specified credit_memo_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/listentriesbycreditmemoid","routeSlug":"/apis/collect/collect-v1/subledger-entries/listentriesbycreditmemoid","metadata":{"seo":{"title":"Returns a list of records with the specified credit_memo_id","description":"Returns a list of records with the specified credit_memo_id"}},"httpPath":"/subledgerEntries/{tenantId}/creditMemo/{credit_memo_id}"},{"label":"Returns a list of records with the specified debit_memo_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/listentriesbydebitmemoid","routeSlug":"/apis/collect/collect-v1/subledger-entries/listentriesbydebitmemoid","metadata":{"seo":{"title":"Returns a list of records with the specified debit_memo_id","description":"Returns a list of records with the specified debit_memo_id"}},"httpPath":"/subledgerEntries/{tenantId}/debitMemo/{debit_memo_id}"},{"label":"Returns a list of records with the specified fiscal_period","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/listentriesbyfiscalperiod","routeSlug":"/apis/collect/collect-v1/subledger-entries/listentriesbyfiscalperiod","metadata":{"seo":{"title":"Returns a list of records with the specified fiscal_period","description":"Returns a list of records with the specified fiscal_period"}},"httpPath":"/subledgerEntries/{tenantId}/fiscalPeriod/{business_unit_id}/{fiscal_year_id}/{fiscal_period}"},{"label":"Returns a list of records with the specified inventory_receipt_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/listentriesbyinventoryreceiptid","routeSlug":"/apis/collect/collect-v1/subledger-entries/listentriesbyinventoryreceiptid","metadata":{"seo":{"title":"Returns a list of records with the specified inventory_receipt_id","description":"Returns a list of records with the specified inventory_receipt_id"}},"httpPath":"/subledgerEntries/{tenantId}/inventoryReceipt/{inventory_receipt_id}"},{"label":"Returns a list of records with the specified invoice_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/listentriesbyinvoiceid","routeSlug":"/apis/collect/collect-v1/subledger-entries/listentriesbyinvoiceid","metadata":{"seo":{"title":"Returns a list of records with the specified invoice_id","description":"Returns a list of records with the specified invoice_id"}},"httpPath":"/subledgerEntries/{tenantId}/invoice/{invoice_id}"},{"label":"Returns a list of records with the specified payment_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/listentriesbypaymentid","routeSlug":"/apis/collect/collect-v1/subledger-entries/listentriesbypaymentid","metadata":{"seo":{"title":"Returns a list of records with the specified payment_id","description":"Returns a list of records with the specified payment_id"}},"httpPath":"/subledgerEntries/{tenantId}/payment/{payment_id}"},{"label":"Returns a list of records with the specified revenue_recognition_schedule_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/listentriesbyrevenuerecognitionscheduleid","routeSlug":"/apis/collect/collect-v1/subledger-entries/listentriesbyrevenuerecognitionscheduleid","metadata":{"seo":{"title":"Returns a list of records with the specified revenue_recognition_schedule_id","description":"Returns a list of records with the specified revenue_recognition_schedule_id"}},"httpPath":"/subledgerEntries/{tenantId}/revenueRecognitionSchedule/{revenue_recognition_schedule_id}"},{"label":"Returns a list of records with the specified write_off_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/listentriesbywriteoffid","routeSlug":"/apis/collect/collect-v1/subledger-entries/listentriesbywriteoffid","metadata":{"seo":{"title":"Returns a list of records with the specified write_off_id","description":"Returns a list of records with the specified write_off_id"}},"httpPath":"/subledgerEntries/{tenantId}/writeOff/{write_off_id}"},{"label":"Returns a subledger entry from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/deletesubledgerentry","routeSlug":"/apis/collect/collect-v1/subledger-entries/deletesubledgerentry","metadata":{"seo":{"title":"Returns a subledger entry from the system by its ID.","description":"This method will delete a subledger entry with the specified ID."}},"httpPath":"/subledgerEntries/{tenantId}/{id}"},{"label":"Returns a subledger entry from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/getsubledgerentry","routeSlug":"/apis/collect/collect-v1/subledger-entries/getsubledgerentry","metadata":{"seo":{"title":"Returns a subledger entry from the system by its ID.","description":"This method will look up a subledger entry by the specified ID and return it back."}},"httpPath":"/subledgerEntries/{tenantId}/{id}"},{"label":"Partially updates a subledger entry with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/patchsubledgerentry","routeSlug":"/apis/collect/collect-v1/subledger-entries/patchsubledgerentry","metadata":{"seo":{"title":"Partially updates a subledger entry with the specified ID.","description":"This method will patch an existing subledger entry with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/subledgerEntries/{tenantId}/{id}"},{"label":"Updates a subledger entry with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/subledger-entries/updatesubledgerentry","routeSlug":"/apis/collect/collect-v1/subledger-entries/updatesubledgerentry","metadata":{"seo":{"title":"Updates a subledger entry with the specified ID.","description":"This method will update an existing subledger entry with the specified ID."}},"httpPath":"/subledgerEntries/{tenantId}/{id}"}]},{"type":"group","label":"Write Offs","link":"/apis/collect/collect-v1/write-offs","routeSlug":"/apis/collect/collect-v1/write-offs","items":[{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/write-offs/warmupstepfunctions","routeSlug":"/apis/collect/collect-v1/write-offs/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"httpPath":"/writeOffs/warmUpStepFunctions"},{"label":"Gets all of the write offs in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/write-offs/listwriteoffs","routeSlug":"/apis/collect/collect-v1/write-offs/listwriteoffs","metadata":{"seo":{"title":"Gets all of the write offs in the system.","description":"This method will scan all write offs and and return them to the caller."}},"httpPath":"/writeOffs/{tenantId}"},{"label":"Processes a new write off","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/write-offs/processwriteoff","routeSlug":"/apis/collect/collect-v1/write-offs/processwriteoff","metadata":{"seo":{"title":"Processes a new write off","description":"This method will auto-generate an ID and create a new write off. If an ID is specified for the write off, an error will be thrown."}},"httpPath":"/writeOffs/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/write-offs/executebatchoperations","routeSlug":"/apis/collect/collect-v1/write-offs/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/writeOffs/{tenantId}/batch"},{"label":"Returns a list of records with the specified batch_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/write-offs/listoffsbybatchid","routeSlug":"/apis/collect/collect-v1/write-offs/listoffsbybatchid","metadata":{"seo":{"title":"Returns a list of records with the specified batch_id","description":"Returns a list of records with the specified batch_id"}},"httpPath":"/writeOffs/{tenantId}/batch/{batch_id}"},{"label":"Searches for write offs using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/write-offs/searchforwriteoffs","routeSlug":"/apis/collect/collect-v1/write-offs/searchforwriteoffs","metadata":{"seo":{"title":"Searches for write offs using predefined parameters","description":"Searches for write offs using predefined parameters"}},"httpPath":"/writeOffs/{tenantId}/search"},{"label":"Creates a new credit that doesn't already exist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/write-offs/processwriteoffsync","routeSlug":"/apis/collect/collect-v1/write-offs/processwriteoffsync","metadata":{"seo":{"title":"Creates a new credit that doesn't already exist","description":"This method will auto-generate an ID and create a new write off. If an ID is specified for the write off, an error will be thrown."}},"httpPath":"/writeOffs/{tenantId}/sync"},{"label":"Returns a write off from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/write-offs/getwriteoff","routeSlug":"/apis/collect/collect-v1/write-offs/getwriteoff","metadata":{"seo":{"title":"Returns a write off from the system by its ID.","description":"This method will look up a write off by the specified ID and return it back."}},"httpPath":"/writeOffs/{tenantId}/{id}"},{"label":"Partially updates a write off with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/write-offs/patchwriteoff","routeSlug":"/apis/collect/collect-v1/write-offs/patchwriteoff","metadata":{"seo":{"title":"Partially updates a write off with the specified ID.","description":"This method will patch an existing write off with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/writeOffs/{tenantId}/{id}"},{"label":"Updates a write off with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/collect/collect-v1/write-offs/updatewriteoff","routeSlug":"/apis/collect/collect-v1/write-offs/updatewriteoff","metadata":{"seo":{"title":"Updates a write off with the specified ID.","description":"This method will update an existing write off with the specified ID."}},"httpPath":"/writeOffs/{tenantId}/{id}"}]}]},{"type":"group","label":"Commerce","items":[{"type":"link","label":"Commerce (Orders & Inventory)","link":"/apis/commerce/commerce-v1","routeSlug":"/apis/commerce/commerce-v1"},{"type":"group","label":"Cancellation Fees","link":"/apis/commerce/commerce-v1/cancellation-fees","routeSlug":"/apis/commerce/commerce-v1/cancellation-fees","items":[{"label":"Gets all of the cancellation fees in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellation-fees/listcancellationfees","routeSlug":"/apis/commerce/commerce-v1/cancellation-fees/listcancellationfees","metadata":{"seo":{"title":"Gets all of the cancellation fees in the system.","description":"This method will scan all cancellation fees and and return them to the caller."}},"httpPath":"/cancellationFees/{tenantId}"},{"label":"Creates a new cancellation fee record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellation-fees/createcancellationfee","routeSlug":"/apis/commerce/commerce-v1/cancellation-fees/createcancellationfee","metadata":{"seo":{"title":"Creates a new cancellation fee record that does not already exist.","description":"This method will auto-generate an ID and create a new cancellation fee. If an ID is specified for the cancellation fee, an error will be thrown."}},"httpPath":"/cancellationFees/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellation-fees/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/cancellation-fees/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/cancellationFees/{tenantId}/batch"},{"label":"Returns a cancellation fee from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellation-fees/deletecancellationfee","routeSlug":"/apis/commerce/commerce-v1/cancellation-fees/deletecancellationfee","metadata":{"seo":{"title":"Returns a cancellation fee from the system by its ID.","description":"This method will delete a cancellation fee with the specified ID."}},"httpPath":"/cancellationFees/{tenantId}/{id}"},{"label":"Returns a cancellation fee from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellation-fees/getcancellationfee","routeSlug":"/apis/commerce/commerce-v1/cancellation-fees/getcancellationfee","metadata":{"seo":{"title":"Returns a cancellation fee from the system by its ID.","description":"This method will look up a cancellation fee by the specified ID and return it back."}},"httpPath":"/cancellationFees/{tenantId}/{id}"},{"label":"Partially updates a cancellation fee with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellation-fees/patchcancellationfee","routeSlug":"/apis/commerce/commerce-v1/cancellation-fees/patchcancellationfee","metadata":{"seo":{"title":"Partially updates a cancellation fee with the specified ID.","description":"This method will patch an existing cancellation fee with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/cancellationFees/{tenantId}/{id}"},{"label":"Updates a cancellation fee with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellation-fees/updatecancellationfee","routeSlug":"/apis/commerce/commerce-v1/cancellation-fees/updatecancellationfee","metadata":{"seo":{"title":"Updates a cancellation fee with the specified ID.","description":"This method will update an existing cancellation fee with the specified ID."}},"httpPath":"/cancellationFees/{tenantId}/{id}"}]},{"type":"group","label":"Cancellations","link":"/apis/commerce/commerce-v1/cancellations","routeSlug":"/apis/commerce/commerce-v1/cancellations","items":[{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellations/warmupstepfunctions","routeSlug":"/apis/commerce/commerce-v1/cancellations/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"httpPath":"/cancellations/warmUpStepFunctions"},{"label":"Processes a cancellation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellations/processcancellation","routeSlug":"/apis/commerce/commerce-v1/cancellations/processcancellation","metadata":{"seo":{"title":"Processes a cancellation","description":"This method will auto-generate an ID and create a new cancellation. If an ID is specified for the cancellation, an error will be thrown."}},"httpPath":"/cancellations/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellations/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/cancellations/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/cancellations/{tenantId}/batch"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellations/listcancellationsbyorderid","routeSlug":"/apis/commerce/commerce-v1/cancellations/listcancellationsbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"httpPath":"/cancellations/{tenantId}/order/{order_id}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellations/previewemail","routeSlug":"/apis/commerce/commerce-v1/cancellations/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/cancellations/{tenantId}/previewEmail"},{"label":"Processes a cancellation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellations/processcancellationsync","routeSlug":"/apis/commerce/commerce-v1/cancellations/processcancellationsync","metadata":{"seo":{"title":"Processes a cancellation","description":"This method will auto-generate an ID and create a new cancellation. If an ID is specified for the cancellation, an error will be thrown."}},"httpPath":"/cancellations/{tenantId}/sync"},{"label":"Returns a cancellation from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellations/deletecancellation","routeSlug":"/apis/commerce/commerce-v1/cancellations/deletecancellation","metadata":{"seo":{"title":"Returns a cancellation from the system by its ID.","description":"This method will delete a cancellation with the specified ID."}},"httpPath":"/cancellations/{tenantId}/{id}"},{"label":"Returns a cancellation from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellations/getcancellation","routeSlug":"/apis/commerce/commerce-v1/cancellations/getcancellation","metadata":{"seo":{"title":"Returns a cancellation from the system by its ID.","description":"This method will look up a cancellation by the specified ID and return it back."}},"httpPath":"/cancellations/{tenantId}/{id}"},{"label":"Partially updates a cancellation with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellations/patchcancellation","routeSlug":"/apis/commerce/commerce-v1/cancellations/patchcancellation","metadata":{"seo":{"title":"Partially updates a cancellation with the specified ID.","description":"This method will patch an existing cancellation with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/cancellations/{tenantId}/{id}"},{"label":"Updates a cancellation with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/cancellations/updatecancellation","routeSlug":"/apis/commerce/commerce-v1/cancellations/updatecancellation","metadata":{"seo":{"title":"Updates a cancellation with the specified ID.","description":"This method will update an existing cancellation with the specified ID."}},"httpPath":"/cancellations/{tenantId}/{id}"}]},{"type":"group","label":"Carts","link":"/apis/commerce/commerce-v1/carts","routeSlug":"/apis/commerce/commerce-v1/carts","items":[{"label":"Creates a new cart record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/carts/createcart","routeSlug":"/apis/commerce/commerce-v1/carts/createcart","metadata":{"seo":{"title":"Creates a new cart record that does not already exist.","description":"This method will auto-generate an ID and create a new cart. If an ID is specified for the cart, an error will be thrown."}},"httpPath":"/carts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/carts/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/carts/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/carts/{tenantId}/batch"},{"label":"Returns a cart from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/carts/deletecart","routeSlug":"/apis/commerce/commerce-v1/carts/deletecart","metadata":{"seo":{"title":"Returns a cart from the system by its ID.","description":"This method will delete a cart with the specified ID."}},"httpPath":"/carts/{tenantId}/{id}"},{"label":"Returns a cart from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/carts/getcart","routeSlug":"/apis/commerce/commerce-v1/carts/getcart","metadata":{"seo":{"title":"Returns a cart from the system by its ID.","description":"This method will look up a cart by the specified ID and return it back."}},"httpPath":"/carts/{tenantId}/{id}"},{"label":"Partially updates a cart with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/carts/patchcart","routeSlug":"/apis/commerce/commerce-v1/carts/patchcart","metadata":{"seo":{"title":"Partially updates a cart with the specified ID.","description":"This method will patch an existing cart with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/carts/{tenantId}/{id}"},{"label":"Updates a cart with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/carts/updatecart","routeSlug":"/apis/commerce/commerce-v1/carts/updatecart","metadata":{"seo":{"title":"Updates a cart with the specified ID.","description":"This method will update an existing cart with the specified ID."}},"httpPath":"/carts/{tenantId}/{id}"}]},{"type":"group","label":"Coupon Code Gen Processes","link":"/apis/commerce/commerce-v1/coupon-code-gen-processes","routeSlug":"/apis/commerce/commerce-v1/coupon-code-gen-processes","items":[{"label":"Gets all of the coupon code gen processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-code-gen-processes/listcouponcodegenprocesses","routeSlug":"/apis/commerce/commerce-v1/coupon-code-gen-processes/listcouponcodegenprocesses","metadata":{"seo":{"title":"Gets all of the coupon code gen processes in the system.","description":"This method will scan all coupon code gen processes and and return them to the caller."}},"httpPath":"/couponCodeGenProcesses/{tenantId}"},{"label":"Creates a new coupon code gen process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-code-gen-processes/createcouponcodegenprocess","routeSlug":"/apis/commerce/commerce-v1/coupon-code-gen-processes/createcouponcodegenprocess","metadata":{"seo":{"title":"Creates a new coupon code gen process record that does not already exist.","description":"This method will auto-generate an ID and create a new coupon code gen process. If an ID is specified for the coupon code gen process, an error will be thrown."}},"httpPath":"/couponCodeGenProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-code-gen-processes/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/coupon-code-gen-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/couponCodeGenProcesses/{tenantId}/batch"},{"label":"Returns a coupon code gen process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-code-gen-processes/deletecouponcodegenprocess","routeSlug":"/apis/commerce/commerce-v1/coupon-code-gen-processes/deletecouponcodegenprocess","metadata":{"seo":{"title":"Returns a coupon code gen process from the system by its ID.","description":"This method will delete a coupon code gen process with the specified ID."}},"httpPath":"/couponCodeGenProcesses/{tenantId}/{id}"},{"label":"Returns a coupon code gen process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-code-gen-processes/getcouponcodegenprocess","routeSlug":"/apis/commerce/commerce-v1/coupon-code-gen-processes/getcouponcodegenprocess","metadata":{"seo":{"title":"Returns a coupon code gen process from the system by its ID.","description":"This method will look up a coupon code gen process by the specified ID and return it back."}},"httpPath":"/couponCodeGenProcesses/{tenantId}/{id}"},{"label":"Partially updates a coupon code gen process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-code-gen-processes/patchcouponcodegenprocess","routeSlug":"/apis/commerce/commerce-v1/coupon-code-gen-processes/patchcouponcodegenprocess","metadata":{"seo":{"title":"Partially updates a coupon code gen process with the specified ID.","description":"This method will patch an existing coupon code gen process with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/couponCodeGenProcesses/{tenantId}/{id}"},{"label":"Updates a coupon code gen process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-code-gen-processes/updatecouponcodegenprocess","routeSlug":"/apis/commerce/commerce-v1/coupon-code-gen-processes/updatecouponcodegenprocess","metadata":{"seo":{"title":"Updates a coupon code gen process with the specified ID.","description":"This method will update an existing coupon code gen process with the specified ID."}},"httpPath":"/couponCodeGenProcesses/{tenantId}/{id}"}]},{"type":"group","label":"Coupon Codes","link":"/apis/commerce/commerce-v1/coupon-codes","routeSlug":"/apis/commerce/commerce-v1/coupon-codes","items":[{"label":"Returns a list of records with the specified tenant_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/listcodesbytenantid","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/listcodesbytenantid","metadata":{"seo":{"title":"Returns a list of records with the specified tenant_id","description":"Returns a list of records with the specified tenant_id"}},"httpPath":"/couponCodes/{tenantId}"},{"label":"Creates a new coupon code record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/createcouponcode","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/createcouponcode","metadata":{"seo":{"title":"Creates a new coupon code record that does not already exist.","description":"This method will auto-generate an ID and create a new coupon code. If an ID is specified for the coupon code, an error will be thrown."}},"httpPath":"/couponCodes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/couponCodes/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/listcodesbycontactid","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/listcodesbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/couponCodes/{tenantId}/contact/{contact_id}"},{"label":"Returns a list of records with the specified coupon_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/listcodesbycouponid","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/listcodesbycouponid","metadata":{"seo":{"title":"Returns a list of records with the specified coupon_id","description":"Returns a list of records with the specified coupon_id"}},"httpPath":"/couponCodes/{tenantId}/coupon/{coupon_type}/{coupon_id}"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/listcodesbyorderid","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/listcodesbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"httpPath":"/couponCodes/{tenantId}/order/{order_id}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/listcodesbyorganizationid","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/listcodesbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/couponCodes/{tenantId}/organization/{organization_id}"},{"label":"Sends out a preview of the email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/previewemail","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/previewemail","metadata":{"seo":{"title":"Sends out a preview of the email","description":"Sends out a preview of the email"}},"httpPath":"/couponCodes/{tenantId}/previewEmail"},{"label":"Returns a coupon code from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/deletecouponcode","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/deletecouponcode","metadata":{"seo":{"title":"Returns a coupon code from the system by its ID.","description":"This method will delete a coupon code with the specified ID."}},"httpPath":"/couponCodes/{tenantId}/{id}"},{"label":"Returns a coupon code from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/getcouponcode","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/getcouponcode","metadata":{"seo":{"title":"Returns a coupon code from the system by its ID.","description":"This method will look up a coupon code by the specified ID and return it back."}},"httpPath":"/couponCodes/{tenantId}/{id}"},{"label":"Partially updates a coupon code with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/patchcouponcode","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/patchcouponcode","metadata":{"seo":{"title":"Partially updates a coupon code with the specified ID.","description":"This method will patch an existing coupon code with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/couponCodes/{tenantId}/{id}"},{"label":"Updates a coupon code with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupon-codes/updatecouponcode","routeSlug":"/apis/commerce/commerce-v1/coupon-codes/updatecouponcode","metadata":{"seo":{"title":"Updates a coupon code with the specified ID.","description":"This method will update an existing coupon code with the specified ID."}},"httpPath":"/couponCodes/{tenantId}/{id}"}]},{"type":"group","label":"Coupons","link":"/apis/commerce/commerce-v1/coupons","routeSlug":"/apis/commerce/commerce-v1/coupons","items":[{"label":"Gets all of the coupons in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupons/listcoupons","routeSlug":"/apis/commerce/commerce-v1/coupons/listcoupons","metadata":{"seo":{"title":"Gets all of the coupons in the system.","description":"This method will scan all coupons and and return them to the caller."}},"httpPath":"/coupons/{tenantId}"},{"label":"Creates a new coupon record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupons/createcoupon","routeSlug":"/apis/commerce/commerce-v1/coupons/createcoupon","metadata":{"seo":{"title":"Creates a new coupon record that does not already exist.","description":"This method will auto-generate an ID and create a new coupon. If an ID is specified for the coupon, an error will be thrown."}},"httpPath":"/coupons/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupons/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/coupons/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/coupons/{tenantId}/batch"},{"label":"Returns a coupon from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupons/deletecoupon","routeSlug":"/apis/commerce/commerce-v1/coupons/deletecoupon","metadata":{"seo":{"title":"Returns a coupon from the system by its ID.","description":"This method will delete a coupon with the specified ID."}},"httpPath":"/coupons/{tenantId}/{id}"},{"label":"Returns a coupon from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupons/getcoupon","routeSlug":"/apis/commerce/commerce-v1/coupons/getcoupon","metadata":{"seo":{"title":"Returns a coupon from the system by its ID.","description":"This method will look up a coupon by the specified ID and return it back."}},"httpPath":"/coupons/{tenantId}/{id}"},{"label":"Partially updates a coupon with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupons/patchcoupon","routeSlug":"/apis/commerce/commerce-v1/coupons/patchcoupon","metadata":{"seo":{"title":"Partially updates a coupon with the specified ID.","description":"This method will patch an existing coupon with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/coupons/{tenantId}/{id}"},{"label":"Updates a coupon with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/coupons/updatecoupon","routeSlug":"/apis/commerce/commerce-v1/coupons/updatecoupon","metadata":{"seo":{"title":"Updates a coupon with the specified ID.","description":"This method will update an existing coupon with the specified ID."}},"httpPath":"/coupons/{tenantId}/{id}"}]},{"type":"group","label":"Discount Products","link":"/apis/commerce/commerce-v1/discount-products","routeSlug":"/apis/commerce/commerce-v1/discount-products","items":[{"label":"Gets all of the discount products in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/discount-products/listdiscountproducts","routeSlug":"/apis/commerce/commerce-v1/discount-products/listdiscountproducts","metadata":{"seo":{"title":"Gets all of the discount products in the system.","description":"This method will scan all discount products and and return them to the caller."}},"httpPath":"/discountProducts/{tenantId}"},{"label":"Creates a new discount product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/discount-products/creatediscountproduct","routeSlug":"/apis/commerce/commerce-v1/discount-products/creatediscountproduct","metadata":{"seo":{"title":"Creates a new discount product record that does not already exist.","description":"This method will auto-generate an ID and create a new discount product. If an ID is specified for the discount product, an error will be thrown."}},"httpPath":"/discountProducts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/discount-products/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/discount-products/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/discountProducts/{tenantId}/batch"},{"label":"Returns a discount product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/discount-products/deletediscountproduct","routeSlug":"/apis/commerce/commerce-v1/discount-products/deletediscountproduct","metadata":{"seo":{"title":"Returns a discount product from the system by its ID.","description":"This method will delete a discount product with the specified ID."}},"httpPath":"/discountProducts/{tenantId}/{id}"},{"label":"Returns a discount product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/discount-products/getdiscountproduct","routeSlug":"/apis/commerce/commerce-v1/discount-products/getdiscountproduct","metadata":{"seo":{"title":"Returns a discount product from the system by its ID.","description":"This method will look up a discount product by the specified ID and return it back."}},"httpPath":"/discountProducts/{tenantId}/{id}"},{"label":"Partially updates a discount product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/discount-products/patchdiscountproduct","routeSlug":"/apis/commerce/commerce-v1/discount-products/patchdiscountproduct","metadata":{"seo":{"title":"Partially updates a discount product with the specified ID.","description":"This method will patch an existing discount product with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/discountProducts/{tenantId}/{id}"},{"label":"Updates a discount product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/discount-products/updatediscountproduct","routeSlug":"/apis/commerce/commerce-v1/discount-products/updatediscountproduct","metadata":{"seo":{"title":"Updates a discount product with the specified ID.","description":"This method will update an existing discount product with the specified ID."}},"httpPath":"/discountProducts/{tenantId}/{id}"}]},{"type":"group","label":"Entitlement Types","link":"/apis/commerce/commerce-v1/entitlement-types","routeSlug":"/apis/commerce/commerce-v1/entitlement-types","items":[{"label":"Gets all of the entitlement types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlement-types/listentitlementtypes","routeSlug":"/apis/commerce/commerce-v1/entitlement-types/listentitlementtypes","metadata":{"seo":{"title":"Gets all of the entitlement types in the system.","description":"This method will scan all entitlement types and and return them to the caller."}},"httpPath":"/entitlementTypes/{tenantId}"},{"label":"Creates a new entitlement type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlement-types/createentitlementtype","routeSlug":"/apis/commerce/commerce-v1/entitlement-types/createentitlementtype","metadata":{"seo":{"title":"Creates a new entitlement type record that does not already exist.","description":"This method will auto-generate an ID and create a new entitlement type. If an ID is specified for the entitlement type, an error will be thrown."}},"httpPath":"/entitlementTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlement-types/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/entitlement-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/entitlementTypes/{tenantId}/batch"},{"label":"Returns a entitlement type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlement-types/deleteentitlementtype","routeSlug":"/apis/commerce/commerce-v1/entitlement-types/deleteentitlementtype","metadata":{"seo":{"title":"Returns a entitlement type from the system by its ID.","description":"This method will delete a entitlement type with the specified ID."}},"httpPath":"/entitlementTypes/{tenantId}/{id}"},{"label":"Returns a entitlement type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlement-types/getentitlementtype","routeSlug":"/apis/commerce/commerce-v1/entitlement-types/getentitlementtype","metadata":{"seo":{"title":"Returns a entitlement type from the system by its ID.","description":"This method will look up a entitlement type by the specified ID and return it back."}},"httpPath":"/entitlementTypes/{tenantId}/{id}"},{"label":"Partially updates a entitlement type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlement-types/patchentitlementtype","routeSlug":"/apis/commerce/commerce-v1/entitlement-types/patchentitlementtype","metadata":{"seo":{"title":"Partially updates a entitlement type with the specified ID.","description":"This method will patch an existing entitlement type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/entitlementTypes/{tenantId}/{id}"},{"label":"Updates a entitlement type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlement-types/updateentitlementtype","routeSlug":"/apis/commerce/commerce-v1/entitlement-types/updateentitlementtype","metadata":{"seo":{"title":"Updates a entitlement type with the specified ID.","description":"This method will update an existing entitlement type with the specified ID."}},"httpPath":"/entitlementTypes/{tenantId}/{id}"}]},{"type":"group","label":"Entitlements","link":"/apis/commerce/commerce-v1/entitlements","routeSlug":"/apis/commerce/commerce-v1/entitlements","items":[{"label":"Creates a new entitlement record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlements/createentitlement","routeSlug":"/apis/commerce/commerce-v1/entitlements/createentitlement","metadata":{"seo":{"title":"Creates a new entitlement record that does not already exist.","description":"This method will auto-generate an ID and create a new entitlement. If an ID is specified for the entitlement, an error will be thrown."}},"httpPath":"/entitlements/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlements/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/entitlements/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/entitlements/{tenantId}/batch"},{"label":"Check that a contact/organization has an entitlement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlements/checkentitlement","routeSlug":"/apis/commerce/commerce-v1/entitlements/checkentitlement","metadata":{"seo":{"title":"Check that a contact/organization has an entitlement","description":"Returns a list of records with the specified owner_entitlement_type"}},"httpPath":"/entitlements/{tenantId}/checkEntitlement/{owner_type}/{owner_id}/{type_id}"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlements/listentitlementsbycontactid","routeSlug":"/apis/commerce/commerce-v1/entitlements/listentitlementsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/entitlements/{tenantId}/contact/{contact_id}"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlements/listentitlementsbyorderid","routeSlug":"/apis/commerce/commerce-v1/entitlements/listentitlementsbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"httpPath":"/entitlements/{tenantId}/order/{order_id}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlements/listentitlementsbyorganizationid","routeSlug":"/apis/commerce/commerce-v1/entitlements/listentitlementsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/entitlements/{tenantId}/organization/{organization_id}"},{"label":"Returns a list of records with the specified owner_entitlement_type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlements/listentitlementsbyownerentitlementtype","routeSlug":"/apis/commerce/commerce-v1/entitlements/listentitlementsbyownerentitlementtype","metadata":{"seo":{"title":"Returns a list of records with the specified owner_entitlement_type","description":"Returns a list of records with the specified owner_entitlement_type"}},"httpPath":"/entitlements/{tenantId}/ownerEntitlementType/{owner_type}/{owner_id}/{type_id}"},{"label":"Returns a entitlement from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlements/deleteentitlement","routeSlug":"/apis/commerce/commerce-v1/entitlements/deleteentitlement","metadata":{"seo":{"title":"Returns a entitlement from the system by its ID.","description":"This method will delete a entitlement with the specified ID."}},"httpPath":"/entitlements/{tenantId}/{id}"},{"label":"Returns a entitlement from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlements/getentitlement","routeSlug":"/apis/commerce/commerce-v1/entitlements/getentitlement","metadata":{"seo":{"title":"Returns a entitlement from the system by its ID.","description":"This method will look up a entitlement by the specified ID and return it back."}},"httpPath":"/entitlements/{tenantId}/{id}"},{"label":"Partially updates a entitlement with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlements/patchentitlement","routeSlug":"/apis/commerce/commerce-v1/entitlements/patchentitlement","metadata":{"seo":{"title":"Partially updates a entitlement with the specified ID.","description":"This method will patch an existing entitlement with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/entitlements/{tenantId}/{id}"},{"label":"Updates a entitlement with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/entitlements/updateentitlement","routeSlug":"/apis/commerce/commerce-v1/entitlements/updateentitlement","metadata":{"seo":{"title":"Updates a entitlement with the specified ID.","description":"This method will update an existing entitlement with the specified ID."}},"httpPath":"/entitlements/{tenantId}/{id}"}]},{"type":"group","label":"Inventory Transactions","link":"/apis/commerce/commerce-v1/inventory-transactions","routeSlug":"/apis/commerce/commerce-v1/inventory-transactions","items":[{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/inventory-transactions/warmupinventorytransactions","routeSlug":"/apis/commerce/commerce-v1/inventory-transactions/warmupinventorytransactions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"httpPath":"/inventoryTransactions/warmUpStepFunctions"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/inventory-transactions/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/inventory-transactions/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/inventoryTransactions/{tenantId}/batch"},{"label":"Returns a list of records with the specified open_purchase_order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/inventory-transactions/listopenpurchaseordersforproduct","routeSlug":"/apis/commerce/commerce-v1/inventory-transactions/listopenpurchaseordersforproduct","metadata":{"seo":{"title":"Returns a list of records with the specified open_purchase_order_id","description":"Returns a list of records with the specified open_purchase_order_id"}},"httpPath":"/inventoryTransactions/{tenantId}/openPurchaseOrders/{product_type}/{product_id}"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/inventory-transactions/listtransactionsbyorderid","routeSlug":"/apis/commerce/commerce-v1/inventory-transactions/listtransactionsbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"httpPath":"/inventoryTransactions/{tenantId}/order/{order_id}"},{"label":"Initiates workflow to process an inventory transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/inventory-transactions/processinventorytransaction","routeSlug":"/apis/commerce/commerce-v1/inventory-transactions/processinventorytransaction","metadata":{"seo":{"title":"Initiates workflow to process an inventory transaction","description":"This method will auto-generate an ID and create a new inventory transaction. If an ID is specified for the inventory transaction, an error will be thrown."}},"httpPath":"/inventoryTransactions/{tenantId}/process"},{"label":"Initiates workflow to process an inventory transaction","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/inventory-transactions/processinventorytransactionsync","routeSlug":"/apis/commerce/commerce-v1/inventory-transactions/processinventorytransactionsync","metadata":{"seo":{"title":"Initiates workflow to process an inventory transaction","description":"This method will auto-generate an ID and create a new inventory transaction. If an ID is specified for the inventory transaction, an error will be thrown."}},"httpPath":"/inventoryTransactions/{tenantId}/process/sync"},{"label":"Returns a list of records with the specified product_inventory_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/inventory-transactions/listtransactionsbyproductinventoryid","routeSlug":"/apis/commerce/commerce-v1/inventory-transactions/listtransactionsbyproductinventoryid","metadata":{"seo":{"title":"Returns a list of records with the specified product_inventory_id","description":"Returns a list of records with the specified product_inventory_id"}},"httpPath":"/inventoryTransactions/{tenantId}/productInventory/{product_inventory_id}"},{"label":"Returns a inventory transaction from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/inventory-transactions/getinventorytransaction","routeSlug":"/apis/commerce/commerce-v1/inventory-transactions/getinventorytransaction","metadata":{"seo":{"title":"Returns a inventory transaction from the system by its ID.","description":"This method will look up a inventory transaction by the specified ID and return it back."}},"httpPath":"/inventoryTransactions/{tenantId}/{id}"},{"label":"Partially updates a inventory transaction with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/inventory-transactions/patchinventorytransaction","routeSlug":"/apis/commerce/commerce-v1/inventory-transactions/patchinventorytransaction","metadata":{"seo":{"title":"Partially updates a inventory transaction with the specified ID.","description":"This method will patch an existing inventory transaction with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/inventoryTransactions/{tenantId}/{id}"},{"label":"Updates a inventory transaction with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/inventory-transactions/updateinventorytransaction","routeSlug":"/apis/commerce/commerce-v1/inventory-transactions/updateinventorytransaction","metadata":{"seo":{"title":"Updates a inventory transaction with the specified ID.","description":"This method will update an existing inventory transaction with the specified ID."}},"httpPath":"/inventoryTransactions/{tenantId}/{id}"}]},{"type":"group","label":"Merchandise","link":"/apis/commerce/commerce-v1/merchandise","routeSlug":"/apis/commerce/commerce-v1/merchandise","items":[{"label":"Gets all of the merchandise in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/merchandise/listmerchandise","routeSlug":"/apis/commerce/commerce-v1/merchandise/listmerchandise","metadata":{"seo":{"title":"Gets all of the merchandise in the system.","description":"This method will scan all merchandise and and return them to the caller."}},"httpPath":"/merchandise/{tenantId}"},{"label":"Creates a new merchandise record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/merchandise/createmerchandise","routeSlug":"/apis/commerce/commerce-v1/merchandise/createmerchandise","metadata":{"seo":{"title":"Creates a new merchandise record that does not already exist.","description":"This method will auto-generate an ID and create a new merchandise. If an ID is specified for the merchandise, an error will be thrown."}},"httpPath":"/merchandise/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/merchandise/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/merchandise/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/merchandise/{tenantId}/batch"},{"label":"Returns a list of records with the specified category_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/merchandise/listmerchandisebycategoryid","routeSlug":"/apis/commerce/commerce-v1/merchandise/listmerchandisebycategoryid","metadata":{"seo":{"title":"Returns a list of records with the specified category_id","description":"Returns a list of records with the specified category_id"}},"httpPath":"/merchandise/{tenantId}/category/{category_id}"},{"label":"Lists all merchandise","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/merchandise/listallpublicmerchandise","routeSlug":"/apis/commerce/commerce-v1/merchandise/listallpublicmerchandise","metadata":{"seo":{"title":"Lists all merchandise","description":"Lists all merchandise"}},"httpPath":"/merchandise/{tenantId}/public"},{"label":"Gets merchandise info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/merchandise/get","routeSlug":"/apis/commerce/commerce-v1/merchandise/get","metadata":{"seo":{"title":"Gets merchandise info","description":"Gets merchandise info"}},"httpPath":"/merchandise/{tenantId}/public/{id}"},{"label":"Searches for merchandise using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/merchandise/searchformerchandise","routeSlug":"/apis/commerce/commerce-v1/merchandise/searchformerchandise","metadata":{"seo":{"title":"Searches for merchandise using predefined parameters","description":"Searches for merchandise using predefined parameters"}},"httpPath":"/merchandise/{tenantId}/search"},{"label":"Returns a merchandise from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/merchandise/deletemerchandise","routeSlug":"/apis/commerce/commerce-v1/merchandise/deletemerchandise","metadata":{"seo":{"title":"Returns a merchandise from the system by its ID.","description":"This method will delete a merchandise with the specified ID."}},"httpPath":"/merchandise/{tenantId}/{id}"},{"label":"Returns a merchandise from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/merchandise/getmerchandise","routeSlug":"/apis/commerce/commerce-v1/merchandise/getmerchandise","metadata":{"seo":{"title":"Returns a merchandise from the system by its ID.","description":"This method will look up a merchandise by the specified ID and return it back."}},"httpPath":"/merchandise/{tenantId}/{id}"},{"label":"Partially updates a merchandise with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/merchandise/patchmerchandise","routeSlug":"/apis/commerce/commerce-v1/merchandise/patchmerchandise","metadata":{"seo":{"title":"Partially updates a merchandise with the specified ID.","description":"This method will patch an existing merchandise with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/merchandise/{tenantId}/{id}"},{"label":"Updates a merchandise with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/merchandise/updatemerchandise","routeSlug":"/apis/commerce/commerce-v1/merchandise/updatemerchandise","metadata":{"seo":{"title":"Updates a merchandise with the specified ID.","description":"This method will update an existing merchandise with the specified ID."}},"httpPath":"/merchandise/{tenantId}/{id}"}]},{"type":"group","label":"Orders","link":"/apis/commerce/commerce-v1/orders","routeSlug":"/apis/commerce/commerce-v1/orders","items":[{"label":"Gets all of the orders in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listorders","routeSlug":"/apis/commerce/commerce-v1/orders/listorders","metadata":{"seo":{"title":"Gets all of the orders in the system.","description":"This method will scan all orders and and return them to the caller."}},"httpPath":"/orders/{tenantId}"},{"label":"Processes a order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/processorder","routeSlug":"/apis/commerce/commerce-v1/orders/processorder","metadata":{"seo":{"title":"Processes a order","description":"This method will auto-generate an ID and create a new order. If an ID is specified for the order, an error will be thrown."}},"httpPath":"/orders/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/orders/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/orders/{tenantId}/batch"},{"label":"Returns a list of records with the specified bill_to_contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listordersbybilltocontactid","routeSlug":"/apis/commerce/commerce-v1/orders/listordersbybilltocontactid","metadata":{"seo":{"title":"Returns a list of records with the specified bill_to_contact_id","description":"Returns a list of records with the specified bill_to_contact_id"}},"httpPath":"/orders/{tenantId}/billToContact/{bill_to_contact_id}"},{"label":"Returns a list of records with the specified bill_to_organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listordersbybilltoorganizationid","routeSlug":"/apis/commerce/commerce-v1/orders/listordersbybilltoorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified bill_to_organization_id","description":"Returns a list of records with the specified bill_to_organization_id"}},"httpPath":"/orders/{tenantId}/billToOrganization/{bill_to_organization_id}"},{"label":"Checks to see whether or not a person is eligible based on specified criteria","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/checkeligibility","routeSlug":"/apis/commerce/commerce-v1/orders/checkeligibility","metadata":{"seo":{"title":"Checks to see whether or not a person is eligible based on specified criteria","description":"This method takes in an order that has not yet been placed, and returns information about order pricing and available options"}},"httpPath":"/orders/{tenantId}/checkEligibility/{customerType}/{contactOrOrganizationId}"},{"label":"Checks to see whether or not a person is eligible based on specified criteria","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/checkprice","routeSlug":"/apis/commerce/commerce-v1/orders/checkprice","metadata":{"seo":{"title":"Checks to see whether or not a person is eligible based on specified criteria","description":"This method takes in an order that has not yet been placed, and returns information about order pricing and available options"}},"httpPath":"/orders/{tenantId}/checkPrice/{customerType}/{billToId}"},{"label":"Closes an Order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/closeorder","routeSlug":"/apis/commerce/commerce-v1/orders/closeorder","metadata":{"seo":{"title":"Closes an Order","description":"Closes an order"}},"httpPath":"/orders/{tenantId}/close/{id}"},{"label":"Returns a list of records with the specified coupon_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listordersbycouponid","routeSlug":"/apis/commerce/commerce-v1/orders/listordersbycouponid","metadata":{"seo":{"title":"Returns a list of records with the specified coupon_id","description":"Returns a list of records with the specified coupon_id"}},"httpPath":"/orders/{tenantId}/coupon/{coupon_type}/{coupon_id}"},{"label":"Returns a list of records with the specified coupon_code_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listcouponcodeusagesbycouponcode","routeSlug":"/apis/commerce/commerce-v1/orders/listcouponcodeusagesbycouponcode","metadata":{"seo":{"title":"Returns a list of records with the specified coupon_code_id","description":"Returns a list of records with the specified coupon_code_id"}},"httpPath":"/orders/{tenantId}/couponCodeUsages/{coupon_code_id}"},{"label":"Returns a list of records with the specified coupon id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listcouponusagesbycoupon","routeSlug":"/apis/commerce/commerce-v1/orders/listcouponusagesbycoupon","metadata":{"seo":{"title":"Returns a list of records with the specified coupon id","description":"Returns a list of records with the specified coupon id"}},"httpPath":"/orders/{tenantId}/couponUsages/{coupon_type}/{coupon_id}"},{"label":"List orders by customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listordersbycustomer","routeSlug":"/apis/commerce/commerce-v1/orders/listordersbycustomer","metadata":{"seo":{"title":"List orders by customer","description":"Includes orders where ship to"}},"httpPath":"/orders/{tenantId}/customer/{customerType}/{customerId}"},{"label":"Returns a list of records with the specified installment_schedule_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listordersbyinstallmentscheduleid","routeSlug":"/apis/commerce/commerce-v1/orders/listordersbyinstallmentscheduleid","metadata":{"seo":{"title":"Returns a list of records with the specified installment_schedule_id","description":"Returns a list of records with the specified installment_schedule_id"}},"httpPath":"/orders/{tenantId}/installmentSchedule/{installment_schedule_id}"},{"label":"Gets all of the orders in the system for a given contact.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listordersforportal","routeSlug":"/apis/commerce/commerce-v1/orders/listordersforportal","metadata":{"seo":{"title":"Gets all of the orders in the system for a given contact.","description":"This method will scan all orders and and return them to the caller for a given contact."}},"httpPath":"/orders/{tenantId}/portal/contact/{portalContactId}"},{"label":"Returns a order from the system by its ID for a given contact.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/getorderforportal","routeSlug":"/apis/commerce/commerce-v1/orders/getorderforportal","metadata":{"seo":{"title":"Returns a order from the system by its ID for a given contact.","description":"This method will look up a order by the specified ID and return it back (for a portal contact)"}},"httpPath":"/orders/{tenantId}/portal/contact/{portalContactId}/{id}"},{"label":"Gets all of the orders in the system for a given organization.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listordersforportalbyorganization","routeSlug":"/apis/commerce/commerce-v1/orders/listordersforportalbyorganization","metadata":{"seo":{"title":"Gets all of the orders in the system for a given organization.","description":"This method will scan all orders and and return them to the caller for a given organization."}},"httpPath":"/orders/{tenantId}/portal/organization/{portalOrganizationId}"},{"label":"Returns a order from the system by its ID for a given organization.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/getorderforportal","routeSlug":"/apis/commerce/commerce-v1/orders/getorderforportal","metadata":{"seo":{"title":"Returns a order from the system by its ID for a given organization.","description":"This method will look up a order by the specified ID and return it back (for a portal organization)"}},"httpPath":"/orders/{tenantId}/portal/organization/{portalOrganizationId}/{id}"},{"label":"Preview an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/previeworder","routeSlug":"/apis/commerce/commerce-v1/orders/previeworder","metadata":{"seo":{"title":"Preview an order","description":"This method takes in an order that has not yet been placed, and returns information about order pricing and available options"}},"httpPath":"/orders/{tenantId}/preview"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/previeworderconfirmationemail","routeSlug":"/apis/commerce/commerce-v1/orders/previeworderconfirmationemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/orders/{tenantId}/previewOrderConfirmationEmail"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/previewproductconfirmationemail","routeSlug":"/apis/commerce/commerce-v1/orders/previewproductconfirmationemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/orders/{tenantId}/previewProductConfirmationEmail"},{"label":"Previews an order with line item overrides","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/previeworderwithoverride","routeSlug":"/apis/commerce/commerce-v1/orders/previeworderwithoverride","metadata":{"seo":{"title":"Previews an order with line item overrides","description":"This is designed to be run by administrators; allows an order to e previewed but have prices or quantities overridden"}},"httpPath":"/orders/{tenantId}/previewWithOverride"},{"label":"Processes an order with line item overrides","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/processorderwithoverride","routeSlug":"/apis/commerce/commerce-v1/orders/processorderwithoverride","metadata":{"seo":{"title":"Processes an order with line item overrides","description":"This is designed to be run by administrators; allows an order to e processed but have prices or quantities overridden"}},"httpPath":"/orders/{tenantId}/processWithOverride"},{"label":"Processes an order with line item overrides","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/processorderwithoverridesync","routeSlug":"/apis/commerce/commerce-v1/orders/processorderwithoverridesync","metadata":{"seo":{"title":"Processes an order with line item overrides","description":"This is designed to be run by administrators; allows an order to e processed but have prices or quantities overridden"}},"httpPath":"/orders/{tenantId}/processWithOverride/sync"},{"label":"Gets the availability of merchandise","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/getmerchandiseavailability","routeSlug":"/apis/commerce/commerce-v1/orders/getmerchandiseavailability","metadata":{"seo":{"title":"Gets the availability of merchandise","description":"Takes in merchandise and determines it's availability"}},"httpPath":"/orders/{tenantId}/public/checkAvailability"},{"label":"Preview an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/describeproducts","routeSlug":"/apis/commerce/commerce-v1/orders/describeproducts","metadata":{"seo":{"title":"Preview an order","description":"This method takes in an order that has not yet been placed, and returns information about order pricing and available options"}},"httpPath":"/orders/{tenantId}/public/describeProducts"},{"label":"Previews an order publicly","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/previeworder","routeSlug":"/apis/commerce/commerce-v1/orders/previeworder","metadata":{"seo":{"title":"Previews an order publicly","description":"This method takes in an order that has not yet been placed, and returns information about order pricing and available options"}},"httpPath":"/orders/{tenantId}/public/preview"},{"label":"Applies a coupon to an existing order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/retroactivelyapplycoupontoorder","routeSlug":"/apis/commerce/commerce-v1/orders/retroactivelyapplycoupontoorder","metadata":{"seo":{"title":"Applies a coupon to an existing order","description":"This is designed to be run by administrators; allows an order to e processed but have prices or quantities overridden"}},"httpPath":"/orders/{tenantId}/retroactivelyApplyCoupon"},{"label":"Applies a coupon to an existing order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/retroactivelyapplycoupontoordersync","routeSlug":"/apis/commerce/commerce-v1/orders/retroactivelyapplycoupontoordersync","metadata":{"seo":{"title":"Applies a coupon to an existing order","description":"This is designed to be run by administrators; allows an order to e processed but have prices or quantities overridden"}},"httpPath":"/orders/{tenantId}/retroactivelyApplyCoupon/sync"},{"label":"Searches for orders using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/searchfororders","routeSlug":"/apis/commerce/commerce-v1/orders/searchfororders","metadata":{"seo":{"title":"Searches for orders using predefined parameters","description":"Searches for orders using predefined parameters"}},"httpPath":"/orders/{tenantId}/search"},{"label":"Returns a list of records with the specified ship_to_contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listordersbyshiptocontactid","routeSlug":"/apis/commerce/commerce-v1/orders/listordersbyshiptocontactid","metadata":{"seo":{"title":"Returns a list of records with the specified ship_to_contact_id","description":"Returns a list of records with the specified ship_to_contact_id"}},"httpPath":"/orders/{tenantId}/shipToContact/{ship_to_contact_id}"},{"label":"Returns a list of records with the specified ship_to_organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listordersbyshiptoorganizationid","routeSlug":"/apis/commerce/commerce-v1/orders/listordersbyshiptoorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified ship_to_organization_id","description":"Returns a list of records with the specified ship_to_organization_id"}},"httpPath":"/orders/{tenantId}/shipToOrganization/{ship_to_organization_id}"},{"label":"Returns a list of shippable orders with the specified status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listshippableordersbystatus","routeSlug":"/apis/commerce/commerce-v1/orders/listshippableordersbystatus","metadata":{"seo":{"title":"Returns a list of shippable orders with the specified status","description":"Returns a list of shippable orders with the specified status"}},"httpPath":"/orders/{tenantId}/shippable/status/{status}"},{"label":"Returns a list of records with the specified shippable_status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/listordersbyshippablestatus","routeSlug":"/apis/commerce/commerce-v1/orders/listordersbyshippablestatus","metadata":{"seo":{"title":"Returns a list of records with the specified shippable_status","description":"Returns a list of records with the specified shippable_status"}},"httpPath":"/orders/{tenantId}/shippableStatus/{shippable_status}"},{"label":"Creates a new order that doesn't already exist","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/processordersync","routeSlug":"/apis/commerce/commerce-v1/orders/processordersync","metadata":{"seo":{"title":"Creates a new order that doesn't already exist","description":"This method will auto-generate an ID and create a new order. If an ID is specified for the order, an error will be thrown."}},"httpPath":"/orders/{tenantId}/sync"},{"label":"Void an order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/voidorder","routeSlug":"/apis/commerce/commerce-v1/orders/voidorder","metadata":{"seo":{"title":"Void an order","description":"This method voids an order"}},"httpPath":"/orders/{tenantId}/void/{id}"},{"label":"Returns a order from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/deleteorder","routeSlug":"/apis/commerce/commerce-v1/orders/deleteorder","metadata":{"seo":{"title":"Returns a order from the system by its ID.","description":"This method will delete a order with the specified ID."}},"httpPath":"/orders/{tenantId}/{id}"},{"label":"Returns a order from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/getorder","routeSlug":"/apis/commerce/commerce-v1/orders/getorder","metadata":{"seo":{"title":"Returns a order from the system by its ID.","description":"This method will look up a order by the specified ID and return it back."}},"httpPath":"/orders/{tenantId}/{id}"},{"label":"Partially updates a order with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/patchorder","routeSlug":"/apis/commerce/commerce-v1/orders/patchorder","metadata":{"seo":{"title":"Partially updates a order with the specified ID.","description":"This method will patch an existing order with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/orders/{tenantId}/{id}"},{"label":"Updates a order with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/orders/updateorder","routeSlug":"/apis/commerce/commerce-v1/orders/updateorder","metadata":{"seo":{"title":"Updates a order with the specified ID.","description":"This method will update an existing order with the specified ID."}},"httpPath":"/orders/{tenantId}/{id}"}]},{"type":"group","label":"Product Categories","link":"/apis/commerce/commerce-v1/product-categories","routeSlug":"/apis/commerce/commerce-v1/product-categories","items":[{"label":"Gets all of the product categories in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-categories/listproductcategories","routeSlug":"/apis/commerce/commerce-v1/product-categories/listproductcategories","metadata":{"seo":{"title":"Gets all of the product categories in the system.","description":"This method will scan all product categories and and return them to the caller."}},"httpPath":"/productCategories/{tenantId}"},{"label":"Creates a new product category record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-categories/createproductcategory","routeSlug":"/apis/commerce/commerce-v1/product-categories/createproductcategory","metadata":{"seo":{"title":"Creates a new product category record that does not already exist.","description":"This method will auto-generate an ID and create a new product category. If an ID is specified for the product category, an error will be thrown."}},"httpPath":"/productCategories/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-categories/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/product-categories/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/productCategories/{tenantId}/batch"},{"label":"Returns a product category from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-categories/deleteproductcategory","routeSlug":"/apis/commerce/commerce-v1/product-categories/deleteproductcategory","metadata":{"seo":{"title":"Returns a product category from the system by its ID.","description":"This method will delete a product category with the specified ID."}},"httpPath":"/productCategories/{tenantId}/{id}"},{"label":"Returns a product category from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-categories/getproductcategory","routeSlug":"/apis/commerce/commerce-v1/product-categories/getproductcategory","metadata":{"seo":{"title":"Returns a product category from the system by its ID.","description":"This method will look up a product category by the specified ID and return it back."}},"httpPath":"/productCategories/{tenantId}/{id}"},{"label":"Partially updates a product category with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-categories/patchproductcategory","routeSlug":"/apis/commerce/commerce-v1/product-categories/patchproductcategory","metadata":{"seo":{"title":"Partially updates a product category with the specified ID.","description":"This method will patch an existing product category with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/productCategories/{tenantId}/{id}"},{"label":"Updates a product category with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-categories/updateproductcategory","routeSlug":"/apis/commerce/commerce-v1/product-categories/updateproductcategory","metadata":{"seo":{"title":"Updates a product category with the specified ID.","description":"This method will update an existing product category with the specified ID."}},"httpPath":"/productCategories/{tenantId}/{id}"}]},{"type":"group","label":"Product Confirmation Emails","link":"/apis/commerce/commerce-v1/product-confirmation-emails","routeSlug":"/apis/commerce/commerce-v1/product-confirmation-emails","items":[{"label":"Gets all of the product confirmation emails in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-confirmation-emails/listproductconfirmationemails","routeSlug":"/apis/commerce/commerce-v1/product-confirmation-emails/listproductconfirmationemails","metadata":{"seo":{"title":"Gets all of the product confirmation emails in the system.","description":"This method will scan all product confirmation emails and and return them to the caller."}},"httpPath":"/productConfirmationEmails/{tenantId}"},{"label":"Creates a new product confirmation email record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-confirmation-emails/createproductconfirmationemail","routeSlug":"/apis/commerce/commerce-v1/product-confirmation-emails/createproductconfirmationemail","metadata":{"seo":{"title":"Creates a new product confirmation email record that does not already exist.","description":"This method will auto-generate an ID and create a new product confirmation email. If an ID is specified for the product confirmation email, an error will be thrown."}},"httpPath":"/productConfirmationEmails/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-confirmation-emails/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/product-confirmation-emails/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/productConfirmationEmails/{tenantId}/batch"},{"label":"Returns a product confirmation email from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-confirmation-emails/deleteproductconfirmationemail","routeSlug":"/apis/commerce/commerce-v1/product-confirmation-emails/deleteproductconfirmationemail","metadata":{"seo":{"title":"Returns a product confirmation email from the system by its ID.","description":"This method will delete a product confirmation email with the specified ID."}},"httpPath":"/productConfirmationEmails/{tenantId}/{id}"},{"label":"Returns a product confirmation email from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-confirmation-emails/getproductconfirmationemail","routeSlug":"/apis/commerce/commerce-v1/product-confirmation-emails/getproductconfirmationemail","metadata":{"seo":{"title":"Returns a product confirmation email from the system by its ID.","description":"This method will look up a product confirmation email by the specified ID and return it back."}},"httpPath":"/productConfirmationEmails/{tenantId}/{id}"},{"label":"Partially updates a product confirmation email with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-confirmation-emails/patchproductconfirmationemail","routeSlug":"/apis/commerce/commerce-v1/product-confirmation-emails/patchproductconfirmationemail","metadata":{"seo":{"title":"Partially updates a product confirmation email with the specified ID.","description":"This method will patch an existing product confirmation email with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/productConfirmationEmails/{tenantId}/{id}"},{"label":"Updates a product confirmation email with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-confirmation-emails/updateproductconfirmationemail","routeSlug":"/apis/commerce/commerce-v1/product-confirmation-emails/updateproductconfirmationemail","metadata":{"seo":{"title":"Updates a product confirmation email with the specified ID.","description":"This method will update an existing product confirmation email with the specified ID."}},"httpPath":"/productConfirmationEmails/{tenantId}/{id}"}]},{"type":"group","label":"Product Inventories","link":"/apis/commerce/commerce-v1/product-inventories","routeSlug":"/apis/commerce/commerce-v1/product-inventories","items":[{"label":"Gets all of the product inventories in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-inventories/listproductinventories","routeSlug":"/apis/commerce/commerce-v1/product-inventories/listproductinventories","metadata":{"seo":{"title":"Gets all of the product inventories in the system.","description":"This method will scan all product inventories and and return them to the caller."}},"httpPath":"/productInventories/{tenantId}"},{"label":"Creates a new product inventory record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-inventories/createproductinventory","routeSlug":"/apis/commerce/commerce-v1/product-inventories/createproductinventory","metadata":{"seo":{"title":"Creates a new product inventory record that does not already exist.","description":"This method will auto-generate an ID and create a new product inventory. If an ID is specified for the product inventory, an error will be thrown."}},"httpPath":"/productInventories/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-inventories/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/product-inventories/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/productInventories/{tenantId}/batch"},{"label":"Returns a list of records with the specified product_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-inventories/listinventoriesbyproductid","routeSlug":"/apis/commerce/commerce-v1/product-inventories/listinventoriesbyproductid","metadata":{"seo":{"title":"Returns a list of records with the specified product_id","description":"Returns a list of records with the specified product_id"}},"httpPath":"/productInventories/{tenantId}/product/{product_type}/{product_id}"},{"label":"Returns a product inventory from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-inventories/deleteproductinventory","routeSlug":"/apis/commerce/commerce-v1/product-inventories/deleteproductinventory","metadata":{"seo":{"title":"Returns a product inventory from the system by its ID.","description":"This method will delete a product inventory with the specified ID."}},"httpPath":"/productInventories/{tenantId}/{id}"},{"label":"Returns a product inventory from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-inventories/getproductinventory","routeSlug":"/apis/commerce/commerce-v1/product-inventories/getproductinventory","metadata":{"seo":{"title":"Returns a product inventory from the system by its ID.","description":"This method will look up a product inventory by the specified ID and return it back."}},"httpPath":"/productInventories/{tenantId}/{id}"},{"label":"Partially updates a product inventory with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-inventories/patchproductinventory","routeSlug":"/apis/commerce/commerce-v1/product-inventories/patchproductinventory","metadata":{"seo":{"title":"Partially updates a product inventory with the specified ID.","description":"This method will patch an existing product inventory with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/productInventories/{tenantId}/{id}"},{"label":"Updates a product inventory with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/product-inventories/updateproductinventory","routeSlug":"/apis/commerce/commerce-v1/product-inventories/updateproductinventory","metadata":{"seo":{"title":"Updates a product inventory with the specified ID.","description":"This method will update an existing product inventory with the specified ID."}},"httpPath":"/productInventories/{tenantId}/{id}"}]},{"type":"group","label":"Query Definitions","link":"/apis/commerce/commerce-v1/query-definitions","routeSlug":"/apis/commerce/commerce-v1/query-definitions","items":[{"label":"Returns a list of records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/query-definitions/getquerydefinitions","routeSlug":"/apis/commerce/commerce-v1/query-definitions/getquerydefinitions","metadata":{"seo":{"title":"Returns a list of records","description":"Returns a list of records"}},"httpPath":"/queryDefinitions/{tenantId}"}]},{"type":"group","label":"Returns","link":"/apis/commerce/commerce-v1/returns","routeSlug":"/apis/commerce/commerce-v1/returns","items":[{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/returns/warmupstepfunctions","routeSlug":"/apis/commerce/commerce-v1/returns/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"httpPath":"/returns/warmUpStepFunctions"},{"label":"Processes a return","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/returns/processreturn","routeSlug":"/apis/commerce/commerce-v1/returns/processreturn","metadata":{"seo":{"title":"Processes a return","description":"This method will auto-generate an ID and create a new return. If an ID is specified for the return, an error will be thrown."}},"httpPath":"/returns/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/returns/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/returns/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/returns/{tenantId}/batch"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/returns/listreturnsbyorderid","routeSlug":"/apis/commerce/commerce-v1/returns/listreturnsbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"httpPath":"/returns/{tenantId}/order/{order_id}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/returns/previewemail","routeSlug":"/apis/commerce/commerce-v1/returns/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/returns/{tenantId}/previewEmail"},{"label":"Processes a return","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/returns/processreturnsync","routeSlug":"/apis/commerce/commerce-v1/returns/processreturnsync","metadata":{"seo":{"title":"Processes a return","description":"This method will auto-generate an ID and create a new return. If an ID is specified for the return, an error will be thrown."}},"httpPath":"/returns/{tenantId}/sync"},{"label":"Returns a return from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/returns/deletereturn","routeSlug":"/apis/commerce/commerce-v1/returns/deletereturn","metadata":{"seo":{"title":"Returns a return from the system by its ID.","description":"This method will delete a return with the specified ID."}},"httpPath":"/returns/{tenantId}/{id}"},{"label":"Returns a return from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/returns/getreturn","routeSlug":"/apis/commerce/commerce-v1/returns/getreturn","metadata":{"seo":{"title":"Returns a return from the system by its ID.","description":"This method will look up a return by the specified ID and return it back."}},"httpPath":"/returns/{tenantId}/{id}"},{"label":"Partially updates a return with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/returns/patchreturn","routeSlug":"/apis/commerce/commerce-v1/returns/patchreturn","metadata":{"seo":{"title":"Partially updates a return with the specified ID.","description":"This method will patch an existing return with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/returns/{tenantId}/{id}"},{"label":"Updates a return with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/returns/updatereturn","routeSlug":"/apis/commerce/commerce-v1/returns/updatereturn","metadata":{"seo":{"title":"Updates a return with the specified ID.","description":"This method will update an existing return with the specified ID."}},"httpPath":"/returns/{tenantId}/{id}"}]},{"type":"group","label":"Settings","link":"/apis/commerce/commerce-v1/settings","routeSlug":"/apis/commerce/commerce-v1/settings","items":[{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/settings/deletesetting","routeSlug":"/apis/commerce/commerce-v1/settings/deletesetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will delete a setting with the specified ID."}},"httpPath":"/settings/{tenantId}"},{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/settings/getsetting","routeSlug":"/apis/commerce/commerce-v1/settings/getsetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will look up a setting by the specified ID and return it back."}},"httpPath":"/settings/{tenantId}"},{"label":"Partially updates a setting with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/settings/patchsetting","routeSlug":"/apis/commerce/commerce-v1/settings/patchsetting","metadata":{"seo":{"title":"Partially updates a setting with the specified ID.","description":"This method will patch an existing setting with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/settings/{tenantId}"},{"label":"Creates a new setting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/settings/createsetting","routeSlug":"/apis/commerce/commerce-v1/settings/createsetting","metadata":{"seo":{"title":"Creates a new setting record that does not already exist.","description":"This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, an error will be thrown."}},"httpPath":"/settings/{tenantId}"},{"label":"Updates a setting with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/settings/updatesetting","routeSlug":"/apis/commerce/commerce-v1/settings/updatesetting","metadata":{"seo":{"title":"Updates a setting with the specified ID.","description":"This method will update an existing setting with the specified ID."}},"httpPath":"/settings/{tenantId}"}]},{"type":"group","label":"Shared Modifier Options","link":"/apis/commerce/commerce-v1/shared-modifier-options","routeSlug":"/apis/commerce/commerce-v1/shared-modifier-options","items":[{"label":"Gets all of the shared modifier options in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-modifier-options/listsharedmodifieroptions","routeSlug":"/apis/commerce/commerce-v1/shared-modifier-options/listsharedmodifieroptions","metadata":{"seo":{"title":"Gets all of the shared modifier options in the system.","description":"This method will scan all shared modifier options and and return them to the caller."}},"httpPath":"/sharedModifierOptions/{tenantId}"},{"label":"Creates a new shared modifier option record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-modifier-options/createsharedmodifieroption","routeSlug":"/apis/commerce/commerce-v1/shared-modifier-options/createsharedmodifieroption","metadata":{"seo":{"title":"Creates a new shared modifier option record that does not already exist.","description":"This method will auto-generate an ID and create a new shared modifier option. If an ID is specified for the shared modifier option, an error will be thrown."}},"httpPath":"/sharedModifierOptions/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-modifier-options/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/shared-modifier-options/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/sharedModifierOptions/{tenantId}/batch"},{"label":"Returns a shared modifier option from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-modifier-options/deletesharedmodifieroption","routeSlug":"/apis/commerce/commerce-v1/shared-modifier-options/deletesharedmodifieroption","metadata":{"seo":{"title":"Returns a shared modifier option from the system by its ID.","description":"This method will delete a shared modifier option with the specified ID."}},"httpPath":"/sharedModifierOptions/{tenantId}/{id}"},{"label":"Returns a shared modifier option from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-modifier-options/getsharedmodifieroption","routeSlug":"/apis/commerce/commerce-v1/shared-modifier-options/getsharedmodifieroption","metadata":{"seo":{"title":"Returns a shared modifier option from the system by its ID.","description":"This method will look up a shared modifier option by the specified ID and return it back."}},"httpPath":"/sharedModifierOptions/{tenantId}/{id}"},{"label":"Partially updates a shared modifier option with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-modifier-options/patchsharedmodifieroption","routeSlug":"/apis/commerce/commerce-v1/shared-modifier-options/patchsharedmodifieroption","metadata":{"seo":{"title":"Partially updates a shared modifier option with the specified ID.","description":"This method will patch an existing shared modifier option with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/sharedModifierOptions/{tenantId}/{id}"},{"label":"Updates a shared modifier option with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-modifier-options/updatesharedmodifieroption","routeSlug":"/apis/commerce/commerce-v1/shared-modifier-options/updatesharedmodifieroption","metadata":{"seo":{"title":"Updates a shared modifier option with the specified ID.","description":"This method will update an existing shared modifier option with the specified ID."}},"httpPath":"/sharedModifierOptions/{tenantId}/{id}"}]},{"type":"group","label":"Shared Variant Options","link":"/apis/commerce/commerce-v1/shared-variant-options","routeSlug":"/apis/commerce/commerce-v1/shared-variant-options","items":[{"label":"Gets all of the shared variant options in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-variant-options/listsharedvariantoptions","routeSlug":"/apis/commerce/commerce-v1/shared-variant-options/listsharedvariantoptions","metadata":{"seo":{"title":"Gets all of the shared variant options in the system.","description":"This method will scan all shared variant options and and return them to the caller."}},"httpPath":"/sharedVariantOptions/{tenantId}"},{"label":"Creates a new shared variant option record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-variant-options/createsharedvariantoption","routeSlug":"/apis/commerce/commerce-v1/shared-variant-options/createsharedvariantoption","metadata":{"seo":{"title":"Creates a new shared variant option record that does not already exist.","description":"This method will auto-generate an ID and create a new shared variant option. If an ID is specified for the shared variant option, an error will be thrown."}},"httpPath":"/sharedVariantOptions/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-variant-options/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/shared-variant-options/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/sharedVariantOptions/{tenantId}/batch"},{"label":"Returns a shared variant option from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-variant-options/deletesharedvariantoption","routeSlug":"/apis/commerce/commerce-v1/shared-variant-options/deletesharedvariantoption","metadata":{"seo":{"title":"Returns a shared variant option from the system by its ID.","description":"This method will delete a shared variant option with the specified ID."}},"httpPath":"/sharedVariantOptions/{tenantId}/{id}"},{"label":"Returns a shared variant option from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-variant-options/getsharedvariantoption","routeSlug":"/apis/commerce/commerce-v1/shared-variant-options/getsharedvariantoption","metadata":{"seo":{"title":"Returns a shared variant option from the system by its ID.","description":"This method will look up a shared variant option by the specified ID and return it back."}},"httpPath":"/sharedVariantOptions/{tenantId}/{id}"},{"label":"Partially updates a shared variant option with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-variant-options/patchsharedvariantoption","routeSlug":"/apis/commerce/commerce-v1/shared-variant-options/patchsharedvariantoption","metadata":{"seo":{"title":"Partially updates a shared variant option with the specified ID.","description":"This method will patch an existing shared variant option with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/sharedVariantOptions/{tenantId}/{id}"},{"label":"Updates a shared variant option with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shared-variant-options/updatesharedvariantoption","routeSlug":"/apis/commerce/commerce-v1/shared-variant-options/updatesharedvariantoption","metadata":{"seo":{"title":"Updates a shared variant option with the specified ID.","description":"This method will update an existing shared variant option with the specified ID."}},"httpPath":"/sharedVariantOptions/{tenantId}/{id}"}]},{"type":"group","label":"Shipments","link":"/apis/commerce/commerce-v1/shipments","routeSlug":"/apis/commerce/commerce-v1/shipments","items":[{"label":"Initiates workflow to warm up inventory transactions","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipments/warmupstepfunctions","routeSlug":"/apis/commerce/commerce-v1/shipments/warmupstepfunctions","metadata":{"seo":{"title":"Initiates workflow to warm up inventory transactions","description":"Initiates workflow to warm up inventory transactions"}},"httpPath":"/shipments/warmUpStepFunctions"},{"label":"Processes a shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipments/processshipment","routeSlug":"/apis/commerce/commerce-v1/shipments/processshipment","metadata":{"seo":{"title":"Processes a shipment","description":"This method will auto-generate an ID and create a new shipment. If an ID is specified for the shipment, an error will be thrown."}},"httpPath":"/shipments/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipments/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/shipments/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/shipments/{tenantId}/batch"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipments/listshipmentsbyorderid","routeSlug":"/apis/commerce/commerce-v1/shipments/listshipmentsbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"httpPath":"/shipments/{tenantId}/order/{order_id}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipments/previewemail","routeSlug":"/apis/commerce/commerce-v1/shipments/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/shipments/{tenantId}/previewEmail"},{"label":"Gets all of the shipments in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipments/listshipments","routeSlug":"/apis/commerce/commerce-v1/shipments/listshipments","metadata":{"seo":{"title":"Gets all of the shipments in the system.","description":"This method will scan all shipments and and return them to the caller."}},"httpPath":"/shipments/{tenantId}/sync"},{"label":"Processes a shipment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipments/processshipmentsync","routeSlug":"/apis/commerce/commerce-v1/shipments/processshipmentsync","metadata":{"seo":{"title":"Processes a shipment","description":"This method will auto-generate an ID and create a new shipment. If an ID is specified for the shipment, an error will be thrown."}},"httpPath":"/shipments/{tenantId}/sync"},{"label":"Returns a shipment from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipments/deleteshipment","routeSlug":"/apis/commerce/commerce-v1/shipments/deleteshipment","metadata":{"seo":{"title":"Returns a shipment from the system by its ID.","description":"This method will delete a shipment with the specified ID."}},"httpPath":"/shipments/{tenantId}/{id}"},{"label":"Returns a shipment from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipments/getshipment","routeSlug":"/apis/commerce/commerce-v1/shipments/getshipment","metadata":{"seo":{"title":"Returns a shipment from the system by its ID.","description":"This method will look up a shipment by the specified ID and return it back."}},"httpPath":"/shipments/{tenantId}/{id}"},{"label":"Partially updates a shipment with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipments/patchshipment","routeSlug":"/apis/commerce/commerce-v1/shipments/patchshipment","metadata":{"seo":{"title":"Partially updates a shipment with the specified ID.","description":"This method will patch an existing shipment with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/shipments/{tenantId}/{id}"},{"label":"Updates a shipment with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipments/updateshipment","routeSlug":"/apis/commerce/commerce-v1/shipments/updateshipment","metadata":{"seo":{"title":"Updates a shipment with the specified ID.","description":"This method will update an existing shipment with the specified ID."}},"httpPath":"/shipments/{tenantId}/{id}"}]},{"type":"group","label":"Shipping Configurations","link":"/apis/commerce/commerce-v1/shipping-configurations","routeSlug":"/apis/commerce/commerce-v1/shipping-configurations","items":[{"label":"Returns a shipping configuration from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-configurations/deleteshippingconfiguration","routeSlug":"/apis/commerce/commerce-v1/shipping-configurations/deleteshippingconfiguration","metadata":{"seo":{"title":"Returns a shipping configuration from the system by its ID.","description":"This method will delete a shipping configuration with the specified ID."}},"httpPath":"/shippingConfigurations/{tenantId}"},{"label":"Returns a shipping configuration from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-configurations/getshippingconfiguration","routeSlug":"/apis/commerce/commerce-v1/shipping-configurations/getshippingconfiguration","metadata":{"seo":{"title":"Returns a shipping configuration from the system by its ID.","description":"This method will look up a shipping configuration by the specified ID and return it back."}},"httpPath":"/shippingConfigurations/{tenantId}"},{"label":"Partially updates a shipping configuration with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-configurations/patchshippingconfiguration","routeSlug":"/apis/commerce/commerce-v1/shipping-configurations/patchshippingconfiguration","metadata":{"seo":{"title":"Partially updates a shipping configuration with the specified ID.","description":"This method will patch an existing shipping configuration with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/shippingConfigurations/{tenantId}"},{"label":"Creates a new shipping configuration record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-configurations/createshippingconfiguration","routeSlug":"/apis/commerce/commerce-v1/shipping-configurations/createshippingconfiguration","metadata":{"seo":{"title":"Creates a new shipping configuration record that does not already exist.","description":"This method will auto-generate an ID and create a new shipping configuration. If an ID is specified for the shipping configuration, an error will be thrown."}},"httpPath":"/shippingConfigurations/{tenantId}"},{"label":"Updates a shipping configuration with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-configurations/updateshippingconfiguration","routeSlug":"/apis/commerce/commerce-v1/shipping-configurations/updateshippingconfiguration","metadata":{"seo":{"title":"Updates a shipping configuration with the specified ID.","description":"This method will update an existing shipping configuration with the specified ID."}},"httpPath":"/shippingConfigurations/{tenantId}"}]},{"type":"group","label":"Shipping Products","link":"/apis/commerce/commerce-v1/shipping-products","routeSlug":"/apis/commerce/commerce-v1/shipping-products","items":[{"label":"Gets all of the shipping products in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-products/listshippingproducts","routeSlug":"/apis/commerce/commerce-v1/shipping-products/listshippingproducts","metadata":{"seo":{"title":"Gets all of the shipping products in the system.","description":"This method will scan all shipping products and and return them to the caller."}},"httpPath":"/shippingProducts/{tenantId}"},{"label":"Creates a new shipping product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-products/createshippingproduct","routeSlug":"/apis/commerce/commerce-v1/shipping-products/createshippingproduct","metadata":{"seo":{"title":"Creates a new shipping product record that does not already exist.","description":"This method will auto-generate an ID and create a new shipping product. If an ID is specified for the shipping product, an error will be thrown."}},"httpPath":"/shippingProducts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-products/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/shipping-products/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/shippingProducts/{tenantId}/batch"},{"label":"Returns a shipping product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-products/deleteshippingproduct","routeSlug":"/apis/commerce/commerce-v1/shipping-products/deleteshippingproduct","metadata":{"seo":{"title":"Returns a shipping product from the system by its ID.","description":"This method will delete a shipping product with the specified ID."}},"httpPath":"/shippingProducts/{tenantId}/{id}"},{"label":"Returns a shipping product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-products/getshippingproduct","routeSlug":"/apis/commerce/commerce-v1/shipping-products/getshippingproduct","metadata":{"seo":{"title":"Returns a shipping product from the system by its ID.","description":"This method will look up a shipping product by the specified ID and return it back."}},"httpPath":"/shippingProducts/{tenantId}/{id}"},{"label":"Partially updates a shipping product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-products/patchshippingproduct","routeSlug":"/apis/commerce/commerce-v1/shipping-products/patchshippingproduct","metadata":{"seo":{"title":"Partially updates a shipping product with the specified ID.","description":"This method will patch an existing shipping product with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/shippingProducts/{tenantId}/{id}"},{"label":"Updates a shipping product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/shipping-products/updateshippingproduct","routeSlug":"/apis/commerce/commerce-v1/shipping-products/updateshippingproduct","metadata":{"seo":{"title":"Updates a shipping product with the specified ID.","description":"This method will update an existing shipping product with the specified ID."}},"httpPath":"/shippingProducts/{tenantId}/{id}"}]},{"type":"group","label":"Statistics","link":"/apis/commerce/commerce-v1/statistics","routeSlug":"/apis/commerce/commerce-v1/statistics","items":[{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/statistics/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/statistics/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/statistics/{tenantId}/batch"},{"label":"Returns a statistic from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/statistics/getstatistic","routeSlug":"/apis/commerce/commerce-v1/statistics/getstatistic","metadata":{"seo":{"title":"Returns a statistic from the system by its ID.","description":"This method will look up a statistic by the specified ID and return it back."}},"httpPath":"/statistics/{tenantId}/{id}"}]},{"type":"group","label":"Stores","link":"/apis/commerce/commerce-v1/stores","routeSlug":"/apis/commerce/commerce-v1/stores","items":[{"label":"Gets all of the stores in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/stores/liststores","routeSlug":"/apis/commerce/commerce-v1/stores/liststores","metadata":{"seo":{"title":"Gets all of the stores in the system.","description":"This method will scan all stores and and return them to the caller."}},"httpPath":"/stores/{tenantId}"},{"label":"Creates a new store record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/stores/createstore","routeSlug":"/apis/commerce/commerce-v1/stores/createstore","metadata":{"seo":{"title":"Creates a new store record that does not already exist.","description":"This method will auto-generate an ID and create a new store. If an ID is specified for the store, an error will be thrown."}},"httpPath":"/stores/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/stores/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/stores/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/stores/{tenantId}/batch"},{"label":"Gets the public store info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/stores/getpublicstoreinfo","routeSlug":"/apis/commerce/commerce-v1/stores/getpublicstoreinfo","metadata":{"seo":{"title":"Gets the public store info","description":"Gets the public store info"}},"httpPath":"/stores/{tenantId}/public/{id}"},{"label":"Returns a store from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/stores/deletestore","routeSlug":"/apis/commerce/commerce-v1/stores/deletestore","metadata":{"seo":{"title":"Returns a store from the system by its ID.","description":"This method will delete a store with the specified ID."}},"httpPath":"/stores/{tenantId}/{id}"},{"label":"Returns a store from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/stores/getstore","routeSlug":"/apis/commerce/commerce-v1/stores/getstore","metadata":{"seo":{"title":"Returns a store from the system by its ID.","description":"This method will look up a store by the specified ID and return it back."}},"httpPath":"/stores/{tenantId}/{id}"},{"label":"Partially updates a store with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/stores/patchstore","routeSlug":"/apis/commerce/commerce-v1/stores/patchstore","metadata":{"seo":{"title":"Partially updates a store with the specified ID.","description":"This method will patch an existing store with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/stores/{tenantId}/{id}"},{"label":"Updates a store with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/stores/updatestore","routeSlug":"/apis/commerce/commerce-v1/stores/updatestore","metadata":{"seo":{"title":"Updates a store with the specified ID.","description":"This method will update an existing store with the specified ID."}},"httpPath":"/stores/{tenantId}/{id}"}]},{"type":"group","label":"Tax Classes","link":"/apis/commerce/commerce-v1/tax-classes","routeSlug":"/apis/commerce/commerce-v1/tax-classes","items":[{"label":"Gets all of the tax classes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-classes/listtaxclasses","routeSlug":"/apis/commerce/commerce-v1/tax-classes/listtaxclasses","metadata":{"seo":{"title":"Gets all of the tax classes in the system.","description":"This method will scan all tax classes and and return them to the caller."}},"httpPath":"/taxClasses/{tenantId}"},{"label":"Creates a new tax class record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-classes/createtaxclass","routeSlug":"/apis/commerce/commerce-v1/tax-classes/createtaxclass","metadata":{"seo":{"title":"Creates a new tax class record that does not already exist.","description":"This method will auto-generate an ID and create a new tax class. If an ID is specified for the tax class, an error will be thrown."}},"httpPath":"/taxClasses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-classes/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/tax-classes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/taxClasses/{tenantId}/batch"},{"label":"Returns a tax class from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-classes/deletetaxclass","routeSlug":"/apis/commerce/commerce-v1/tax-classes/deletetaxclass","metadata":{"seo":{"title":"Returns a tax class from the system by its ID.","description":"This method will delete a tax class with the specified ID."}},"httpPath":"/taxClasses/{tenantId}/{id}"},{"label":"Returns a tax class from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-classes/gettaxclass","routeSlug":"/apis/commerce/commerce-v1/tax-classes/gettaxclass","metadata":{"seo":{"title":"Returns a tax class from the system by its ID.","description":"This method will look up a tax class by the specified ID and return it back."}},"httpPath":"/taxClasses/{tenantId}/{id}"},{"label":"Partially updates a tax class with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-classes/patchtaxclass","routeSlug":"/apis/commerce/commerce-v1/tax-classes/patchtaxclass","metadata":{"seo":{"title":"Partially updates a tax class with the specified ID.","description":"This method will patch an existing tax class with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/taxClasses/{tenantId}/{id}"},{"label":"Updates a tax class with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-classes/updatetaxclass","routeSlug":"/apis/commerce/commerce-v1/tax-classes/updatetaxclass","metadata":{"seo":{"title":"Updates a tax class with the specified ID.","description":"This method will update an existing tax class with the specified ID."}},"httpPath":"/taxClasses/{tenantId}/{id}"}]},{"type":"group","label":"Tax Configurations","link":"/apis/commerce/commerce-v1/tax-configurations","routeSlug":"/apis/commerce/commerce-v1/tax-configurations","items":[{"label":"Returns a tax configuration from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-configurations/deletetaxconfiguration","routeSlug":"/apis/commerce/commerce-v1/tax-configurations/deletetaxconfiguration","metadata":{"seo":{"title":"Returns a tax configuration from the system by its ID.","description":"This method will delete a tax configuration with the specified ID."}},"httpPath":"/taxConfigurations/{tenantId}"},{"label":"Returns a tax configuration from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-configurations/gettaxconfiguration","routeSlug":"/apis/commerce/commerce-v1/tax-configurations/gettaxconfiguration","metadata":{"seo":{"title":"Returns a tax configuration from the system by its ID.","description":"This method will look up a tax configuration by the specified ID and return it back."}},"httpPath":"/taxConfigurations/{tenantId}"},{"label":"Partially updates a tax configuration with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-configurations/patchtaxconfiguration","routeSlug":"/apis/commerce/commerce-v1/tax-configurations/patchtaxconfiguration","metadata":{"seo":{"title":"Partially updates a tax configuration with the specified ID.","description":"This method will patch an existing tax configuration with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/taxConfigurations/{tenantId}"},{"label":"Creates a new tax configuration record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-configurations/createtaxconfiguration","routeSlug":"/apis/commerce/commerce-v1/tax-configurations/createtaxconfiguration","metadata":{"seo":{"title":"Creates a new tax configuration record that does not already exist.","description":"This method will auto-generate an ID and create a new tax configuration. If an ID is specified for the tax configuration, an error will be thrown."}},"httpPath":"/taxConfigurations/{tenantId}"},{"label":"Updates a tax configuration with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-configurations/updatetaxconfiguration","routeSlug":"/apis/commerce/commerce-v1/tax-configurations/updatetaxconfiguration","metadata":{"seo":{"title":"Updates a tax configuration with the specified ID.","description":"This method will update an existing tax configuration with the specified ID."}},"httpPath":"/taxConfigurations/{tenantId}"}]},{"type":"group","label":"Tax Products","link":"/apis/commerce/commerce-v1/tax-products","routeSlug":"/apis/commerce/commerce-v1/tax-products","items":[{"label":"Gets all of the tax products in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-products/listtaxproducts","routeSlug":"/apis/commerce/commerce-v1/tax-products/listtaxproducts","metadata":{"seo":{"title":"Gets all of the tax products in the system.","description":"This method will scan all tax products and and return them to the caller."}},"httpPath":"/taxProducts/{tenantId}"},{"label":"Creates a new tax product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-products/createtaxproduct","routeSlug":"/apis/commerce/commerce-v1/tax-products/createtaxproduct","metadata":{"seo":{"title":"Creates a new tax product record that does not already exist.","description":"This method will auto-generate an ID and create a new tax product. If an ID is specified for the tax product, an error will be thrown."}},"httpPath":"/taxProducts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-products/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/tax-products/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/taxProducts/{tenantId}/batch"},{"label":"Returns a tax product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-products/deletetaxproduct","routeSlug":"/apis/commerce/commerce-v1/tax-products/deletetaxproduct","metadata":{"seo":{"title":"Returns a tax product from the system by its ID.","description":"This method will delete a tax product with the specified ID."}},"httpPath":"/taxProducts/{tenantId}/{id}"},{"label":"Returns a tax product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-products/gettaxproduct","routeSlug":"/apis/commerce/commerce-v1/tax-products/gettaxproduct","metadata":{"seo":{"title":"Returns a tax product from the system by its ID.","description":"This method will look up a tax product by the specified ID and return it back."}},"httpPath":"/taxProducts/{tenantId}/{id}"},{"label":"Partially updates a tax product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-products/patchtaxproduct","routeSlug":"/apis/commerce/commerce-v1/tax-products/patchtaxproduct","metadata":{"seo":{"title":"Partially updates a tax product with the specified ID.","description":"This method will patch an existing tax product with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/taxProducts/{tenantId}/{id}"},{"label":"Updates a tax product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/tax-products/updatetaxproduct","routeSlug":"/apis/commerce/commerce-v1/tax-products/updatetaxproduct","metadata":{"seo":{"title":"Updates a tax product with the specified ID.","description":"This method will update an existing tax product with the specified ID."}},"httpPath":"/taxProducts/{tenantId}/{id}"}]},{"type":"group","label":"Warehouse Bins","link":"/apis/commerce/commerce-v1/warehouse-bins","routeSlug":"/apis/commerce/commerce-v1/warehouse-bins","items":[{"label":"Gets all of the warehouse bins in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouse-bins/listwarehousebins","routeSlug":"/apis/commerce/commerce-v1/warehouse-bins/listwarehousebins","metadata":{"seo":{"title":"Gets all of the warehouse bins in the system.","description":"This method will scan all warehouse bins and and return them to the caller."}},"httpPath":"/warehouseBins/{tenantId}"},{"label":"Creates a new warehouse bin record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouse-bins/createwarehousebin","routeSlug":"/apis/commerce/commerce-v1/warehouse-bins/createwarehousebin","metadata":{"seo":{"title":"Creates a new warehouse bin record that does not already exist.","description":"This method will auto-generate an ID and create a new warehouse bin. If an ID is specified for the warehouse bin, an error will be thrown."}},"httpPath":"/warehouseBins/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouse-bins/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/warehouse-bins/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/warehouseBins/{tenantId}/batch"},{"label":"Returns a warehouse bin from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouse-bins/deletewarehousebin","routeSlug":"/apis/commerce/commerce-v1/warehouse-bins/deletewarehousebin","metadata":{"seo":{"title":"Returns a warehouse bin from the system by its ID.","description":"This method will delete a warehouse bin with the specified ID."}},"httpPath":"/warehouseBins/{tenantId}/{id}"},{"label":"Returns a warehouse bin from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouse-bins/getwarehousebin","routeSlug":"/apis/commerce/commerce-v1/warehouse-bins/getwarehousebin","metadata":{"seo":{"title":"Returns a warehouse bin from the system by its ID.","description":"This method will look up a warehouse bin by the specified ID and return it back."}},"httpPath":"/warehouseBins/{tenantId}/{id}"},{"label":"Partially updates a warehouse bin with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouse-bins/patchwarehousebin","routeSlug":"/apis/commerce/commerce-v1/warehouse-bins/patchwarehousebin","metadata":{"seo":{"title":"Partially updates a warehouse bin with the specified ID.","description":"This method will patch an existing warehouse bin with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/warehouseBins/{tenantId}/{id}"},{"label":"Updates a warehouse bin with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouse-bins/updatewarehousebin","routeSlug":"/apis/commerce/commerce-v1/warehouse-bins/updatewarehousebin","metadata":{"seo":{"title":"Updates a warehouse bin with the specified ID.","description":"This method will update an existing warehouse bin with the specified ID."}},"httpPath":"/warehouseBins/{tenantId}/{id}"}]},{"type":"group","label":"Warehouses","link":"/apis/commerce/commerce-v1/warehouses","routeSlug":"/apis/commerce/commerce-v1/warehouses","items":[{"label":"Gets all of the warehouses in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouses/listwarehouses","routeSlug":"/apis/commerce/commerce-v1/warehouses/listwarehouses","metadata":{"seo":{"title":"Gets all of the warehouses in the system.","description":"This method will scan all warehouses and and return them to the caller."}},"httpPath":"/warehouses/{tenantId}"},{"label":"Creates a new warehouse record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouses/createwarehouse","routeSlug":"/apis/commerce/commerce-v1/warehouses/createwarehouse","metadata":{"seo":{"title":"Creates a new warehouse record that does not already exist.","description":"This method will auto-generate an ID and create a new warehouse. If an ID is specified for the warehouse, an error will be thrown."}},"httpPath":"/warehouses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouses/executebatchoperations","routeSlug":"/apis/commerce/commerce-v1/warehouses/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/warehouses/{tenantId}/batch"},{"label":"Returns a warehouse from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouses/deletewarehouse","routeSlug":"/apis/commerce/commerce-v1/warehouses/deletewarehouse","metadata":{"seo":{"title":"Returns a warehouse from the system by its ID.","description":"This method will delete a warehouse with the specified ID."}},"httpPath":"/warehouses/{tenantId}/{id}"},{"label":"Returns a warehouse from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouses/getwarehouse","routeSlug":"/apis/commerce/commerce-v1/warehouses/getwarehouse","metadata":{"seo":{"title":"Returns a warehouse from the system by its ID.","description":"This method will look up a warehouse by the specified ID and return it back."}},"httpPath":"/warehouses/{tenantId}/{id}"},{"label":"Partially updates a warehouse with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouses/patchwarehouse","routeSlug":"/apis/commerce/commerce-v1/warehouses/patchwarehouse","metadata":{"seo":{"title":"Partially updates a warehouse with the specified ID.","description":"This method will patch an existing warehouse with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/warehouses/{tenantId}/{id}"},{"label":"Updates a warehouse with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/commerce/commerce-v1/warehouses/updatewarehouse","routeSlug":"/apis/commerce/commerce-v1/warehouses/updatewarehouse","metadata":{"seo":{"title":"Updates a warehouse with the specified ID.","description":"This method will update an existing warehouse with the specified ID."}},"httpPath":"/warehouses/{tenantId}/{id}"}]}]},{"type":"group","label":"Committees","items":[{"type":"link","label":"Committees","link":"/apis/committees/committees-v1","routeSlug":"/apis/committees/committees-v1"},{"type":"group","label":"Committees","link":"/apis/committees/committees-v1/committees","routeSlug":"/apis/committees/committees-v1/committees","items":[{"label":"Returns a list of records with the specified tenant_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/committees/listcommitteesbytenantid","routeSlug":"/apis/committees/committees-v1/committees/listcommitteesbytenantid","metadata":{"seo":{"title":"Returns a list of records with the specified tenant_id","description":"Returns a list of records with the specified tenant_id"}},"httpPath":"/committees/{tenantId}"},{"label":"Creates a new committee record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/committees/createcommittee","routeSlug":"/apis/committees/committees-v1/committees/createcommittee","metadata":{"seo":{"title":"Creates a new committee record that does not already exist.","description":"This method will auto-generate an ID and create a new committee. If an ID is specified for the committee, an error will be thrown."}},"httpPath":"/committees/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/committees/executebatchoperations","routeSlug":"/apis/committees/committees-v1/committees/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/committees/{tenantId}/batch"},{"label":"Returns a list of records with the specified chapter_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/committees/listcommitteesbychapterid","routeSlug":"/apis/committees/committees-v1/committees/listcommitteesbychapterid","metadata":{"seo":{"title":"Returns a list of records with the specified chapter_id","description":"Returns a list of records with the specified chapter_id"}},"httpPath":"/committees/{tenantId}/chapter/{chapter_id}"},{"label":"Returns a list of records with the specified parent_committee_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/committees/listcommitteesbyparentcommitteeid","routeSlug":"/apis/committees/committees-v1/committees/listcommitteesbyparentcommitteeid","metadata":{"seo":{"title":"Returns a list of records with the specified parent_committee_id","description":"Returns a list of records with the specified parent_committee_id"}},"httpPath":"/committees/{tenantId}/parentCommittee/{parent_committee_id}"},{"label":"Searches for committees using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/committees/searchforcommittees","routeSlug":"/apis/committees/committees-v1/committees/searchforcommittees","metadata":{"seo":{"title":"Searches for committees using predefined parameters","description":"Searches for committees using predefined parameters"}},"httpPath":"/committees/{tenantId}/search"},{"label":"Returns a list of records with the specified section_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/committees/listcommitteesbysectionid","routeSlug":"/apis/committees/committees-v1/committees/listcommitteesbysectionid","metadata":{"seo":{"title":"Returns a list of records with the specified section_id","description":"Returns a list of records with the specified section_id"}},"httpPath":"/committees/{tenantId}/section/{section_id}"},{"label":"Returns a committee from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/committees/deletecommittee","routeSlug":"/apis/committees/committees-v1/committees/deletecommittee","metadata":{"seo":{"title":"Returns a committee from the system by its ID.","description":"This method will delete a committee with the specified ID."}},"httpPath":"/committees/{tenantId}/{id}"},{"label":"Returns a committee from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/committees/getcommittee","routeSlug":"/apis/committees/committees-v1/committees/getcommittee","metadata":{"seo":{"title":"Returns a committee from the system by its ID.","description":"This method will look up a committee by the specified ID and return it back."}},"httpPath":"/committees/{tenantId}/{id}"},{"label":"Partially updates a committee with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/committees/patchcommittee","routeSlug":"/apis/committees/committees-v1/committees/patchcommittee","metadata":{"seo":{"title":"Partially updates a committee with the specified ID.","description":"This method will patch an existing committee with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/committees/{tenantId}/{id}"},{"label":"Updates a committee with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/committees/updatecommittee","routeSlug":"/apis/committees/committees-v1/committees/updatecommittee","metadata":{"seo":{"title":"Updates a committee with the specified ID.","description":"This method will update an existing committee with the specified ID."}},"httpPath":"/committees/{tenantId}/{id}"}]},{"type":"group","label":"Memberships","link":"/apis/committees/committees-v1/memberships","routeSlug":"/apis/committees/committees-v1/memberships","items":[{"label":"Creates a new membership record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/memberships/createmembership","routeSlug":"/apis/committees/committees-v1/memberships/createmembership","metadata":{"seo":{"title":"Creates a new membership record that does not already exist.","description":"This method will auto-generate an ID and create a new membership. If an ID is specified for the membership, an error will be thrown."}},"httpPath":"/memberships/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/memberships/executebatchoperations","routeSlug":"/apis/committees/committees-v1/memberships/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/memberships/{tenantId}/batch"},{"label":"Returns a list of records with the specified committee_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/memberships/listmembershipsbycommitteeid","routeSlug":"/apis/committees/committees-v1/memberships/listmembershipsbycommitteeid","metadata":{"seo":{"title":"Returns a list of records with the specified committee_id","description":"Returns a list of records with the specified committee_id"}},"httpPath":"/memberships/{tenantId}/committee/{committee_id}"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/memberships/listmembershipsbycontactid","routeSlug":"/apis/committees/committees-v1/memberships/listmembershipsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/memberships/{tenantId}/contact/{contact_id}"},{"label":"Returns a membership from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/memberships/deletemembership","routeSlug":"/apis/committees/committees-v1/memberships/deletemembership","metadata":{"seo":{"title":"Returns a membership from the system by its ID.","description":"This method will delete a membership with the specified ID."}},"httpPath":"/memberships/{tenantId}/{id}"},{"label":"Returns a membership from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/memberships/getmembership","routeSlug":"/apis/committees/committees-v1/memberships/getmembership","metadata":{"seo":{"title":"Returns a membership from the system by its ID.","description":"This method will look up a membership by the specified ID and return it back."}},"httpPath":"/memberships/{tenantId}/{id}"},{"label":"Partially updates a membership with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/memberships/patchmembership","routeSlug":"/apis/committees/committees-v1/memberships/patchmembership","metadata":{"seo":{"title":"Partially updates a membership with the specified ID.","description":"This method will patch an existing membership with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/memberships/{tenantId}/{id}"},{"label":"Updates a membership with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/memberships/updatemembership","routeSlug":"/apis/committees/committees-v1/memberships/updatemembership","metadata":{"seo":{"title":"Updates a membership with the specified ID.","description":"This method will update an existing membership with the specified ID."}},"httpPath":"/memberships/{tenantId}/{id}"}]},{"type":"group","label":"Nominations","link":"/apis/committees/committees-v1/nominations","routeSlug":"/apis/committees/committees-v1/nominations","items":[{"label":"Creates a new nomination record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/nominations/createnomination","routeSlug":"/apis/committees/committees-v1/nominations/createnomination","metadata":{"seo":{"title":"Creates a new nomination record that does not already exist.","description":"This method will auto-generate an ID and create a new nomination. If an ID is specified for the nomination, an error will be thrown."}},"httpPath":"/nominations/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/nominations/executebatchoperations","routeSlug":"/apis/committees/committees-v1/nominations/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/nominations/{tenantId}/batch"},{"label":"Returns a nomination from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/nominations/deletenomination","routeSlug":"/apis/committees/committees-v1/nominations/deletenomination","metadata":{"seo":{"title":"Returns a nomination from the system by its ID.","description":"This method will delete a nomination with the specified ID."}},"httpPath":"/nominations/{tenantId}/{id}"},{"label":"Returns a nomination from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/nominations/getnomination","routeSlug":"/apis/committees/committees-v1/nominations/getnomination","metadata":{"seo":{"title":"Returns a nomination from the system by its ID.","description":"This method will look up a nomination by the specified ID and return it back."}},"httpPath":"/nominations/{tenantId}/{id}"},{"label":"Partially updates a nomination with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/nominations/patchnomination","routeSlug":"/apis/committees/committees-v1/nominations/patchnomination","metadata":{"seo":{"title":"Partially updates a nomination with the specified ID.","description":"This method will patch an existing nomination with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/nominations/{tenantId}/{id}"},{"label":"Updates a nomination with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/nominations/updatenomination","routeSlug":"/apis/committees/committees-v1/nominations/updatenomination","metadata":{"seo":{"title":"Updates a nomination with the specified ID.","description":"This method will update an existing nomination with the specified ID."}},"httpPath":"/nominations/{tenantId}/{id}"}]},{"type":"group","label":"Positions","link":"/apis/committees/committees-v1/positions","routeSlug":"/apis/committees/committees-v1/positions","items":[{"label":"Gets all of the positions in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/positions/listpositions","routeSlug":"/apis/committees/committees-v1/positions/listpositions","metadata":{"seo":{"title":"Gets all of the positions in the system.","description":"This method will scan all positions and and return them to the caller."}},"httpPath":"/positions/{tenantId}"},{"label":"Creates a new position record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/positions/createposition","routeSlug":"/apis/committees/committees-v1/positions/createposition","metadata":{"seo":{"title":"Creates a new position record that does not already exist.","description":"This method will auto-generate an ID and create a new position. If an ID is specified for the position, an error will be thrown."}},"httpPath":"/positions/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/positions/executebatchoperations","routeSlug":"/apis/committees/committees-v1/positions/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/positions/{tenantId}/batch"},{"label":"Returns a position from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/positions/deleteposition","routeSlug":"/apis/committees/committees-v1/positions/deleteposition","metadata":{"seo":{"title":"Returns a position from the system by its ID.","description":"This method will delete a position with the specified ID."}},"httpPath":"/positions/{tenantId}/{id}"},{"label":"Returns a position from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/positions/getposition","routeSlug":"/apis/committees/committees-v1/positions/getposition","metadata":{"seo":{"title":"Returns a position from the system by its ID.","description":"This method will look up a position by the specified ID and return it back."}},"httpPath":"/positions/{tenantId}/{id}"},{"label":"Partially updates a position with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/positions/patchposition","routeSlug":"/apis/committees/committees-v1/positions/patchposition","metadata":{"seo":{"title":"Partially updates a position with the specified ID.","description":"This method will patch an existing position with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/positions/{tenantId}/{id}"},{"label":"Updates a position with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/positions/updateposition","routeSlug":"/apis/committees/committees-v1/positions/updateposition","metadata":{"seo":{"title":"Updates a position with the specified ID.","description":"This method will update an existing position with the specified ID."}},"httpPath":"/positions/{tenantId}/{id}"}]},{"type":"group","label":"Types","link":"/apis/committees/committees-v1/types","routeSlug":"/apis/committees/committees-v1/types","items":[{"label":"Gets all of the types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/types/listtypes","routeSlug":"/apis/committees/committees-v1/types/listtypes","metadata":{"seo":{"title":"Gets all of the types in the system.","description":"This method will scan all types and and return them to the caller."}},"httpPath":"/types/{tenantId}"},{"label":"Creates a new type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/types/createtype","routeSlug":"/apis/committees/committees-v1/types/createtype","metadata":{"seo":{"title":"Creates a new type record that does not already exist.","description":"This method will auto-generate an ID and create a new type. If an ID is specified for the type, an error will be thrown."}},"httpPath":"/types/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/types/executebatchoperations","routeSlug":"/apis/committees/committees-v1/types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/types/{tenantId}/batch"},{"label":"Returns a type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/types/deletetype","routeSlug":"/apis/committees/committees-v1/types/deletetype","metadata":{"seo":{"title":"Returns a type from the system by its ID.","description":"This method will delete a type with the specified ID."}},"httpPath":"/types/{tenantId}/{id}"},{"label":"Returns a type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/types/gettype","routeSlug":"/apis/committees/committees-v1/types/gettype","metadata":{"seo":{"title":"Returns a type from the system by its ID.","description":"This method will look up a type by the specified ID and return it back."}},"httpPath":"/types/{tenantId}/{id}"},{"label":"Partially updates a type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/types/patchtype","routeSlug":"/apis/committees/committees-v1/types/patchtype","metadata":{"seo":{"title":"Partially updates a type with the specified ID.","description":"This method will patch an existing type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/types/{tenantId}/{id}"},{"label":"Updates a type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/committees/committees-v1/types/updatetype","routeSlug":"/apis/committees/committees-v1/types/updatetype","metadata":{"seo":{"title":"Updates a type with the specified ID.","description":"This method will update an existing type with the specified ID."}},"httpPath":"/types/{tenantId}/{id}"}]}]},{"type":"group","label":"Events","items":[{"type":"link","label":"Events (Meetings & Shows)","link":"/apis/events/events-v1","routeSlug":"/apis/events/events-v1"},{"type":"group","label":"Abstract Approval Processes","link":"/apis/events/events-v1/abstract-approval-processes","routeSlug":"/apis/events/events-v1/abstract-approval-processes","items":[{"label":"Creates a new abstract approval process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-approval-processes/createabstractapprovalprocess","routeSlug":"/apis/events/events-v1/abstract-approval-processes/createabstractapprovalprocess","metadata":{"seo":{"title":"Creates a new abstract approval process record that does not already exist.","description":"This method will auto-generate an ID and create a new abstract approval process. If an ID is specified for the abstract approval process, an error will be thrown."}},"httpPath":"/abstractApprovalProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-approval-processes/executebatchoperations","routeSlug":"/apis/events/events-v1/abstract-approval-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/abstractApprovalProcesses/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-approval-processes/listprocessesbyeventid","routeSlug":"/apis/events/events-v1/abstract-approval-processes/listprocessesbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/abstractApprovalProcesses/{tenantId}/event/{event_id}"},{"label":"Returns a abstract approval process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-approval-processes/deleteabstractapprovalprocess","routeSlug":"/apis/events/events-v1/abstract-approval-processes/deleteabstractapprovalprocess","metadata":{"seo":{"title":"Returns a abstract approval process from the system by its ID.","description":"This method will delete a abstract approval process with the specified ID."}},"httpPath":"/abstractApprovalProcesses/{tenantId}/{id}"},{"label":"Returns a abstract approval process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-approval-processes/getabstractapprovalprocess","routeSlug":"/apis/events/events-v1/abstract-approval-processes/getabstractapprovalprocess","metadata":{"seo":{"title":"Returns a abstract approval process from the system by its ID.","description":"This method will look up a abstract approval process by the specified ID and return it back."}},"httpPath":"/abstractApprovalProcesses/{tenantId}/{id}"},{"label":"Partially updates a abstract approval process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-approval-processes/patchabstractapprovalprocess","routeSlug":"/apis/events/events-v1/abstract-approval-processes/patchabstractapprovalprocess","metadata":{"seo":{"title":"Partially updates a abstract approval process with the specified ID.","description":"This method will patch an existing abstract approval process with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/abstractApprovalProcesses/{tenantId}/{id}"},{"label":"Updates a abstract approval process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-approval-processes/updateabstractapprovalprocess","routeSlug":"/apis/events/events-v1/abstract-approval-processes/updateabstractapprovalprocess","metadata":{"seo":{"title":"Updates a abstract approval process with the specified ID.","description":"This method will update an existing abstract approval process with the specified ID."}},"httpPath":"/abstractApprovalProcesses/{tenantId}/{id}"}]},{"type":"group","label":"Abstract Decision Processes","link":"/apis/events/events-v1/abstract-decision-processes","routeSlug":"/apis/events/events-v1/abstract-decision-processes","items":[{"label":"Gets all of the abstract decision processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-decision-processes/listabstractdecisionprocesses","routeSlug":"/apis/events/events-v1/abstract-decision-processes/listabstractdecisionprocesses","metadata":{"seo":{"title":"Gets all of the abstract decision processes in the system.","description":"This method will scan all abstract decision processes and and return them to the caller."}},"httpPath":"/abstractDecisionProcesses/{tenantId}"},{"label":"Creates a new abstract decision process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-decision-processes/createabstractdecisionprocess","routeSlug":"/apis/events/events-v1/abstract-decision-processes/createabstractdecisionprocess","metadata":{"seo":{"title":"Creates a new abstract decision process record that does not already exist.","description":"This method will auto-generate an ID and create a new abstract decision process. If an ID is specified for the abstract decision process, an error will be thrown."}},"httpPath":"/abstractDecisionProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-decision-processes/executebatchoperations","routeSlug":"/apis/events/events-v1/abstract-decision-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/abstractDecisionProcesses/{tenantId}/batch"},{"label":"Returns a abstract decision process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-decision-processes/deleteabstractdecisionprocess","routeSlug":"/apis/events/events-v1/abstract-decision-processes/deleteabstractdecisionprocess","metadata":{"seo":{"title":"Returns a abstract decision process from the system by its ID.","description":"This method will delete a abstract decision process with the specified ID."}},"httpPath":"/abstractDecisionProcesses/{tenantId}/{id}"},{"label":"Returns a abstract decision process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-decision-processes/getabstractdecisionprocess","routeSlug":"/apis/events/events-v1/abstract-decision-processes/getabstractdecisionprocess","metadata":{"seo":{"title":"Returns a abstract decision process from the system by its ID.","description":"This method will look up a abstract decision process by the specified ID and return it back."}},"httpPath":"/abstractDecisionProcesses/{tenantId}/{id}"},{"label":"Partially updates a abstract decision process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-decision-processes/patchabstractdecisionprocess","routeSlug":"/apis/events/events-v1/abstract-decision-processes/patchabstractdecisionprocess","metadata":{"seo":{"title":"Partially updates a abstract decision process with the specified ID.","description":"This method will patch an existing abstract decision process with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/abstractDecisionProcesses/{tenantId}/{id}"},{"label":"Updates a abstract decision process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-decision-processes/updateabstractdecisionprocess","routeSlug":"/apis/events/events-v1/abstract-decision-processes/updateabstractdecisionprocess","metadata":{"seo":{"title":"Updates a abstract decision process with the specified ID.","description":"This method will update an existing abstract decision process with the specified ID."}},"httpPath":"/abstractDecisionProcesses/{tenantId}/{id}"}]},{"type":"group","label":"Abstract Review Processes","link":"/apis/events/events-v1/abstract-review-processes","routeSlug":"/apis/events/events-v1/abstract-review-processes","items":[{"label":"Gets all of the abstract review processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-review-processes/listabstractreviewprocesses","routeSlug":"/apis/events/events-v1/abstract-review-processes/listabstractreviewprocesses","metadata":{"seo":{"title":"Gets all of the abstract review processes in the system.","description":"This method will scan all abstract review processes and and return them to the caller."}},"httpPath":"/abstractReviewProcesses/{tenantId}"},{"label":"Creates a new abstract review process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-review-processes/createabstractreviewprocess","routeSlug":"/apis/events/events-v1/abstract-review-processes/createabstractreviewprocess","metadata":{"seo":{"title":"Creates a new abstract review process record that does not already exist.","description":"This method will auto-generate an ID and create a new abstract review process. If an ID is specified for the abstract review process, an error will be thrown."}},"httpPath":"/abstractReviewProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-review-processes/executebatchoperations","routeSlug":"/apis/events/events-v1/abstract-review-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/abstractReviewProcesses/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-review-processes/listprocessesbyeventid","routeSlug":"/apis/events/events-v1/abstract-review-processes/listprocessesbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/abstractReviewProcesses/{tenantId}/event/{event_id}"},{"label":"Returns a abstract review process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-review-processes/deleteabstractreviewprocess","routeSlug":"/apis/events/events-v1/abstract-review-processes/deleteabstractreviewprocess","metadata":{"seo":{"title":"Returns a abstract review process from the system by its ID.","description":"This method will delete a abstract review process with the specified ID."}},"httpPath":"/abstractReviewProcesses/{tenantId}/{id}"},{"label":"Returns a abstract review process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-review-processes/getabstractreviewprocess","routeSlug":"/apis/events/events-v1/abstract-review-processes/getabstractreviewprocess","metadata":{"seo":{"title":"Returns a abstract review process from the system by its ID.","description":"This method will look up a abstract review process by the specified ID and return it back."}},"httpPath":"/abstractReviewProcesses/{tenantId}/{id}"},{"label":"Partially updates a abstract review process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-review-processes/patchabstractreviewprocess","routeSlug":"/apis/events/events-v1/abstract-review-processes/patchabstractreviewprocess","metadata":{"seo":{"title":"Partially updates a abstract review process with the specified ID.","description":"This method will patch an existing abstract review process with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/abstractReviewProcesses/{tenantId}/{id}"},{"label":"Updates a abstract review process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-review-processes/updateabstractreviewprocess","routeSlug":"/apis/events/events-v1/abstract-review-processes/updateabstractreviewprocess","metadata":{"seo":{"title":"Updates a abstract review process with the specified ID.","description":"This method will update an existing abstract review process with the specified ID."}},"httpPath":"/abstractReviewProcesses/{tenantId}/{id}"}]},{"type":"group","label":"Abstract Review Rounds","link":"/apis/events/events-v1/abstract-review-rounds","routeSlug":"/apis/events/events-v1/abstract-review-rounds","items":[{"label":"Gets all of the abstract review rounds in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-review-rounds/listabstractreviewrounds","routeSlug":"/apis/events/events-v1/abstract-review-rounds/listabstractreviewrounds","metadata":{"seo":{"title":"Gets all of the abstract review rounds in the system.","description":"This method will scan all abstract review rounds and and return them to the caller."}},"httpPath":"/abstractReviewRounds/{tenantId}"},{"label":"Creates a new abstract review round record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-review-rounds/createabstractreviewround","routeSlug":"/apis/events/events-v1/abstract-review-rounds/createabstractreviewround","metadata":{"seo":{"title":"Creates a new abstract review round record that does not already exist.","description":"This method will auto-generate an ID and create a new abstract review round. If an ID is specified for the abstract review round, an error will be thrown."}},"httpPath":"/abstractReviewRounds/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-review-rounds/executebatchoperations","routeSlug":"/apis/events/events-v1/abstract-review-rounds/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/abstractReviewRounds/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-review-rounds/listroundsbyeventid","routeSlug":"/apis/events/events-v1/abstract-review-rounds/listroundsbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/abstractReviewRounds/{tenantId}/event/{event_id}"},{"label":"Returns a list of records with the specified status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-review-rounds/listbyprocessstatus","routeSlug":"/apis/events/events-v1/abstract-review-rounds/listbyprocessstatus","metadata":{"seo":{"title":"Returns a list of records with the specified status","description":"Returns a list of records with the specified status"}},"httpPath":"/abstractReviewRounds/{tenantId}/status/{processId}/{status}"},{"label":"Returns a abstract review round from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-review-rounds/deleteabstractreviewround","routeSlug":"/apis/events/events-v1/abstract-review-rounds/deleteabstractreviewround","metadata":{"seo":{"title":"Returns a abstract review round from the system by its ID.","description":"This method will delete a abstract review round with the specified ID."}},"httpPath":"/abstractReviewRounds/{tenantId}/{id}"},{"label":"Returns a abstract review round from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-review-rounds/getabstractreviewround","routeSlug":"/apis/events/events-v1/abstract-review-rounds/getabstractreviewround","metadata":{"seo":{"title":"Returns a abstract review round from the system by its ID.","description":"This method will look up a abstract review round by the specified ID and return it back."}},"httpPath":"/abstractReviewRounds/{tenantId}/{id}"},{"label":"Partially updates a abstract review round with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-review-rounds/patchabstractreviewround","routeSlug":"/apis/events/events-v1/abstract-review-rounds/patchabstractreviewround","metadata":{"seo":{"title":"Partially updates a abstract review round with the specified ID.","description":"This method will patch an existing abstract review round with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/abstractReviewRounds/{tenantId}/{id}"},{"label":"Updates a abstract review round with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-review-rounds/updateabstractreviewround","routeSlug":"/apis/events/events-v1/abstract-review-rounds/updateabstractreviewround","metadata":{"seo":{"title":"Updates a abstract review round with the specified ID.","description":"This method will update an existing abstract review round with the specified ID."}},"httpPath":"/abstractReviewRounds/{tenantId}/{id}"}]},{"type":"group","label":"Abstract Reviews","link":"/apis/events/events-v1/abstract-reviews","routeSlug":"/apis/events/events-v1/abstract-reviews","items":[{"label":"Creates a new abstract review record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-reviews/createabstractreview","routeSlug":"/apis/events/events-v1/abstract-reviews/createabstractreview","metadata":{"seo":{"title":"Creates a new abstract review record that does not already exist.","description":"This method will auto-generate an ID and create a new abstract review. If an ID is specified for the abstract review, an error will be thrown."}},"httpPath":"/abstractReviews/{tenantId}"},{"label":"Returns a list of records with the specified abstract_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-reviews/listreviewsbyabstractid","routeSlug":"/apis/events/events-v1/abstract-reviews/listreviewsbyabstractid","metadata":{"seo":{"title":"Returns a list of records with the specified abstract_id","description":"Returns a list of records with the specified abstract_id"}},"httpPath":"/abstractReviews/{tenantId}/abstract/{abstract_id}"},{"label":"Assign reviews for passed in abstracts to specific users","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-reviews/assignreviews","routeSlug":"/apis/events/events-v1/abstract-reviews/assignreviews","metadata":{"seo":{"title":"Assign reviews for passed in abstracts to specific users","description":"Assign reviews for passed in abstracts to specific users"}},"httpPath":"/abstractReviews/{tenantId}/assignReviews"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-reviews/executebatchoperations","routeSlug":"/apis/events/events-v1/abstract-reviews/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/abstractReviews/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-reviews/listabstractreviewsbycontactid","routeSlug":"/apis/events/events-v1/abstract-reviews/listabstractreviewsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/abstractReviews/{tenantId}/contact/{contactId}"},{"label":"Returns a list of records with the specified event_id and review_round_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-reviews/listreviewsbyeventroundid","routeSlug":"/apis/events/events-v1/abstract-reviews/listreviewsbyeventroundid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id and review_round_id","description":"Returns a list of records with the specified event_id and review_round_id"}},"httpPath":"/abstractReviews/{tenantId}/event/round/{eventId}/{roundId}"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-reviews/listreviewsbyeventid","routeSlug":"/apis/events/events-v1/abstract-reviews/listreviewsbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/abstractReviews/{tenantId}/event/{event_id}"},{"label":"Open a review round generating reviews based on the round assignment rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-reviews/openreviewround","routeSlug":"/apis/events/events-v1/abstract-reviews/openreviewround","metadata":{"seo":{"title":"Open a review round generating reviews based on the round assignment rules","description":"This endpoint opens a review round for a process and closes the existing open round, it also generates reviews for all of the assignees defined in the matching assignment rules on the round being opened"}},"httpPath":"/abstractReviews/{tenantId}/openRound/{typeId}/{roundId}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-reviews/previewemail","routeSlug":"/apis/events/events-v1/abstract-reviews/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/abstractReviews/{tenantId}/previewEmail"},{"label":"Resends the confirmation email for an abstract review submission","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-reviews/resendconfirmationemail","routeSlug":"/apis/events/events-v1/abstract-reviews/resendconfirmationemail","metadata":{"seo":{"title":"Resends the confirmation email for an abstract review submission","description":"Resends the confirmation email for an abstract review submission"}},"httpPath":"/abstractReviews/{tenantId}/resendConfirmationEmail/{id}"},{"label":"Resends the review assignment email for an abstract review submission","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-reviews/resendreviewassignmentemail","routeSlug":"/apis/events/events-v1/abstract-reviews/resendreviewassignmentemail","metadata":{"seo":{"title":"Resends the review assignment email for an abstract review submission","description":"Resends the review assignment email for an abstract review submission"}},"httpPath":"/abstractReviews/{tenantId}/resendReviewAssignmentEmail/{id}"},{"label":"Returns a list of records with the specified review_round_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-reviews/listreviewsbyreviewroundid","routeSlug":"/apis/events/events-v1/abstract-reviews/listreviewsbyreviewroundid","metadata":{"seo":{"title":"Returns a list of records with the specified review_round_id","description":"Returns a list of records with the specified review_round_id"}},"httpPath":"/abstractReviews/{tenantId}/reviewRound/{review_round_id}"},{"label":"Searches for abstract reviews using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-reviews/searchforabstractreviews","routeSlug":"/apis/events/events-v1/abstract-reviews/searchforabstractreviews","metadata":{"seo":{"title":"Searches for abstract reviews using predefined parameters","description":"Searches for abstract reviews using predefined parameters"}},"httpPath":"/abstractReviews/{tenantId}/search"},{"label":"Sends the review assignment email for an abstract review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-reviews/sendreviewassignmentemail","routeSlug":"/apis/events/events-v1/abstract-reviews/sendreviewassignmentemail","metadata":{"seo":{"title":"Sends the review assignment email for an abstract review","description":"Sends the review assignment email for an abstract review"}},"httpPath":"/abstractReviews/{tenantId}/sendReviewAssignmentEmail"},{"label":"Submit an abstract review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-reviews/submitabstractreview","routeSlug":"/apis/events/events-v1/abstract-reviews/submitabstractreview","metadata":{"seo":{"title":"Submit an abstract review","description":"Submit an abstract review"}},"httpPath":"/abstractReviews/{tenantId}/submit"},{"label":"Returns a abstract review from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-reviews/deleteabstractreview","routeSlug":"/apis/events/events-v1/abstract-reviews/deleteabstractreview","metadata":{"seo":{"title":"Returns a abstract review from the system by its ID.","description":"This method will delete a abstract review with the specified ID."}},"httpPath":"/abstractReviews/{tenantId}/{id}"},{"label":"Returns a abstract review from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-reviews/getabstractreview","routeSlug":"/apis/events/events-v1/abstract-reviews/getabstractreview","metadata":{"seo":{"title":"Returns a abstract review from the system by its ID.","description":"This method will look up a abstract review by the specified ID and return it back."}},"httpPath":"/abstractReviews/{tenantId}/{id}"},{"label":"Partially updates a abstract review with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-reviews/patchabstractreview","routeSlug":"/apis/events/events-v1/abstract-reviews/patchabstractreview","metadata":{"seo":{"title":"Partially updates a abstract review with the specified ID.","description":"This method will patch an existing abstract review with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/abstractReviews/{tenantId}/{id}"},{"label":"Updates a abstract review with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-reviews/updateabstractreview","routeSlug":"/apis/events/events-v1/abstract-reviews/updateabstractreview","metadata":{"seo":{"title":"Updates a abstract review with the specified ID.","description":"This method will update an existing abstract review with the specified ID."}},"httpPath":"/abstractReviews/{tenantId}/{id}"}]},{"type":"group","label":"Abstract Settings","link":"/apis/events/events-v1/abstract-settings","routeSlug":"/apis/events/events-v1/abstract-settings","items":[{"label":"Gets all of the abstract settings in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-settings/listabstractsettings","routeSlug":"/apis/events/events-v1/abstract-settings/listabstractsettings","metadata":{"seo":{"title":"Gets all of the abstract settings in the system.","description":"This method will scan all abstract settings and and return them to the caller."}},"httpPath":"/abstractSettings/{tenantId}"},{"label":"Creates a new abstract setting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-settings/createabstractsetting","routeSlug":"/apis/events/events-v1/abstract-settings/createabstractsetting","metadata":{"seo":{"title":"Creates a new abstract setting record that does not already exist.","description":"This method will auto-generate an ID and create a new abstract setting. If an ID is specified for the abstract setting, an error will be thrown."}},"httpPath":"/abstractSettings/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-settings/executebatchoperations","routeSlug":"/apis/events/events-v1/abstract-settings/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/abstractSettings/{tenantId}/batch"},{"label":"Returns a abstract setting from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-settings/deleteabstractsetting","routeSlug":"/apis/events/events-v1/abstract-settings/deleteabstractsetting","metadata":{"seo":{"title":"Returns a abstract setting from the system by its ID.","description":"This method will delete a abstract setting with the specified ID."}},"httpPath":"/abstractSettings/{tenantId}/{id}"},{"label":"Returns a abstract setting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-settings/getabstractsetting","routeSlug":"/apis/events/events-v1/abstract-settings/getabstractsetting","metadata":{"seo":{"title":"Returns a abstract setting from the system by its ID.","description":"This method will look up a abstract setting by the specified ID and return it back."}},"httpPath":"/abstractSettings/{tenantId}/{id}"},{"label":"Partially updates a abstract setting with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-settings/patchabstractsetting","routeSlug":"/apis/events/events-v1/abstract-settings/patchabstractsetting","metadata":{"seo":{"title":"Partially updates a abstract setting with the specified ID.","description":"This method will patch an existing abstract setting with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/abstractSettings/{tenantId}/{id}"},{"label":"Updates a abstract setting with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-settings/updateabstractsetting","routeSlug":"/apis/events/events-v1/abstract-settings/updateabstractsetting","metadata":{"seo":{"title":"Updates a abstract setting with the specified ID.","description":"This method will update an existing abstract setting with the specified ID."}},"httpPath":"/abstractSettings/{tenantId}/{id}"}]},{"type":"group","label":"Abstract Submission Processes","link":"/apis/events/events-v1/abstract-submission-processes","routeSlug":"/apis/events/events-v1/abstract-submission-processes","items":[{"label":"Gets all of the abstract submission processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-submission-processes/listabstractsubmissionprocesses","routeSlug":"/apis/events/events-v1/abstract-submission-processes/listabstractsubmissionprocesses","metadata":{"seo":{"title":"Gets all of the abstract submission processes in the system.","description":"This method will scan all abstract submission processes and and return them to the caller."}},"httpPath":"/abstractSubmissionProcesses/{tenantId}"},{"label":"Creates a new abstract submission process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-submission-processes/createabstractsubmissionprocess","routeSlug":"/apis/events/events-v1/abstract-submission-processes/createabstractsubmissionprocess","metadata":{"seo":{"title":"Creates a new abstract submission process record that does not already exist.","description":"This method will auto-generate an ID and create a new abstract submission process. If an ID is specified for the abstract submission process, an error will be thrown."}},"httpPath":"/abstractSubmissionProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-submission-processes/executebatchoperations","routeSlug":"/apis/events/events-v1/abstract-submission-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/abstractSubmissionProcesses/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-submission-processes/listprocessesbyeventid","routeSlug":"/apis/events/events-v1/abstract-submission-processes/listprocessesbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/abstractSubmissionProcesses/{tenantId}/event/{event_id}"},{"label":"Returns a abstract submission process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-submission-processes/deleteabstractsubmissionprocess","routeSlug":"/apis/events/events-v1/abstract-submission-processes/deleteabstractsubmissionprocess","metadata":{"seo":{"title":"Returns a abstract submission process from the system by its ID.","description":"This method will delete a abstract submission process with the specified ID."}},"httpPath":"/abstractSubmissionProcesses/{tenantId}/{id}"},{"label":"Returns a abstract submission process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-submission-processes/getabstractsubmissionprocess","routeSlug":"/apis/events/events-v1/abstract-submission-processes/getabstractsubmissionprocess","metadata":{"seo":{"title":"Returns a abstract submission process from the system by its ID.","description":"This method will look up a abstract submission process by the specified ID and return it back."}},"httpPath":"/abstractSubmissionProcesses/{tenantId}/{id}"},{"label":"Partially updates a abstract submission process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-submission-processes/patchabstractsubmissionprocess","routeSlug":"/apis/events/events-v1/abstract-submission-processes/patchabstractsubmissionprocess","metadata":{"seo":{"title":"Partially updates a abstract submission process with the specified ID.","description":"This method will patch an existing abstract submission process with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/abstractSubmissionProcesses/{tenantId}/{id}"},{"label":"Updates a abstract submission process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-submission-processes/updateabstractsubmissionprocess","routeSlug":"/apis/events/events-v1/abstract-submission-processes/updateabstractsubmissionprocess","metadata":{"seo":{"title":"Updates a abstract submission process with the specified ID.","description":"This method will update an existing abstract submission process with the specified ID."}},"httpPath":"/abstractSubmissionProcesses/{tenantId}/{id}"}]},{"type":"group","label":"Abstract Types","link":"/apis/events/events-v1/abstract-types","routeSlug":"/apis/events/events-v1/abstract-types","items":[{"label":"Creates a new abstract type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-types/createabstracttype","routeSlug":"/apis/events/events-v1/abstract-types/createabstracttype","metadata":{"seo":{"title":"Creates a new abstract type record that does not already exist.","description":"This method will auto-generate an ID and create a new abstract type. If an ID is specified for the abstract type, an error will be thrown."}},"httpPath":"/abstractTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-types/executebatchoperations","routeSlug":"/apis/events/events-v1/abstract-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/abstractTypes/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-types/listtypesbyeventid","routeSlug":"/apis/events/events-v1/abstract-types/listtypesbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/abstractTypes/{tenantId}/event/{event_id}"},{"label":"Returns a list of records with the specified review_process_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-types/listtypesbyreviewprocessid","routeSlug":"/apis/events/events-v1/abstract-types/listtypesbyreviewprocessid","metadata":{"seo":{"title":"Returns a list of records with the specified review_process_id","description":"Returns a list of records with the specified review_process_id"}},"httpPath":"/abstractTypes/{tenantId}/reviewProcess/{review_process_id}"},{"label":"Returns a abstract type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-types/deleteabstracttype","routeSlug":"/apis/events/events-v1/abstract-types/deleteabstracttype","metadata":{"seo":{"title":"Returns a abstract type from the system by its ID.","description":"This method will delete a abstract type with the specified ID."}},"httpPath":"/abstractTypes/{tenantId}/{id}"},{"label":"Returns a abstract type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-types/getabstracttype","routeSlug":"/apis/events/events-v1/abstract-types/getabstracttype","metadata":{"seo":{"title":"Returns a abstract type from the system by its ID.","description":"This method will look up a abstract type by the specified ID and return it back."}},"httpPath":"/abstractTypes/{tenantId}/{id}"},{"label":"Partially updates a abstract type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-types/patchabstracttype","routeSlug":"/apis/events/events-v1/abstract-types/patchabstracttype","metadata":{"seo":{"title":"Partially updates a abstract type with the specified ID.","description":"This method will patch an existing abstract type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/abstractTypes/{tenantId}/{id}"},{"label":"Updates a abstract type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstract-types/updateabstracttype","routeSlug":"/apis/events/events-v1/abstract-types/updateabstracttype","metadata":{"seo":{"title":"Updates a abstract type with the specified ID.","description":"This method will update an existing abstract type with the specified ID."}},"httpPath":"/abstractTypes/{tenantId}/{id}"}]},{"type":"group","label":"Abstracts","link":"/apis/events/events-v1/abstracts","routeSlug":"/apis/events/events-v1/abstracts","items":[{"label":"Creates a new abstract record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/createabstract","routeSlug":"/apis/events/events-v1/abstracts/createabstract","metadata":{"seo":{"title":"Creates a new abstract record that does not already exist.","description":"This method will auto-generate an ID and create a new abstract. If an ID is specified for the abstract, an error will be thrown."}},"httpPath":"/abstracts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/executebatchoperations","routeSlug":"/apis/events/events-v1/abstracts/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/abstracts/{tenantId}/batch"},{"label":"Bulk update abstract statuses","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/breakoutsessions","routeSlug":"/apis/events/events-v1/abstracts/breakoutsessions","metadata":{"seo":{"title":"Bulk update abstract statuses","description":"Allows for bulk update of abstract statuses"}},"httpPath":"/abstracts/{tenantId}/breakoutSessions"},{"label":"Calculations for the reviews for an abstract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/calculatescore","routeSlug":"/apis/events/events-v1/abstracts/calculatescore","metadata":{"seo":{"title":"Calculations for the reviews for an abstract","description":"Return the set of totals and calculations for an abstract based on the reviews and grouped by the rounds"}},"httpPath":"/abstracts/{tenantId}/calculateScore/{abstractId}"},{"label":"Returns a list of records with the specified co_author_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/listabstractsbycoauthorid","routeSlug":"/apis/events/events-v1/abstracts/listabstractsbycoauthorid","metadata":{"seo":{"title":"Returns a list of records with the specified co_author_id","description":"Returns a list of records with the specified co_author_id"}},"httpPath":"/abstracts/{tenantId}/coAuthor/{co_author_contact_id}"},{"label":"End user abstract confirmation form submission endpoint","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/confirmabstract","routeSlug":"/apis/events/events-v1/abstracts/confirmabstract","metadata":{"seo":{"title":"End user abstract confirmation form submission endpoint","description":"Allows a portal user to submit an abstract confirmation-approval form with additional information"}},"httpPath":"/abstracts/{tenantId}/confirm/{id}"},{"label":"Returns a list of records with the specified event_contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/listabstractsbyeventcontactid","routeSlug":"/apis/events/events-v1/abstracts/listabstractsbyeventcontactid","metadata":{"seo":{"title":"Returns a list of records with the specified event_contact_id","description":"Returns a list of records with the specified event_contact_id"}},"httpPath":"/abstracts/{tenantId}/eventContact/{eventId}/{contactId}"},{"label":"Returns a list of records with the specified event_presenter_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/listabstractsbyeventpresenterid","routeSlug":"/apis/events/events-v1/abstracts/listabstractsbyeventpresenterid","metadata":{"seo":{"title":"Returns a list of records with the specified event_presenter_id","description":"Returns a list of records with the specified event_presenter_id"}},"httpPath":"/abstracts/{tenantId}/eventPresenter/{eventId}/{contactId}"},{"label":"Get CoAuthor info for Abstracts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/getcoauthorinfo","routeSlug":"/apis/events/events-v1/abstracts/getcoauthorinfo","metadata":{"seo":{"title":"Get CoAuthor info for Abstracts","description":"Get CoAuthor info for Abstracts"}},"httpPath":"/abstracts/{tenantId}/getCoAuthorInfo/{contactId}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/previewemail","routeSlug":"/apis/events/events-v1/abstracts/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/abstracts/{tenantId}/previewEmail"},{"label":"Resends the confirmation email for an abstract submission","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/resendconfirmationemail","routeSlug":"/apis/events/events-v1/abstracts/resendconfirmationemail","metadata":{"seo":{"title":"Resends the confirmation email for an abstract submission","description":"Resends the confirmation email for an abstract submission"}},"httpPath":"/abstracts/{tenantId}/resendConfirmationEmail/{id}"},{"label":"Returns a list of records with the specified review_process_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/listabstractsbyreviewprocessid","routeSlug":"/apis/events/events-v1/abstracts/listabstractsbyreviewprocessid","metadata":{"seo":{"title":"Returns a list of records with the specified review_process_id","description":"Returns a list of records with the specified review_process_id"}},"httpPath":"/abstracts/{tenantId}/reviewProcess/{review_process_id}"},{"label":"Returns a list of records with the specified review_round_id","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/listabstractsbyreviewroundid","routeSlug":"/apis/events/events-v1/abstracts/listabstractsbyreviewroundid","metadata":{"seo":{"title":"Returns a list of records with the specified review_round_id","description":"Returns a list of records with the specified review_round_id"}},"httpPath":"/abstracts/{tenantId}/reviewRound/{id}"},{"label":"Searches for abstracts using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/searchforabstracts","routeSlug":"/apis/events/events-v1/abstracts/searchforabstracts","metadata":{"seo":{"title":"Searches for abstracts using predefined parameters","description":"Searches for abstracts using predefined parameters"}},"httpPath":"/abstracts/{tenantId}/search"},{"label":"Process a Status Change Request","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/processstatuschange","routeSlug":"/apis/events/events-v1/abstracts/processstatuschange","metadata":{"seo":{"title":"Process a Status Change Request","description":"Updates the status and sends out the appropriate email"}},"httpPath":"/abstracts/{tenantId}/status/{id}"},{"label":"Submit an abstract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/submitabstracts","routeSlug":"/apis/events/events-v1/abstracts/submitabstracts","metadata":{"seo":{"title":"Submit an abstract","description":"Submit an abstract"}},"httpPath":"/abstracts/{tenantId}/submit"},{"label":"Returns a list of records with the specified submitter_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/listabstractsbysubmitterid","routeSlug":"/apis/events/events-v1/abstracts/listabstractsbysubmitterid","metadata":{"seo":{"title":"Returns a list of records with the specified submitter_id","description":"Returns a list of records with the specified submitter_id"}},"httpPath":"/abstracts/{tenantId}/submitter/{submitter_id}"},{"label":"Returns a list of records with the specified type_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/listabstractsbytypeid","routeSlug":"/apis/events/events-v1/abstracts/listabstractsbytypeid","metadata":{"seo":{"title":"Returns a list of records with the specified type_id","description":"Returns a list of records with the specified type_id"}},"httpPath":"/abstracts/{tenantId}/type/{type_id}"},{"label":"Bulk update abstract statuses","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/updateabstractstatuses","routeSlug":"/apis/events/events-v1/abstracts/updateabstractstatuses","metadata":{"seo":{"title":"Bulk update abstract statuses","description":"Allows for bulk update of abstract statuses"}},"httpPath":"/abstracts/{tenantId}/updateStatus/{status}"},{"label":"Returns a abstract from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/deleteabstract","routeSlug":"/apis/events/events-v1/abstracts/deleteabstract","metadata":{"seo":{"title":"Returns a abstract from the system by its ID.","description":"This method will delete a abstract with the specified ID."}},"httpPath":"/abstracts/{tenantId}/{id}"},{"label":"Returns a abstract from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/getabstract","routeSlug":"/apis/events/events-v1/abstracts/getabstract","metadata":{"seo":{"title":"Returns a abstract from the system by its ID.","description":"This method will look up a abstract by the specified ID and return it back."}},"httpPath":"/abstracts/{tenantId}/{id}"},{"label":"Partially updates a abstract with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/patchabstract","routeSlug":"/apis/events/events-v1/abstracts/patchabstract","metadata":{"seo":{"title":"Partially updates a abstract with the specified ID.","description":"This method will patch an existing abstract with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/abstracts/{tenantId}/{id}"},{"label":"Updates a abstract with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/abstracts/updateabstract","routeSlug":"/apis/events/events-v1/abstracts/updateabstract","metadata":{"seo":{"title":"Updates a abstract with the specified ID.","description":"This method will update an existing abstract with the specified ID."}},"httpPath":"/abstracts/{tenantId}/{id}"}]},{"type":"group","label":"Coupons","link":"/apis/events/events-v1/coupons","routeSlug":"/apis/events/events-v1/coupons","items":[{"label":"Creates a new coupon record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/coupons/createcoupon","routeSlug":"/apis/events/events-v1/coupons/createcoupon","metadata":{"seo":{"title":"Creates a new coupon record that does not already exist.","description":"This method will auto-generate an ID and create a new coupon. If an ID is specified for the coupon, an error will be thrown."}},"httpPath":"/coupons/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/coupons/executebatchoperations","routeSlug":"/apis/events/events-v1/coupons/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/coupons/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/coupons/listcouponsbyeventid","routeSlug":"/apis/events/events-v1/coupons/listcouponsbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/coupons/{tenantId}/event/{event_id}"},{"label":"Returns a coupon from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/coupons/deletecoupon","routeSlug":"/apis/events/events-v1/coupons/deletecoupon","metadata":{"seo":{"title":"Returns a coupon from the system by its ID.","description":"This method will delete a coupon with the specified ID."}},"httpPath":"/coupons/{tenantId}/{id}"},{"label":"Returns a coupon from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/coupons/getcoupon","routeSlug":"/apis/events/events-v1/coupons/getcoupon","metadata":{"seo":{"title":"Returns a coupon from the system by its ID.","description":"This method will look up a coupon by the specified ID and return it back."}},"httpPath":"/coupons/{tenantId}/{id}"},{"label":"Partially updates a coupon with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/coupons/patchcoupon","routeSlug":"/apis/events/events-v1/coupons/patchcoupon","metadata":{"seo":{"title":"Partially updates a coupon with the specified ID.","description":"This method will patch an existing coupon with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/coupons/{tenantId}/{id}"},{"label":"Updates a coupon with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/coupons/updatecoupon","routeSlug":"/apis/events/events-v1/coupons/updatecoupon","metadata":{"seo":{"title":"Updates a coupon with the specified ID.","description":"This method will update an existing coupon with the specified ID."}},"httpPath":"/coupons/{tenantId}/{id}"}]},{"type":"group","label":"Events","link":"/apis/events/events-v1/events","routeSlug":"/apis/events/events-v1/events","items":[{"label":"Creates a new event record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/events/createevent","routeSlug":"/apis/events/events-v1/events/createevent","metadata":{"seo":{"title":"Creates a new event record that does not already exist.","description":"This method will auto-generate an ID and create a new event. If an ID is specified for the event, an error will be thrown."}},"httpPath":"/events/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/events/executebatchoperations","routeSlug":"/apis/events/events-v1/events/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/events/{tenantId}/batch"},{"label":"Returns a list of records with the specified chapter_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/events/listeventsbychapterid","routeSlug":"/apis/events/events-v1/events/listeventsbychapterid","metadata":{"seo":{"title":"Returns a list of records with the specified chapter_id","description":"Returns a list of records with the specified chapter_id"}},"httpPath":"/events/{tenantId}/chapter/{chapter_id}"},{"label":"Creates a copy of an event, along with other associated records","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/events/cloneevent","routeSlug":"/apis/events/events-v1/events/cloneevent","metadata":{"seo":{"title":"Creates a copy of an event, along with other associated records","description":"Creates a copy of an event, along with other associated records"}},"httpPath":"/events/{tenantId}/clone"},{"label":"Can add guest","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/events/canaddguest","routeSlug":"/apis/events/events-v1/events/canaddguest","metadata":{"seo":{"title":"Can add guest","description":"Returns a list of records with the specified type_id"}},"httpPath":"/events/{tenantId}/guestEligibility/{id}"},{"label":"Returns a list of records that are upcoming","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/events/getupcomingevents","routeSlug":"/apis/events/events-v1/events/getupcomingevents","metadata":{"seo":{"title":"Returns a list of records that are upcoming","description":"Returns a list of records that are upcoming"}},"httpPath":"/events/{tenantId}/public/upcoming"},{"label":"Gets the public event info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/events/getpubliceventinfo","routeSlug":"/apis/events/events-v1/events/getpubliceventinfo","metadata":{"seo":{"title":"Gets the public event info","description":"Gets the public event info"}},"httpPath":"/events/{tenantId}/public/{id}"},{"label":"Searches for events using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/events/searchforevents","routeSlug":"/apis/events/events-v1/events/searchforevents","metadata":{"seo":{"title":"Searches for events using predefined parameters","description":"Searches for events using predefined parameters"}},"httpPath":"/events/{tenantId}/search"},{"label":"Returns a list of records that start after specified start_date","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/events/listeventsstartingafter","routeSlug":"/apis/events/events-v1/events/listeventsstartingafter","metadata":{"seo":{"title":"Returns a list of records that start after specified start_date","description":"Returns a list of records with that start after the specified start_date"}},"httpPath":"/events/{tenantId}/startDate/{start_date}"},{"label":"Returns a list of records with the specified type_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/events/listeventsbytypeid","routeSlug":"/apis/events/events-v1/events/listeventsbytypeid","metadata":{"seo":{"title":"Returns a list of records with the specified type_id","description":"Returns a list of records with the specified type_id"}},"httpPath":"/events/{tenantId}/type/{type_id}"},{"label":"Returns a event from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/events/deleteevent","routeSlug":"/apis/events/events-v1/events/deleteevent","metadata":{"seo":{"title":"Returns a event from the system by its ID.","description":"This method will delete a event with the specified ID."}},"httpPath":"/events/{tenantId}/{id}"},{"label":"Returns a event from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/events/getevent","routeSlug":"/apis/events/events-v1/events/getevent","metadata":{"seo":{"title":"Returns a event from the system by its ID.","description":"This method will look up a event by the specified ID and return it back."}},"httpPath":"/events/{tenantId}/{id}"},{"label":"Partially updates a event with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/events/patchevent","routeSlug":"/apis/events/events-v1/events/patchevent","metadata":{"seo":{"title":"Partially updates a event with the specified ID.","description":"This method will patch an existing event with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/events/{tenantId}/{id}"},{"label":"Updates a event with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/events/updateevent","routeSlug":"/apis/events/events-v1/events/updateevent","metadata":{"seo":{"title":"Updates a event with the specified ID.","description":"This method will update an existing event with the specified ID."}},"httpPath":"/events/{tenantId}/{id}"}]},{"type":"group","label":"Exhibitor Add On Products","link":"/apis/events/events-v1/exhibitor-add-on-products","routeSlug":"/apis/events/events-v1/exhibitor-add-on-products","items":[{"label":"Creates a new exhibitor add on product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-add-on-products/createexhibitoraddonproduct","routeSlug":"/apis/events/events-v1/exhibitor-add-on-products/createexhibitoraddonproduct","metadata":{"seo":{"title":"Creates a new exhibitor add on product record that does not already exist.","description":"This method will auto-generate an ID and create a new exhibitor add on product. If an ID is specified for the exhibitor add on product, an error will be thrown."}},"httpPath":"/exhibitorAddOnProducts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-add-on-products/executebatchoperations","routeSlug":"/apis/events/events-v1/exhibitor-add-on-products/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/exhibitorAddOnProducts/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-add-on-products/listproductsbyeventid","routeSlug":"/apis/events/events-v1/exhibitor-add-on-products/listproductsbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/exhibitorAddOnProducts/{tenantId}/event/{event_id}"},{"label":"Returns a exhibitor add on product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-add-on-products/deleteexhibitoraddonproduct","routeSlug":"/apis/events/events-v1/exhibitor-add-on-products/deleteexhibitoraddonproduct","metadata":{"seo":{"title":"Returns a exhibitor add on product from the system by its ID.","description":"This method will delete a exhibitor add on product with the specified ID."}},"httpPath":"/exhibitorAddOnProducts/{tenantId}/{id}"},{"label":"Returns a exhibitor add on product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-add-on-products/getexhibitoraddonproduct","routeSlug":"/apis/events/events-v1/exhibitor-add-on-products/getexhibitoraddonproduct","metadata":{"seo":{"title":"Returns a exhibitor add on product from the system by its ID.","description":"This method will look up a exhibitor add on product by the specified ID and return it back."}},"httpPath":"/exhibitorAddOnProducts/{tenantId}/{id}"},{"label":"Partially updates a exhibitor add on product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-add-on-products/patchexhibitoraddonproduct","routeSlug":"/apis/events/events-v1/exhibitor-add-on-products/patchexhibitoraddonproduct","metadata":{"seo":{"title":"Partially updates a exhibitor add on product with the specified ID.","description":"This method will patch an existing exhibitor add on product with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/exhibitorAddOnProducts/{tenantId}/{id}"},{"label":"Updates a exhibitor add on product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-add-on-products/updateexhibitoraddonproduct","routeSlug":"/apis/events/events-v1/exhibitor-add-on-products/updateexhibitoraddonproduct","metadata":{"seo":{"title":"Updates a exhibitor add on product with the specified ID.","description":"This method will update an existing exhibitor add on product with the specified ID."}},"httpPath":"/exhibitorAddOnProducts/{tenantId}/{id}"}]},{"type":"group","label":"Exhibitor Booth Fees","link":"/apis/events/events-v1/exhibitor-booth-fees","routeSlug":"/apis/events/events-v1/exhibitor-booth-fees","items":[{"label":"Creates a new exhibitor booth fee record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booth-fees/createexhibitorboothfee","routeSlug":"/apis/events/events-v1/exhibitor-booth-fees/createexhibitorboothfee","metadata":{"seo":{"title":"Creates a new exhibitor booth fee record that does not already exist.","description":"This method will auto-generate an ID and create a new exhibitor booth fee. If an ID is specified for the exhibitor booth fee, an error will be thrown."}},"httpPath":"/exhibitorBoothFees/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booth-fees/executebatchoperations","routeSlug":"/apis/events/events-v1/exhibitor-booth-fees/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/exhibitorBoothFees/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booth-fees/listfeesbyeventid","routeSlug":"/apis/events/events-v1/exhibitor-booth-fees/listfeesbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/exhibitorBoothFees/{tenantId}/event/{event_id}"},{"label":"Returns a exhibitor booth fee from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booth-fees/deleteexhibitorboothfee","routeSlug":"/apis/events/events-v1/exhibitor-booth-fees/deleteexhibitorboothfee","metadata":{"seo":{"title":"Returns a exhibitor booth fee from the system by its ID.","description":"This method will delete a exhibitor booth fee with the specified ID."}},"httpPath":"/exhibitorBoothFees/{tenantId}/{id}"},{"label":"Returns a exhibitor booth fee from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booth-fees/getexhibitorboothfee","routeSlug":"/apis/events/events-v1/exhibitor-booth-fees/getexhibitorboothfee","metadata":{"seo":{"title":"Returns a exhibitor booth fee from the system by its ID.","description":"This method will look up a exhibitor booth fee by the specified ID and return it back."}},"httpPath":"/exhibitorBoothFees/{tenantId}/{id}"},{"label":"Partially updates a exhibitor booth fee with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booth-fees/patchexhibitorboothfee","routeSlug":"/apis/events/events-v1/exhibitor-booth-fees/patchexhibitorboothfee","metadata":{"seo":{"title":"Partially updates a exhibitor booth fee with the specified ID.","description":"This method will patch an existing exhibitor booth fee with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/exhibitorBoothFees/{tenantId}/{id}"},{"label":"Updates a exhibitor booth fee with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booth-fees/updateexhibitorboothfee","routeSlug":"/apis/events/events-v1/exhibitor-booth-fees/updateexhibitorboothfee","metadata":{"seo":{"title":"Updates a exhibitor booth fee with the specified ID.","description":"This method will update an existing exhibitor booth fee with the specified ID."}},"httpPath":"/exhibitorBoothFees/{tenantId}/{id}"}]},{"type":"group","label":"Exhibitor Booth Types","link":"/apis/events/events-v1/exhibitor-booth-types","routeSlug":"/apis/events/events-v1/exhibitor-booth-types","items":[{"label":"Gets all of the exhibitor booth types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booth-types/listexhibitorboothtypes","routeSlug":"/apis/events/events-v1/exhibitor-booth-types/listexhibitorboothtypes","metadata":{"seo":{"title":"Gets all of the exhibitor booth types in the system.","description":"This method will scan all exhibitor booth types and and return them to the caller."}},"httpPath":"/exhibitorBoothTypes/{tenantId}"},{"label":"Creates a new exhibitor booth type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booth-types/createexhibitorboothtype","routeSlug":"/apis/events/events-v1/exhibitor-booth-types/createexhibitorboothtype","metadata":{"seo":{"title":"Creates a new exhibitor booth type record that does not already exist.","description":"This method will auto-generate an ID and create a new exhibitor booth type. If an ID is specified for the exhibitor booth type, an error will be thrown."}},"httpPath":"/exhibitorBoothTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booth-types/executebatchoperations","routeSlug":"/apis/events/events-v1/exhibitor-booth-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/exhibitorBoothTypes/{tenantId}/batch"},{"label":"Returns a exhibitor booth type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booth-types/deleteexhibitorboothtype","routeSlug":"/apis/events/events-v1/exhibitor-booth-types/deleteexhibitorboothtype","metadata":{"seo":{"title":"Returns a exhibitor booth type from the system by its ID.","description":"This method will delete a exhibitor booth type with the specified ID."}},"httpPath":"/exhibitorBoothTypes/{tenantId}/{id}"},{"label":"Returns a exhibitor booth type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booth-types/getexhibitorboothtype","routeSlug":"/apis/events/events-v1/exhibitor-booth-types/getexhibitorboothtype","metadata":{"seo":{"title":"Returns a exhibitor booth type from the system by its ID.","description":"This method will look up a exhibitor booth type by the specified ID and return it back."}},"httpPath":"/exhibitorBoothTypes/{tenantId}/{id}"},{"label":"Partially updates a exhibitor booth type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booth-types/patchexhibitorboothtype","routeSlug":"/apis/events/events-v1/exhibitor-booth-types/patchexhibitorboothtype","metadata":{"seo":{"title":"Partially updates a exhibitor booth type with the specified ID.","description":"This method will patch an existing exhibitor booth type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/exhibitorBoothTypes/{tenantId}/{id}"},{"label":"Updates a exhibitor booth type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booth-types/updateexhibitorboothtype","routeSlug":"/apis/events/events-v1/exhibitor-booth-types/updateexhibitorboothtype","metadata":{"seo":{"title":"Updates a exhibitor booth type with the specified ID.","description":"This method will update an existing exhibitor booth type with the specified ID."}},"httpPath":"/exhibitorBoothTypes/{tenantId}/{id}"}]},{"type":"group","label":"Exhibitor Booths","link":"/apis/events/events-v1/exhibitor-booths","routeSlug":"/apis/events/events-v1/exhibitor-booths","items":[{"label":"Creates a new exhibitor booth record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booths/createexhibitorbooth","routeSlug":"/apis/events/events-v1/exhibitor-booths/createexhibitorbooth","metadata":{"seo":{"title":"Creates a new exhibitor booth record that does not already exist.","description":"This method will auto-generate an ID and create a new exhibitor booth. If an ID is specified for the exhibitor booth, an error will be thrown."}},"httpPath":"/exhibitorBooths/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booths/executebatchoperations","routeSlug":"/apis/events/events-v1/exhibitor-booths/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/exhibitorBooths/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booths/listboothsbyeventid","routeSlug":"/apis/events/events-v1/exhibitor-booths/listboothsbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/exhibitorBooths/{tenantId}/event/{event_id}"},{"label":"Returns a list of records with the specified exhibitor_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booths/listboothsbyexhibitorid","routeSlug":"/apis/events/events-v1/exhibitor-booths/listboothsbyexhibitorid","metadata":{"seo":{"title":"Returns a list of records with the specified exhibitor_id","description":"Returns a list of records with the specified exhibitor_id"}},"httpPath":"/exhibitorBooths/{tenantId}/exhibitor/{exhibitor_id}"},{"label":"Returns a list of records with the specified holding_organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booths/listboothsbyholdingorganizationid","routeSlug":"/apis/events/events-v1/exhibitor-booths/listboothsbyholdingorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified holding_organization_id","description":"Returns a list of records with the specified holding_organization_id"}},"httpPath":"/exhibitorBooths/{tenantId}/holdingOrganization/{event_id}/{holding_organization_id}"},{"label":"Generate multiple booths","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booths/generatemultiplebooths","routeSlug":"/apis/events/events-v1/exhibitor-booths/generatemultiplebooths","metadata":{"seo":{"title":"Generate multiple booths","description":"Generates up to 250 booths"}},"httpPath":"/exhibitorBooths/{tenantId}/multiple/{numberToGenerate}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booths/listboothsbyorganizationid","routeSlug":"/apis/events/events-v1/exhibitor-booths/listboothsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/exhibitorBooths/{tenantId}/organization/{organization_id}"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booths/listpublicboothsbyeventid","routeSlug":"/apis/events/events-v1/exhibitor-booths/listpublicboothsbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/exhibitorBooths/{tenantId}/public/event/{event_id}"},{"label":"Returns a list of records with the specified exhibitor_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booths/listpublicboothsbyexhibitorid","routeSlug":"/apis/events/events-v1/exhibitor-booths/listpublicboothsbyexhibitorid","metadata":{"seo":{"title":"Returns a list of records with the specified exhibitor_id","description":"Returns a list of records with the specified exhibitor_id"}},"httpPath":"/exhibitorBooths/{tenantId}/public/exhibitor/{exhibitor_id}"},{"label":"Returns a exhibitor booth from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booths/deleteexhibitorbooth","routeSlug":"/apis/events/events-v1/exhibitor-booths/deleteexhibitorbooth","metadata":{"seo":{"title":"Returns a exhibitor booth from the system by its ID.","description":"This method will delete a exhibitor booth with the specified ID."}},"httpPath":"/exhibitorBooths/{tenantId}/{id}"},{"label":"Returns a exhibitor booth from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booths/getexhibitorbooth","routeSlug":"/apis/events/events-v1/exhibitor-booths/getexhibitorbooth","metadata":{"seo":{"title":"Returns a exhibitor booth from the system by its ID.","description":"This method will look up a exhibitor booth by the specified ID and return it back."}},"httpPath":"/exhibitorBooths/{tenantId}/{id}"},{"label":"Partially updates a exhibitor booth with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booths/patchexhibitorbooth","routeSlug":"/apis/events/events-v1/exhibitor-booths/patchexhibitorbooth","metadata":{"seo":{"title":"Partially updates a exhibitor booth with the specified ID.","description":"This method will patch an existing exhibitor booth with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/exhibitorBooths/{tenantId}/{id}"},{"label":"Updates a exhibitor booth with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-booths/updateexhibitorbooth","routeSlug":"/apis/events/events-v1/exhibitor-booths/updateexhibitorbooth","metadata":{"seo":{"title":"Updates a exhibitor booth with the specified ID.","description":"This method will update an existing exhibitor booth with the specified ID."}},"httpPath":"/exhibitorBooths/{tenantId}/{id}"}]},{"type":"group","label":"Exhibitor Categories","link":"/apis/events/events-v1/exhibitor-categories","routeSlug":"/apis/events/events-v1/exhibitor-categories","items":[{"label":"Gets all of the exhibitor categories in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-categories/listexhibitorcategories","routeSlug":"/apis/events/events-v1/exhibitor-categories/listexhibitorcategories","metadata":{"seo":{"title":"Gets all of the exhibitor categories in the system.","description":"This method will scan all exhibitor categories and and return them to the caller."}},"httpPath":"/exhibitorCategories/{tenantId}"},{"label":"Creates a new exhibitor category record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-categories/createexhibitorcategory","routeSlug":"/apis/events/events-v1/exhibitor-categories/createexhibitorcategory","metadata":{"seo":{"title":"Creates a new exhibitor category record that does not already exist.","description":"This method will auto-generate an ID and create a new exhibitor category. If an ID is specified for the exhibitor category, an error will be thrown."}},"httpPath":"/exhibitorCategories/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-categories/executebatchoperations","routeSlug":"/apis/events/events-v1/exhibitor-categories/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/exhibitorCategories/{tenantId}/batch"},{"label":"Returns a exhibitor category from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-categories/deleteexhibitorcategory","routeSlug":"/apis/events/events-v1/exhibitor-categories/deleteexhibitorcategory","metadata":{"seo":{"title":"Returns a exhibitor category from the system by its ID.","description":"This method will delete a exhibitor category with the specified ID."}},"httpPath":"/exhibitorCategories/{tenantId}/{id}"},{"label":"Returns a exhibitor category from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-categories/getexhibitorcategory","routeSlug":"/apis/events/events-v1/exhibitor-categories/getexhibitorcategory","metadata":{"seo":{"title":"Returns a exhibitor category from the system by its ID.","description":"This method will look up a exhibitor category by the specified ID and return it back."}},"httpPath":"/exhibitorCategories/{tenantId}/{id}"},{"label":"Partially updates a exhibitor category with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-categories/patchexhibitorcategory","routeSlug":"/apis/events/events-v1/exhibitor-categories/patchexhibitorcategory","metadata":{"seo":{"title":"Partially updates a exhibitor category with the specified ID.","description":"This method will patch an existing exhibitor category with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/exhibitorCategories/{tenantId}/{id}"},{"label":"Updates a exhibitor category with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-categories/updateexhibitorcategory","routeSlug":"/apis/events/events-v1/exhibitor-categories/updateexhibitorcategory","metadata":{"seo":{"title":"Updates a exhibitor category with the specified ID.","description":"This method will update an existing exhibitor category with the specified ID."}},"httpPath":"/exhibitorCategories/{tenantId}/{id}"}]},{"type":"group","label":"Exhibitor Contact Types","link":"/apis/events/events-v1/exhibitor-contact-types","routeSlug":"/apis/events/events-v1/exhibitor-contact-types","items":[{"label":"Gets all of the exhibitor contact types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-contact-types/listexhibitorcontacttypes","routeSlug":"/apis/events/events-v1/exhibitor-contact-types/listexhibitorcontacttypes","metadata":{"seo":{"title":"Gets all of the exhibitor contact types in the system.","description":"This method will scan all exhibitor contact types and and return them to the caller."}},"httpPath":"/exhibitorContactTypes/{tenantId}"},{"label":"Creates a new exhibitor contact type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-contact-types/createexhibitorcontacttype","routeSlug":"/apis/events/events-v1/exhibitor-contact-types/createexhibitorcontacttype","metadata":{"seo":{"title":"Creates a new exhibitor contact type record that does not already exist.","description":"This method will auto-generate an ID and create a new exhibitor contact type. If an ID is specified for the exhibitor contact type, an error will be thrown."}},"httpPath":"/exhibitorContactTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-contact-types/executebatchoperations","routeSlug":"/apis/events/events-v1/exhibitor-contact-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/exhibitorContactTypes/{tenantId}/batch"},{"label":"Returns a exhibitor contact type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-contact-types/deleteexhibitorcontacttype","routeSlug":"/apis/events/events-v1/exhibitor-contact-types/deleteexhibitorcontacttype","metadata":{"seo":{"title":"Returns a exhibitor contact type from the system by its ID.","description":"This method will delete a exhibitor contact type with the specified ID."}},"httpPath":"/exhibitorContactTypes/{tenantId}/{id}"},{"label":"Returns a exhibitor contact type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-contact-types/getexhibitorcontacttype","routeSlug":"/apis/events/events-v1/exhibitor-contact-types/getexhibitorcontacttype","metadata":{"seo":{"title":"Returns a exhibitor contact type from the system by its ID.","description":"This method will look up a exhibitor contact type by the specified ID and return it back."}},"httpPath":"/exhibitorContactTypes/{tenantId}/{id}"},{"label":"Partially updates a exhibitor contact type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-contact-types/patchexhibitorcontacttype","routeSlug":"/apis/events/events-v1/exhibitor-contact-types/patchexhibitorcontacttype","metadata":{"seo":{"title":"Partially updates a exhibitor contact type with the specified ID.","description":"This method will patch an existing exhibitor contact type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/exhibitorContactTypes/{tenantId}/{id}"},{"label":"Updates a exhibitor contact type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-contact-types/updateexhibitorcontacttype","routeSlug":"/apis/events/events-v1/exhibitor-contact-types/updateexhibitorcontacttype","metadata":{"seo":{"title":"Updates a exhibitor contact type with the specified ID.","description":"This method will update an existing exhibitor contact type with the specified ID."}},"httpPath":"/exhibitorContactTypes/{tenantId}/{id}"}]},{"type":"group","label":"Exhibitor Priority Point Types","link":"/apis/events/events-v1/exhibitor-priority-point-types","routeSlug":"/apis/events/events-v1/exhibitor-priority-point-types","items":[{"label":"Gets all of the exhibitor priority point types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-priority-point-types/listexhibitorprioritypointtypes","routeSlug":"/apis/events/events-v1/exhibitor-priority-point-types/listexhibitorprioritypointtypes","metadata":{"seo":{"title":"Gets all of the exhibitor priority point types in the system.","description":"This method will scan all exhibitor priority point types and and return them to the caller."}},"httpPath":"/exhibitorPriorityPointTypes/{tenantId}"},{"label":"Creates a new exhibitor priority point type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-priority-point-types/createexhibitorprioritypointtype","routeSlug":"/apis/events/events-v1/exhibitor-priority-point-types/createexhibitorprioritypointtype","metadata":{"seo":{"title":"Creates a new exhibitor priority point type record that does not already exist.","description":"This method will auto-generate an ID and create a new exhibitor priority point type. If an ID is specified for the exhibitor priority point type, an error will be thrown."}},"httpPath":"/exhibitorPriorityPointTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-priority-point-types/executebatchoperations","routeSlug":"/apis/events/events-v1/exhibitor-priority-point-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/exhibitorPriorityPointTypes/{tenantId}/batch"},{"label":"Returns a exhibitor priority point type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-priority-point-types/deleteexhibitorprioritypointtype","routeSlug":"/apis/events/events-v1/exhibitor-priority-point-types/deleteexhibitorprioritypointtype","metadata":{"seo":{"title":"Returns a exhibitor priority point type from the system by its ID.","description":"This method will delete a exhibitor priority point type with the specified ID."}},"httpPath":"/exhibitorPriorityPointTypes/{tenantId}/{id}"},{"label":"Returns a exhibitor priority point type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-priority-point-types/getexhibitorprioritypointtype","routeSlug":"/apis/events/events-v1/exhibitor-priority-point-types/getexhibitorprioritypointtype","metadata":{"seo":{"title":"Returns a exhibitor priority point type from the system by its ID.","description":"This method will look up a exhibitor priority point type by the specified ID and return it back."}},"httpPath":"/exhibitorPriorityPointTypes/{tenantId}/{id}"},{"label":"Partially updates a exhibitor priority point type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-priority-point-types/patchexhibitorprioritypointtype","routeSlug":"/apis/events/events-v1/exhibitor-priority-point-types/patchexhibitorprioritypointtype","metadata":{"seo":{"title":"Partially updates a exhibitor priority point type with the specified ID.","description":"This method will patch an existing exhibitor priority point type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/exhibitorPriorityPointTypes/{tenantId}/{id}"},{"label":"Updates a exhibitor priority point type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-priority-point-types/updateexhibitorprioritypointtype","routeSlug":"/apis/events/events-v1/exhibitor-priority-point-types/updateexhibitorprioritypointtype","metadata":{"seo":{"title":"Updates a exhibitor priority point type with the specified ID.","description":"This method will update an existing exhibitor priority point type with the specified ID."}},"httpPath":"/exhibitorPriorityPointTypes/{tenantId}/{id}"}]},{"type":"group","label":"Exhibitor Reg Processes","link":"/apis/events/events-v1/exhibitor-reg-processes","routeSlug":"/apis/events/events-v1/exhibitor-reg-processes","items":[{"label":"Creates a new exhibitor reg process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-reg-processes/createexhibitorregprocess","routeSlug":"/apis/events/events-v1/exhibitor-reg-processes/createexhibitorregprocess","metadata":{"seo":{"title":"Creates a new exhibitor reg process record that does not already exist.","description":"This method will auto-generate an ID and create a new exhibitor reg process. If an ID is specified for the exhibitor reg process, an error will be thrown."}},"httpPath":"/exhibitorRegProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-reg-processes/executebatchoperations","routeSlug":"/apis/events/events-v1/exhibitor-reg-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/exhibitorRegProcesses/{tenantId}/batch"},{"label":"Get eligible processes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-reg-processes/geteligibleprocesses","routeSlug":"/apis/events/events-v1/exhibitor-reg-processes/geteligibleprocesses","metadata":{"seo":{"title":"Get eligible processes","description":"Get eligible processes"}},"httpPath":"/exhibitorRegProcesses/{tenantId}/eligible/{eventId}/{organizationId}"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-reg-processes/listprocessesbyeventid","routeSlug":"/apis/events/events-v1/exhibitor-reg-processes/listprocessesbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/exhibitorRegProcesses/{tenantId}/event/{event_id}"},{"label":"Returns a exhibitor reg process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-reg-processes/deleteexhibitorregprocess","routeSlug":"/apis/events/events-v1/exhibitor-reg-processes/deleteexhibitorregprocess","metadata":{"seo":{"title":"Returns a exhibitor reg process from the system by its ID.","description":"This method will delete a exhibitor reg process with the specified ID."}},"httpPath":"/exhibitorRegProcesses/{tenantId}/{id}"},{"label":"Returns a exhibitor reg process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-reg-processes/getexhibitorregprocess","routeSlug":"/apis/events/events-v1/exhibitor-reg-processes/getexhibitorregprocess","metadata":{"seo":{"title":"Returns a exhibitor reg process from the system by its ID.","description":"This method will look up a exhibitor reg process by the specified ID and return it back."}},"httpPath":"/exhibitorRegProcesses/{tenantId}/{id}"},{"label":"Partially updates a exhibitor reg process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-reg-processes/patchexhibitorregprocess","routeSlug":"/apis/events/events-v1/exhibitor-reg-processes/patchexhibitorregprocess","metadata":{"seo":{"title":"Partially updates a exhibitor reg process with the specified ID.","description":"This method will patch an existing exhibitor reg process with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/exhibitorRegProcesses/{tenantId}/{id}"},{"label":"Updates a exhibitor reg process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-reg-processes/updateexhibitorregprocess","routeSlug":"/apis/events/events-v1/exhibitor-reg-processes/updateexhibitorregprocess","metadata":{"seo":{"title":"Updates a exhibitor reg process with the specified ID.","description":"This method will update an existing exhibitor reg process with the specified ID."}},"httpPath":"/exhibitorRegProcesses/{tenantId}/{id}"}]},{"type":"group","label":"Exhibitor Registrations","link":"/apis/events/events-v1/exhibitor-registrations","routeSlug":"/apis/events/events-v1/exhibitor-registrations","items":[{"label":"Creates a new exhibitor registration record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-registrations/createexhibitorregistration","routeSlug":"/apis/events/events-v1/exhibitor-registrations/createexhibitorregistration","metadata":{"seo":{"title":"Creates a new exhibitor registration record that does not already exist.","description":"This method will auto-generate an ID and create a new exhibitor registration. If an ID is specified for the exhibitor registration, an error will be thrown."}},"httpPath":"/exhibitorRegistrations/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-registrations/executebatchoperations","routeSlug":"/apis/events/events-v1/exhibitor-registrations/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/exhibitorRegistrations/{tenantId}/batch"},{"label":"Returns a list of records with the specified exhibitor_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-registrations/listregistrationsbyexhibitorid","routeSlug":"/apis/events/events-v1/exhibitor-registrations/listregistrationsbyexhibitorid","metadata":{"seo":{"title":"Returns a list of records with the specified exhibitor_id","description":"Returns a list of records with the specified exhibitor_id"}},"httpPath":"/exhibitorRegistrations/{tenantId}/exhibitor/{exhibitor_id}"},{"label":"Generates an order from an exhibitor registration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-registrations/generateorder","routeSlug":"/apis/events/events-v1/exhibitor-registrations/generateorder","metadata":{"seo":{"title":"Generates an order from an exhibitor registration","description":"This method will examine an event registration and generate an appropriate order"}},"httpPath":"/exhibitorRegistrations/{tenantId}/generateOrder"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-registrations/listregistrationsbyorderid","routeSlug":"/apis/events/events-v1/exhibitor-registrations/listregistrationsbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"httpPath":"/exhibitorRegistrations/{tenantId}/order/{order_id}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-registrations/listregistrationsbyorganizationid","routeSlug":"/apis/events/events-v1/exhibitor-registrations/listregistrationsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/exhibitorRegistrations/{tenantId}/organization/{organization_id}"},{"label":"Validate Add Ons","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-registrations/validateaddons","routeSlug":"/apis/events/events-v1/exhibitor-registrations/validateaddons","metadata":{"seo":{"title":"Validate Add Ons","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/exhibitorRegistrations/{tenantId}/validateAddOns"},{"label":"Returns a exhibitor registration from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-registrations/deleteexhibitorregistration","routeSlug":"/apis/events/events-v1/exhibitor-registrations/deleteexhibitorregistration","metadata":{"seo":{"title":"Returns a exhibitor registration from the system by its ID.","description":"This method will delete a exhibitor registration with the specified ID."}},"httpPath":"/exhibitorRegistrations/{tenantId}/{id}"},{"label":"Returns a exhibitor registration from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-registrations/getexhibitorregistration","routeSlug":"/apis/events/events-v1/exhibitor-registrations/getexhibitorregistration","metadata":{"seo":{"title":"Returns a exhibitor registration from the system by its ID.","description":"This method will look up a exhibitor registration by the specified ID and return it back."}},"httpPath":"/exhibitorRegistrations/{tenantId}/{id}"},{"label":"Partially updates a exhibitor registration with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-registrations/patchexhibitorregistration","routeSlug":"/apis/events/events-v1/exhibitor-registrations/patchexhibitorregistration","metadata":{"seo":{"title":"Partially updates a exhibitor registration with the specified ID.","description":"This method will patch an existing exhibitor registration with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/exhibitorRegistrations/{tenantId}/{id}"},{"label":"Updates a exhibitor registration with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-registrations/updateexhibitorregistration","routeSlug":"/apis/events/events-v1/exhibitor-registrations/updateexhibitorregistration","metadata":{"seo":{"title":"Updates a exhibitor registration with the specified ID.","description":"This method will update an existing exhibitor registration with the specified ID."}},"httpPath":"/exhibitorRegistrations/{tenantId}/{id}"}]},{"type":"group","label":"Exhibitor Settings","link":"/apis/events/events-v1/exhibitor-settings","routeSlug":"/apis/events/events-v1/exhibitor-settings","items":[{"label":"Creates a new exhibitor setting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-settings/createexhibitorsetting","routeSlug":"/apis/events/events-v1/exhibitor-settings/createexhibitorsetting","metadata":{"seo":{"title":"Creates a new exhibitor setting record that does not already exist.","description":"This method will auto-generate an ID and create a new exhibitor setting. If an ID is specified for the exhibitor setting, an error will be thrown."}},"httpPath":"/exhibitorSettings/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-settings/executebatchoperations","routeSlug":"/apis/events/events-v1/exhibitor-settings/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/exhibitorSettings/{tenantId}/batch"},{"label":"Returns a exhibitor setting from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-settings/deleteexhibitorsetting","routeSlug":"/apis/events/events-v1/exhibitor-settings/deleteexhibitorsetting","metadata":{"seo":{"title":"Returns a exhibitor setting from the system by its ID.","description":"This method will delete a exhibitor setting with the specified ID."}},"httpPath":"/exhibitorSettings/{tenantId}/{id}"},{"label":"Returns a exhibitor setting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-settings/getexhibitorsetting","routeSlug":"/apis/events/events-v1/exhibitor-settings/getexhibitorsetting","metadata":{"seo":{"title":"Returns a exhibitor setting from the system by its ID.","description":"This method will look up a exhibitor setting by the specified ID and return it back."}},"httpPath":"/exhibitorSettings/{tenantId}/{id}"},{"label":"Partially updates a exhibitor setting with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-settings/patchexhibitorsetting","routeSlug":"/apis/events/events-v1/exhibitor-settings/patchexhibitorsetting","metadata":{"seo":{"title":"Partially updates a exhibitor setting with the specified ID.","description":"This method will patch an existing exhibitor setting with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/exhibitorSettings/{tenantId}/{id}"},{"label":"Updates a exhibitor setting with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-settings/updateexhibitorsetting","routeSlug":"/apis/events/events-v1/exhibitor-settings/updateexhibitorsetting","metadata":{"seo":{"title":"Updates a exhibitor setting with the specified ID.","description":"This method will update an existing exhibitor setting with the specified ID."}},"httpPath":"/exhibitorSettings/{tenantId}/{id}"}]},{"type":"group","label":"Exhibitor Show Floors","link":"/apis/events/events-v1/exhibitor-show-floors","routeSlug":"/apis/events/events-v1/exhibitor-show-floors","items":[{"label":"Creates a new exhibitor show floor record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-show-floors/createexhibitorshowfloor","routeSlug":"/apis/events/events-v1/exhibitor-show-floors/createexhibitorshowfloor","metadata":{"seo":{"title":"Creates a new exhibitor show floor record that does not already exist.","description":"This method will auto-generate an ID and create a new exhibitor show floor. If an ID is specified for the exhibitor show floor, an error will be thrown."}},"httpPath":"/exhibitorShowFloors/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-show-floors/executebatchoperations","routeSlug":"/apis/events/events-v1/exhibitor-show-floors/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/exhibitorShowFloors/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-show-floors/listfloorsbyeventid","routeSlug":"/apis/events/events-v1/exhibitor-show-floors/listfloorsbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/exhibitorShowFloors/{tenantId}/event/{event_id}"},{"label":"Returns a exhibitor show floor from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-show-floors/deleteexhibitorshowfloor","routeSlug":"/apis/events/events-v1/exhibitor-show-floors/deleteexhibitorshowfloor","metadata":{"seo":{"title":"Returns a exhibitor show floor from the system by its ID.","description":"This method will delete a exhibitor show floor with the specified ID."}},"httpPath":"/exhibitorShowFloors/{tenantId}/{id}"},{"label":"Returns a exhibitor show floor from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-show-floors/getexhibitorshowfloor","routeSlug":"/apis/events/events-v1/exhibitor-show-floors/getexhibitorshowfloor","metadata":{"seo":{"title":"Returns a exhibitor show floor from the system by its ID.","description":"This method will look up a exhibitor show floor by the specified ID and return it back."}},"httpPath":"/exhibitorShowFloors/{tenantId}/{id}"},{"label":"Partially updates a exhibitor show floor with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-show-floors/patchexhibitorshowfloor","routeSlug":"/apis/events/events-v1/exhibitor-show-floors/patchexhibitorshowfloor","metadata":{"seo":{"title":"Partially updates a exhibitor show floor with the specified ID.","description":"This method will patch an existing exhibitor show floor with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/exhibitorShowFloors/{tenantId}/{id}"},{"label":"Updates a exhibitor show floor with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitor-show-floors/updateexhibitorshowfloor","routeSlug":"/apis/events/events-v1/exhibitor-show-floors/updateexhibitorshowfloor","metadata":{"seo":{"title":"Updates a exhibitor show floor with the specified ID.","description":"This method will update an existing exhibitor show floor with the specified ID."}},"httpPath":"/exhibitorShowFloors/{tenantId}/{id}"}]},{"type":"group","label":"Exhibitors","link":"/apis/events/events-v1/exhibitors","routeSlug":"/apis/events/events-v1/exhibitors","items":[{"label":"Creates a new exhibitor record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitors/createexhibitor","routeSlug":"/apis/events/events-v1/exhibitors/createexhibitor","metadata":{"seo":{"title":"Creates a new exhibitor record that does not already exist.","description":"This method will auto-generate an ID and create a new exhibitor. If an ID is specified for the exhibitor, an error will be thrown."}},"httpPath":"/exhibitors/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitors/executebatchoperations","routeSlug":"/apis/events/events-v1/exhibitors/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/exhibitors/{tenantId}/batch"},{"label":"Gets the allowed number of contacts for an exhibitor registration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitors/getcontactallowanceforexhibitorregistration","routeSlug":"/apis/events/events-v1/exhibitors/getcontactallowanceforexhibitorregistration","metadata":{"seo":{"title":"Gets the allowed number of contacts for an exhibitor registration","description":"Applies the contact rule restrictions in exhibitor settings and determines how many contacts of each type an exhibitor is allowed to have"}},"httpPath":"/exhibitors/{tenantId}/contactAllowance"},{"label":"Gets the allowed number of contacts for an exhibitor","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitors/getcontactallowance","routeSlug":"/apis/events/events-v1/exhibitors/getcontactallowance","metadata":{"seo":{"title":"Gets the allowed number of contacts for an exhibitor","description":"Applies the contact rule restrictions in exhibitor settings and determines how many contacts of each type an exhibitor is allowed to have"}},"httpPath":"/exhibitors/{tenantId}/contactAllowance/{id}"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitors/listexhibitorsbyeventid","routeSlug":"/apis/events/events-v1/exhibitors/listexhibitorsbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/exhibitors/{tenantId}/event/{event_id}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitors/listexhibitorsbyorganizationid","routeSlug":"/apis/events/events-v1/exhibitors/listexhibitorsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/exhibitors/{tenantId}/organization/{organization_id}"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitors/listpublicexhibitorsbyeventid","routeSlug":"/apis/events/events-v1/exhibitors/listpublicexhibitorsbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/exhibitors/{tenantId}/public/event/{event_id}"},{"label":"Returns a exhibitor from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitors/deleteexhibitor","routeSlug":"/apis/events/events-v1/exhibitors/deleteexhibitor","metadata":{"seo":{"title":"Returns a exhibitor from the system by its ID.","description":"This method will delete a exhibitor with the specified ID."}},"httpPath":"/exhibitors/{tenantId}/{id}"},{"label":"Returns a exhibitor from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitors/getexhibitor","routeSlug":"/apis/events/events-v1/exhibitors/getexhibitor","metadata":{"seo":{"title":"Returns a exhibitor from the system by its ID.","description":"This method will look up a exhibitor by the specified ID and return it back."}},"httpPath":"/exhibitors/{tenantId}/{id}"},{"label":"Partially updates a exhibitor with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitors/patchexhibitor","routeSlug":"/apis/events/events-v1/exhibitors/patchexhibitor","metadata":{"seo":{"title":"Partially updates a exhibitor with the specified ID.","description":"This method will patch an existing exhibitor with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/exhibitors/{tenantId}/{id}"},{"label":"Updates a exhibitor with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/exhibitors/updateexhibitor","routeSlug":"/apis/events/events-v1/exhibitors/updateexhibitor","metadata":{"seo":{"title":"Updates a exhibitor with the specified ID.","description":"This method will update an existing exhibitor with the specified ID."}},"httpPath":"/exhibitors/{tenantId}/{id}"}]},{"type":"group","label":"Function Fees","link":"/apis/events/events-v1/function-fees","routeSlug":"/apis/events/events-v1/function-fees","items":[{"label":"Creates a new function fee record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-fees/createfunctionfee","routeSlug":"/apis/events/events-v1/function-fees/createfunctionfee","metadata":{"seo":{"title":"Creates a new function fee record that does not already exist.","description":"This method will auto-generate an ID and create a new function fee. If an ID is specified for the function fee, an error will be thrown."}},"httpPath":"/functionFees/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-fees/executebatchoperations","routeSlug":"/apis/events/events-v1/function-fees/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/functionFees/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-fees/listfeesbyeventid","routeSlug":"/apis/events/events-v1/function-fees/listfeesbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/functionFees/{tenantId}/event/{event_id}"},{"label":"Returns a list of records with the specified function_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-fees/listfeesbyfunctionid","routeSlug":"/apis/events/events-v1/function-fees/listfeesbyfunctionid","metadata":{"seo":{"title":"Returns a list of records with the specified function_id","description":"Returns a list of records with the specified function_id"}},"httpPath":"/functionFees/{tenantId}/function/{function_id}"},{"label":"Returns a function fee from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-fees/deletefunctionfee","routeSlug":"/apis/events/events-v1/function-fees/deletefunctionfee","metadata":{"seo":{"title":"Returns a function fee from the system by its ID.","description":"This method will delete a function fee with the specified ID."}},"httpPath":"/functionFees/{tenantId}/{id}"},{"label":"Returns a function fee from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-fees/getfunctionfee","routeSlug":"/apis/events/events-v1/function-fees/getfunctionfee","metadata":{"seo":{"title":"Returns a function fee from the system by its ID.","description":"This method will look up a function fee by the specified ID and return it back."}},"httpPath":"/functionFees/{tenantId}/{id}"},{"label":"Partially updates a function fee with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-fees/patchfunctionfee","routeSlug":"/apis/events/events-v1/function-fees/patchfunctionfee","metadata":{"seo":{"title":"Partially updates a function fee with the specified ID.","description":"This method will patch an existing function fee with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/functionFees/{tenantId}/{id}"},{"label":"Updates a function fee with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-fees/updatefunctionfee","routeSlug":"/apis/events/events-v1/function-fees/updatefunctionfee","metadata":{"seo":{"title":"Updates a function fee with the specified ID.","description":"This method will update an existing function fee with the specified ID."}},"httpPath":"/functionFees/{tenantId}/{id}"}]},{"type":"group","label":"Function Tickets","link":"/apis/events/events-v1/function-tickets","routeSlug":"/apis/events/events-v1/function-tickets","items":[{"label":"Creates a new function ticket record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-tickets/createfunctionticket","routeSlug":"/apis/events/events-v1/function-tickets/createfunctionticket","metadata":{"seo":{"title":"Creates a new function ticket record that does not already exist.","description":"This method will auto-generate an ID and create a new function ticket. If an ID is specified for the function ticket, an error will be thrown."}},"httpPath":"/functionTickets/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-tickets/executebatchoperations","routeSlug":"/apis/events/events-v1/function-tickets/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/functionTickets/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-tickets/listticketforcontactandevent","routeSlug":"/apis/events/events-v1/function-tickets/listticketforcontactandevent","metadata":{"seo":{"title":"Returns a list of records with the specified event_contact_id","description":"Returns a list of records with the specified event_contact_id"}},"httpPath":"/functionTickets/{tenantId}/eventContact/{eventId}/{idOfContact}"},{"label":"Returns a list of records with the specified function_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-tickets/listticketsbyfunctionid","routeSlug":"/apis/events/events-v1/function-tickets/listticketsbyfunctionid","metadata":{"seo":{"title":"Returns a list of records with the specified function_id","description":"Returns a list of records with the specified function_id"}},"httpPath":"/functionTickets/{tenantId}/function/{function_id}"},{"label":"Returns a function ticket from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-tickets/deletefunctionticket","routeSlug":"/apis/events/events-v1/function-tickets/deletefunctionticket","metadata":{"seo":{"title":"Returns a function ticket from the system by its ID.","description":"This method will delete a function ticket with the specified ID."}},"httpPath":"/functionTickets/{tenantId}/{id}"},{"label":"Returns a function ticket from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-tickets/getfunctionticket","routeSlug":"/apis/events/events-v1/function-tickets/getfunctionticket","metadata":{"seo":{"title":"Returns a function ticket from the system by its ID.","description":"This method will look up a function ticket by the specified ID and return it back."}},"httpPath":"/functionTickets/{tenantId}/{id}"},{"label":"Partially updates a function ticket with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-tickets/patchfunctionticket","routeSlug":"/apis/events/events-v1/function-tickets/patchfunctionticket","metadata":{"seo":{"title":"Partially updates a function ticket with the specified ID.","description":"This method will patch an existing function ticket with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/functionTickets/{tenantId}/{id}"},{"label":"Updates a function ticket with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-tickets/updatefunctionticket","routeSlug":"/apis/events/events-v1/function-tickets/updatefunctionticket","metadata":{"seo":{"title":"Updates a function ticket with the specified ID.","description":"This method will update an existing function ticket with the specified ID."}},"httpPath":"/functionTickets/{tenantId}/{id}"}]},{"type":"group","label":"Function Types","link":"/apis/events/events-v1/function-types","routeSlug":"/apis/events/events-v1/function-types","items":[{"label":"Gets all of the function types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-types/listfunctiontypes","routeSlug":"/apis/events/events-v1/function-types/listfunctiontypes","metadata":{"seo":{"title":"Gets all of the function types in the system.","description":"This method will scan all function types and and return them to the caller."}},"httpPath":"/functionTypes/{tenantId}"},{"label":"Creates a new function type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-types/createfunctiontype","routeSlug":"/apis/events/events-v1/function-types/createfunctiontype","metadata":{"seo":{"title":"Creates a new function type record that does not already exist.","description":"This method will auto-generate an ID and create a new function type. If an ID is specified for the function type, an error will be thrown."}},"httpPath":"/functionTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-types/executebatchoperations","routeSlug":"/apis/events/events-v1/function-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/functionTypes/{tenantId}/batch"},{"label":"Gets all of the function types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-types/listfunctiontypespublic","routeSlug":"/apis/events/events-v1/function-types/listfunctiontypespublic","metadata":{"seo":{"title":"Gets all of the function types in the system.","description":"This method will scan all function types and and return them to the caller."}},"httpPath":"/functionTypes/{tenantId}/public"},{"label":"Returns a function type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-types/deletefunctiontype","routeSlug":"/apis/events/events-v1/function-types/deletefunctiontype","metadata":{"seo":{"title":"Returns a function type from the system by its ID.","description":"This method will delete a function type with the specified ID."}},"httpPath":"/functionTypes/{tenantId}/{id}"},{"label":"Returns a function type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-types/getfunctiontype","routeSlug":"/apis/events/events-v1/function-types/getfunctiontype","metadata":{"seo":{"title":"Returns a function type from the system by its ID.","description":"This method will look up a function type by the specified ID and return it back."}},"httpPath":"/functionTypes/{tenantId}/{id}"},{"label":"Partially updates a function type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-types/patchfunctiontype","routeSlug":"/apis/events/events-v1/function-types/patchfunctiontype","metadata":{"seo":{"title":"Partially updates a function type with the specified ID.","description":"This method will patch an existing function type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/functionTypes/{tenantId}/{id}"},{"label":"Updates a function type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/function-types/updatefunctiontype","routeSlug":"/apis/events/events-v1/function-types/updatefunctiontype","metadata":{"seo":{"title":"Updates a function type with the specified ID.","description":"This method will update an existing function type with the specified ID."}},"httpPath":"/functionTypes/{tenantId}/{id}"}]},{"type":"group","label":"Functions","link":"/apis/events/events-v1/functions","routeSlug":"/apis/events/events-v1/functions","items":[{"label":"Creates a new function record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/functions/createfunction","routeSlug":"/apis/events/events-v1/functions/createfunction","metadata":{"seo":{"title":"Creates a new function record that does not already exist.","description":"This method will auto-generate an ID and create a new function. If an ID is specified for the function, an error will be thrown."}},"httpPath":"/functions/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/functions/executebatchoperations","routeSlug":"/apis/events/events-v1/functions/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/functions/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/functions/listfunctionsbyeventid","routeSlug":"/apis/events/events-v1/functions/listfunctionsbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/functions/{tenantId}/event/{event_id}"},{"label":"Describes all of the functions for an event","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/functions/describefunctionsforevent","routeSlug":"/apis/events/events-v1/functions/describefunctionsforevent","metadata":{"seo":{"title":"Describes all of the functions for an event","description":"Returns a list of records with the specified event_id"}},"httpPath":"/functions/{tenantId}/public/event/{event_id}"},{"label":"Returns a function from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/functions/publicgetfunction","routeSlug":"/apis/events/events-v1/functions/publicgetfunction","metadata":{"seo":{"title":"Returns a function from the system by its ID.","description":"This method will look up a function by the specified ID and return it back."}},"httpPath":"/functions/{tenantId}/public/{id}"},{"label":"Searches for functions using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/functions/searchforfunctions","routeSlug":"/apis/events/events-v1/functions/searchforfunctions","metadata":{"seo":{"title":"Searches for functions using predefined parameters","description":"Searches for functions using predefined parameters"}},"httpPath":"/functions/{tenantId}/search"},{"label":"Returns a function from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/functions/deletefunction","routeSlug":"/apis/events/events-v1/functions/deletefunction","metadata":{"seo":{"title":"Returns a function from the system by its ID.","description":"This method will delete a function with the specified ID."}},"httpPath":"/functions/{tenantId}/{id}"},{"label":"Returns a function from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/functions/getfunction","routeSlug":"/apis/events/events-v1/functions/getfunction","metadata":{"seo":{"title":"Returns a function from the system by its ID.","description":"This method will look up a function by the specified ID and return it back."}},"httpPath":"/functions/{tenantId}/{id}"},{"label":"Partially updates a function with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/functions/patchfunction","routeSlug":"/apis/events/events-v1/functions/patchfunction","metadata":{"seo":{"title":"Partially updates a function with the specified ID.","description":"This method will patch an existing function with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/functions/{tenantId}/{id}"},{"label":"Updates a function with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/functions/updatefunction","routeSlug":"/apis/events/events-v1/functions/updatefunction","metadata":{"seo":{"title":"Updates a function with the specified ID.","description":"This method will update an existing function with the specified ID."}},"httpPath":"/functions/{tenantId}/{id}"}]},{"type":"group","label":"Miscellaneous Events","link":"/apis/events/events-v1/miscellaneous-events","routeSlug":"/apis/events/events-v1/miscellaneous-events","items":[{"label":"Creates a new miscellaneous event record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/miscellaneous-events/createmiscellaneousevent","routeSlug":"/apis/events/events-v1/miscellaneous-events/createmiscellaneousevent","metadata":{"seo":{"title":"Creates a new miscellaneous event record that does not already exist.","description":"This method will auto-generate an ID and create a new miscellaneous event. If an ID is specified for the miscellaneous event, an error will be thrown."}},"httpPath":"/miscellaneousEvents/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/miscellaneous-events/executebatchoperations","routeSlug":"/apis/events/events-v1/miscellaneous-events/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/miscellaneousEvents/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/miscellaneous-events/listmiscellaneouseventsbyeventid","routeSlug":"/apis/events/events-v1/miscellaneous-events/listmiscellaneouseventsbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/miscellaneousEvents/{tenantId}/public/event/{event_id}"},{"label":"Returns a miscellaneous event from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/miscellaneous-events/deletemiscellaneousevent","routeSlug":"/apis/events/events-v1/miscellaneous-events/deletemiscellaneousevent","metadata":{"seo":{"title":"Returns a miscellaneous event from the system by its ID.","description":"This method will delete a miscellaneous event with the specified ID."}},"httpPath":"/miscellaneousEvents/{tenantId}/{id}"},{"label":"Returns a miscellaneous event from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/miscellaneous-events/getmiscellaneousevent","routeSlug":"/apis/events/events-v1/miscellaneous-events/getmiscellaneousevent","metadata":{"seo":{"title":"Returns a miscellaneous event from the system by its ID.","description":"This method will look up a miscellaneous event by the specified ID and return it back."}},"httpPath":"/miscellaneousEvents/{tenantId}/{id}"},{"label":"Partially updates a miscellaneous event with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/miscellaneous-events/patchmiscellaneousevent","routeSlug":"/apis/events/events-v1/miscellaneous-events/patchmiscellaneousevent","metadata":{"seo":{"title":"Partially updates a miscellaneous event with the specified ID.","description":"This method will patch an existing miscellaneous event with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/miscellaneousEvents/{tenantId}/{id}"},{"label":"Updates a miscellaneous event with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/miscellaneous-events/updatemiscellaneousevent","routeSlug":"/apis/events/events-v1/miscellaneous-events/updatemiscellaneousevent","metadata":{"seo":{"title":"Updates a miscellaneous event with the specified ID.","description":"This method will update an existing miscellaneous event with the specified ID."}},"httpPath":"/miscellaneousEvents/{tenantId}/{id}"}]},{"type":"group","label":"Priority Point Assignments","link":"/apis/events/events-v1/priority-point-assignments","routeSlug":"/apis/events/events-v1/priority-point-assignments","items":[{"label":"Creates a new priority point assignment record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/priority-point-assignments/createprioritypointassignment","routeSlug":"/apis/events/events-v1/priority-point-assignments/createprioritypointassignment","metadata":{"seo":{"title":"Creates a new priority point assignment record that does not already exist.","description":"This method will auto-generate an ID and create a new priority point assignment. If an ID is specified for the priority point assignment, an error will be thrown."}},"httpPath":"/priorityPointAssignments/{tenantId}"},{"label":"Recaculate Priority Point Accumulation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/priority-point-assignments/recalculateaccumulationrules","routeSlug":"/apis/events/events-v1/priority-point-assignments/recalculateaccumulationrules","metadata":{"seo":{"title":"Recaculate Priority Point Accumulation","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/priorityPointAssignments/{tenantId}/accumulation/recalculate"},{"label":"Tests Accumulation Rules","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/priority-point-assignments/testaccumulationrules","routeSlug":"/apis/events/events-v1/priority-point-assignments/testaccumulationrules","metadata":{"seo":{"title":"Tests Accumulation Rules","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/priorityPointAssignments/{tenantId}/accumulation/test/{organization_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/priority-point-assignments/executebatchoperations","routeSlug":"/apis/events/events-v1/priority-point-assignments/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/priorityPointAssignments/{tenantId}/batch"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/priority-point-assignments/listassignmentsbyorganizationid","routeSlug":"/apis/events/events-v1/priority-point-assignments/listassignmentsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/priorityPointAssignments/{tenantId}/organization/{organization_id}"},{"label":"Returns a priority point assignment from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/priority-point-assignments/deleteprioritypointassignment","routeSlug":"/apis/events/events-v1/priority-point-assignments/deleteprioritypointassignment","metadata":{"seo":{"title":"Returns a priority point assignment from the system by its ID.","description":"This method will delete a priority point assignment with the specified ID."}},"httpPath":"/priorityPointAssignments/{tenantId}/{id}"},{"label":"Returns a priority point assignment from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/priority-point-assignments/getprioritypointassignment","routeSlug":"/apis/events/events-v1/priority-point-assignments/getprioritypointassignment","metadata":{"seo":{"title":"Returns a priority point assignment from the system by its ID.","description":"This method will look up a priority point assignment by the specified ID and return it back."}},"httpPath":"/priorityPointAssignments/{tenantId}/{id}"},{"label":"Partially updates a priority point assignment with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/priority-point-assignments/patchprioritypointassignment","routeSlug":"/apis/events/events-v1/priority-point-assignments/patchprioritypointassignment","metadata":{"seo":{"title":"Partially updates a priority point assignment with the specified ID.","description":"This method will patch an existing priority point assignment with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/priorityPointAssignments/{tenantId}/{id}"},{"label":"Updates a priority point assignment with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/priority-point-assignments/updateprioritypointassignment","routeSlug":"/apis/events/events-v1/priority-point-assignments/updateprioritypointassignment","metadata":{"seo":{"title":"Updates a priority point assignment with the specified ID.","description":"This method will update an existing priority point assignment with the specified ID."}},"httpPath":"/priorityPointAssignments/{tenantId}/{id}"}]},{"type":"group","label":"Query Definitions","link":"/apis/events/events-v1/query-definitions","routeSlug":"/apis/events/events-v1/query-definitions","items":[{"label":"Returns a list of records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/query-definitions/getquerydefinitions","routeSlug":"/apis/events/events-v1/query-definitions/getquerydefinitions","metadata":{"seo":{"title":"Returns a list of records","description":"Returns a list of records"}},"httpPath":"/queryDefinitions/{tenantId}"}]},{"type":"group","label":"Registrant Directories","link":"/apis/events/events-v1/registrant-directories","routeSlug":"/apis/events/events-v1/registrant-directories","items":[{"label":"Creates a new registrant directory record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrant-directories/createregistrantdirectory","routeSlug":"/apis/events/events-v1/registrant-directories/createregistrantdirectory","metadata":{"seo":{"title":"Creates a new registrant directory record that does not already exist.","description":"This method will auto-generate an ID and create a new registrant directory. If an ID is specified for the registrant directory, an error will be thrown."}},"httpPath":"/registrantDirectories/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrant-directories/executebatchoperations","routeSlug":"/apis/events/events-v1/registrant-directories/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/registrantDirectories/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrant-directories/listdirectoriesbyeventid","routeSlug":"/apis/events/events-v1/registrant-directories/listdirectoriesbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/registrantDirectories/{tenantId}/event/{event_id}"},{"label":"Gets an entry in the directory","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrant-directories/getdirectoryentry","routeSlug":"/apis/events/events-v1/registrant-directories/getdirectoryentry","metadata":{"seo":{"title":"Gets an entry in the directory","description":"Gets an entry in the directory"}},"httpPath":"/registrantDirectories/{tenantId}/public/entry/{id}/{entryId}"},{"label":"Searches the directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrant-directories/searchpublicdirectory","routeSlug":"/apis/events/events-v1/registrant-directories/searchpublicdirectory","metadata":{"seo":{"title":"Searches the directory","description":"Searches the directory"}},"httpPath":"/registrantDirectories/{tenantId}/public/search/{id}"},{"label":"Sends a message to an entry in the directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrant-directories/senddirectorymessage","routeSlug":"/apis/events/events-v1/registrant-directories/senddirectorymessage","metadata":{"seo":{"title":"Sends a message to an entry in the directory","description":"Sends a message to an entry in the directory"}},"httpPath":"/registrantDirectories/{tenantId}/public/sendMessage/{directoryId}/{entryId}"},{"label":"Returns a registrant directory from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrant-directories/getpublicdirectory","routeSlug":"/apis/events/events-v1/registrant-directories/getpublicdirectory","metadata":{"seo":{"title":"Returns a registrant directory from the system by its ID.","description":"This method will look up a registrant directory by the specified ID and return it back."}},"httpPath":"/registrantDirectories/{tenantId}/public/{id}"},{"label":"Searches the directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrant-directories/searchdirectory","routeSlug":"/apis/events/events-v1/registrant-directories/searchdirectory","metadata":{"seo":{"title":"Searches the directory","description":"Searches the directory"}},"httpPath":"/registrantDirectories/{tenantId}/search/{id}"},{"label":"Returns a registrant directory from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrant-directories/deleteregistrantdirectory","routeSlug":"/apis/events/events-v1/registrant-directories/deleteregistrantdirectory","metadata":{"seo":{"title":"Returns a registrant directory from the system by its ID.","description":"This method will delete a registrant directory with the specified ID."}},"httpPath":"/registrantDirectories/{tenantId}/{id}"},{"label":"Returns a registrant directory from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrant-directories/getregistrantdirectory","routeSlug":"/apis/events/events-v1/registrant-directories/getregistrantdirectory","metadata":{"seo":{"title":"Returns a registrant directory from the system by its ID.","description":"This method will look up a registrant directory by the specified ID and return it back."}},"httpPath":"/registrantDirectories/{tenantId}/{id}"},{"label":"Partially updates a registrant directory with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrant-directories/patchregistrantdirectory","routeSlug":"/apis/events/events-v1/registrant-directories/patchregistrantdirectory","metadata":{"seo":{"title":"Partially updates a registrant directory with the specified ID.","description":"This method will patch an existing registrant directory with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/registrantDirectories/{tenantId}/{id}"},{"label":"Updates a registrant directory with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrant-directories/updateregistrantdirectory","routeSlug":"/apis/events/events-v1/registrant-directories/updateregistrantdirectory","metadata":{"seo":{"title":"Updates a registrant directory with the specified ID.","description":"This method will update an existing registrant directory with the specified ID."}},"httpPath":"/registrantDirectories/{tenantId}/{id}"}]},{"type":"group","label":"Registration Add On Products","link":"/apis/events/events-v1/registration-add-on-products","routeSlug":"/apis/events/events-v1/registration-add-on-products","items":[{"label":"Creates a new registration add on product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-add-on-products/createregistrationaddonproduct","routeSlug":"/apis/events/events-v1/registration-add-on-products/createregistrationaddonproduct","metadata":{"seo":{"title":"Creates a new registration add on product record that does not already exist.","description":"This method will auto-generate an ID and create a new registration add on product. If an ID is specified for the registration add on product, an error will be thrown."}},"httpPath":"/registrationAddOnProducts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-add-on-products/executebatchoperations","routeSlug":"/apis/events/events-v1/registration-add-on-products/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/registrationAddOnProducts/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-add-on-products/listproductsbyeventid","routeSlug":"/apis/events/events-v1/registration-add-on-products/listproductsbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/registrationAddOnProducts/{tenantId}/event/{event_id}"},{"label":"Returns a registration add on product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-add-on-products/deleteregistrationaddonproduct","routeSlug":"/apis/events/events-v1/registration-add-on-products/deleteregistrationaddonproduct","metadata":{"seo":{"title":"Returns a registration add on product from the system by its ID.","description":"This method will delete a registration add on product with the specified ID."}},"httpPath":"/registrationAddOnProducts/{tenantId}/{id}"},{"label":"Returns a registration add on product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-add-on-products/getregistrationaddonproduct","routeSlug":"/apis/events/events-v1/registration-add-on-products/getregistrationaddonproduct","metadata":{"seo":{"title":"Returns a registration add on product from the system by its ID.","description":"This method will look up a registration add on product by the specified ID and return it back."}},"httpPath":"/registrationAddOnProducts/{tenantId}/{id}"},{"label":"Partially updates a registration add on product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-add-on-products/patchregistrationaddonproduct","routeSlug":"/apis/events/events-v1/registration-add-on-products/patchregistrationaddonproduct","metadata":{"seo":{"title":"Partially updates a registration add on product with the specified ID.","description":"This method will patch an existing registration add on product with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/registrationAddOnProducts/{tenantId}/{id}"},{"label":"Updates a registration add on product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-add-on-products/updateregistrationaddonproduct","routeSlug":"/apis/events/events-v1/registration-add-on-products/updateregistrationaddonproduct","metadata":{"seo":{"title":"Updates a registration add on product with the specified ID.","description":"This method will update an existing registration add on product with the specified ID."}},"httpPath":"/registrationAddOnProducts/{tenantId}/{id}"}]},{"type":"group","label":"Registration Add On Types","link":"/apis/events/events-v1/registration-add-on-types","routeSlug":"/apis/events/events-v1/registration-add-on-types","items":[{"label":"Gets all of the registration add on types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-add-on-types/listregistrationaddontypes","routeSlug":"/apis/events/events-v1/registration-add-on-types/listregistrationaddontypes","metadata":{"seo":{"title":"Gets all of the registration add on types in the system.","description":"This method will scan all registration add on types and and return them to the caller."}},"httpPath":"/registrationAddOnTypes/{tenantId}"},{"label":"Creates a new registration add on type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-add-on-types/createregistrationaddontype","routeSlug":"/apis/events/events-v1/registration-add-on-types/createregistrationaddontype","metadata":{"seo":{"title":"Creates a new registration add on type record that does not already exist.","description":"This method will auto-generate an ID and create a new registration add on type. If an ID is specified for the registration add on type, an error will be thrown."}},"httpPath":"/registrationAddOnTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-add-on-types/executebatchoperations","routeSlug":"/apis/events/events-v1/registration-add-on-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/registrationAddOnTypes/{tenantId}/batch"},{"label":"Returns a registration add on type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-add-on-types/deleteregistrationaddontype","routeSlug":"/apis/events/events-v1/registration-add-on-types/deleteregistrationaddontype","metadata":{"seo":{"title":"Returns a registration add on type from the system by its ID.","description":"This method will delete a registration add on type with the specified ID."}},"httpPath":"/registrationAddOnTypes/{tenantId}/{id}"},{"label":"Returns a registration add on type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-add-on-types/getregistrationaddontype","routeSlug":"/apis/events/events-v1/registration-add-on-types/getregistrationaddontype","metadata":{"seo":{"title":"Returns a registration add on type from the system by its ID.","description":"This method will look up a registration add on type by the specified ID and return it back."}},"httpPath":"/registrationAddOnTypes/{tenantId}/{id}"},{"label":"Partially updates a registration add on type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-add-on-types/patchregistrationaddontype","routeSlug":"/apis/events/events-v1/registration-add-on-types/patchregistrationaddontype","metadata":{"seo":{"title":"Partially updates a registration add on type with the specified ID.","description":"This method will patch an existing registration add on type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/registrationAddOnTypes/{tenantId}/{id}"},{"label":"Updates a registration add on type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-add-on-types/updateregistrationaddontype","routeSlug":"/apis/events/events-v1/registration-add-on-types/updateregistrationaddontype","metadata":{"seo":{"title":"Updates a registration add on type with the specified ID.","description":"This method will update an existing registration add on type with the specified ID."}},"httpPath":"/registrationAddOnTypes/{tenantId}/{id}"}]},{"type":"group","label":"Registration Categories","link":"/apis/events/events-v1/registration-categories","routeSlug":"/apis/events/events-v1/registration-categories","items":[{"label":"Gets all of the registration categories in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-categories/listregistrationcategories","routeSlug":"/apis/events/events-v1/registration-categories/listregistrationcategories","metadata":{"seo":{"title":"Gets all of the registration categories in the system.","description":"This method will scan all registration categories and and return them to the caller."}},"httpPath":"/registrationCategories/{tenantId}"},{"label":"Creates a new registration category record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-categories/createregistrationcategory","routeSlug":"/apis/events/events-v1/registration-categories/createregistrationcategory","metadata":{"seo":{"title":"Creates a new registration category record that does not already exist.","description":"This method will auto-generate an ID and create a new registration category. If an ID is specified for the registration category, an error will be thrown."}},"httpPath":"/registrationCategories/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-categories/executebatchoperations","routeSlug":"/apis/events/events-v1/registration-categories/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/registrationCategories/{tenantId}/batch"},{"label":"Returns a registration category from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-categories/deleteregistrationcategory","routeSlug":"/apis/events/events-v1/registration-categories/deleteregistrationcategory","metadata":{"seo":{"title":"Returns a registration category from the system by its ID.","description":"This method will delete a registration category with the specified ID."}},"httpPath":"/registrationCategories/{tenantId}/{id}"},{"label":"Returns a registration category from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-categories/getregistrationcategory","routeSlug":"/apis/events/events-v1/registration-categories/getregistrationcategory","metadata":{"seo":{"title":"Returns a registration category from the system by its ID.","description":"This method will look up a registration category by the specified ID and return it back."}},"httpPath":"/registrationCategories/{tenantId}/{id}"},{"label":"Partially updates a registration category with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-categories/patchregistrationcategory","routeSlug":"/apis/events/events-v1/registration-categories/patchregistrationcategory","metadata":{"seo":{"title":"Partially updates a registration category with the specified ID.","description":"This method will patch an existing registration category with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/registrationCategories/{tenantId}/{id}"},{"label":"Updates a registration category with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-categories/updateregistrationcategory","routeSlug":"/apis/events/events-v1/registration-categories/updateregistrationcategory","metadata":{"seo":{"title":"Updates a registration category with the specified ID.","description":"This method will update an existing registration category with the specified ID."}},"httpPath":"/registrationCategories/{tenantId}/{id}"}]},{"type":"group","label":"Registration Change Fees","link":"/apis/events/events-v1/registration-change-fees","routeSlug":"/apis/events/events-v1/registration-change-fees","items":[{"label":"Gets all of the registration change fees in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-change-fees/listregistrationchangefees","routeSlug":"/apis/events/events-v1/registration-change-fees/listregistrationchangefees","metadata":{"seo":{"title":"Gets all of the registration change fees in the system.","description":"This method will scan all registration change fees and and return them to the caller."}},"httpPath":"/registrationChangeFees/{tenantId}"},{"label":"Creates a new registration change fee record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-change-fees/createregistrationchangefee","routeSlug":"/apis/events/events-v1/registration-change-fees/createregistrationchangefee","metadata":{"seo":{"title":"Creates a new registration change fee record that does not already exist.","description":"This method will auto-generate an ID and create a new registration change fee. If an ID is specified for the registration change fee, an error will be thrown."}},"httpPath":"/registrationChangeFees/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-change-fees/executebatchoperations","routeSlug":"/apis/events/events-v1/registration-change-fees/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/registrationChangeFees/{tenantId}/batch"},{"label":"Returns a registration change fee from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-change-fees/deleteregistrationchangefee","routeSlug":"/apis/events/events-v1/registration-change-fees/deleteregistrationchangefee","metadata":{"seo":{"title":"Returns a registration change fee from the system by its ID.","description":"This method will delete a registration change fee with the specified ID."}},"httpPath":"/registrationChangeFees/{tenantId}/{id}"},{"label":"Returns a registration change fee from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-change-fees/getregistrationchangefee","routeSlug":"/apis/events/events-v1/registration-change-fees/getregistrationchangefee","metadata":{"seo":{"title":"Returns a registration change fee from the system by its ID.","description":"This method will look up a registration change fee by the specified ID and return it back."}},"httpPath":"/registrationChangeFees/{tenantId}/{id}"},{"label":"Partially updates a registration change fee with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-change-fees/patchregistrationchangefee","routeSlug":"/apis/events/events-v1/registration-change-fees/patchregistrationchangefee","metadata":{"seo":{"title":"Partially updates a registration change fee with the specified ID.","description":"This method will patch an existing registration change fee with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/registrationChangeFees/{tenantId}/{id}"},{"label":"Updates a registration change fee with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-change-fees/updateregistrationchangefee","routeSlug":"/apis/events/events-v1/registration-change-fees/updateregistrationchangefee","metadata":{"seo":{"title":"Updates a registration change fee with the specified ID.","description":"This method will update an existing registration change fee with the specified ID."}},"httpPath":"/registrationChangeFees/{tenantId}/{id}"}]},{"type":"group","label":"Registration Deadlines","link":"/apis/events/events-v1/registration-deadlines","routeSlug":"/apis/events/events-v1/registration-deadlines","items":[{"label":"Gets all of the registration deadlines in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-deadlines/listregistrationdeadlines","routeSlug":"/apis/events/events-v1/registration-deadlines/listregistrationdeadlines","metadata":{"seo":{"title":"Gets all of the registration deadlines in the system.","description":"This method will scan all registration deadlines and and return them to the caller."}},"httpPath":"/registrationDeadlines/{tenantId}"},{"label":"Creates a new registration deadline record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-deadlines/createregistrationdeadline","routeSlug":"/apis/events/events-v1/registration-deadlines/createregistrationdeadline","metadata":{"seo":{"title":"Creates a new registration deadline record that does not already exist.","description":"This method will auto-generate an ID and create a new registration deadline. If an ID is specified for the registration deadline, an error will be thrown."}},"httpPath":"/registrationDeadlines/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-deadlines/executebatchoperations","routeSlug":"/apis/events/events-v1/registration-deadlines/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/registrationDeadlines/{tenantId}/batch"},{"label":"Returns a registration deadline from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-deadlines/deleteregistrationdeadline","routeSlug":"/apis/events/events-v1/registration-deadlines/deleteregistrationdeadline","metadata":{"seo":{"title":"Returns a registration deadline from the system by its ID.","description":"This method will delete a registration deadline with the specified ID."}},"httpPath":"/registrationDeadlines/{tenantId}/{id}"},{"label":"Returns a registration deadline from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-deadlines/getregistrationdeadline","routeSlug":"/apis/events/events-v1/registration-deadlines/getregistrationdeadline","metadata":{"seo":{"title":"Returns a registration deadline from the system by its ID.","description":"This method will look up a registration deadline by the specified ID and return it back."}},"httpPath":"/registrationDeadlines/{tenantId}/{id}"},{"label":"Partially updates a registration deadline with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-deadlines/patchregistrationdeadline","routeSlug":"/apis/events/events-v1/registration-deadlines/patchregistrationdeadline","metadata":{"seo":{"title":"Partially updates a registration deadline with the specified ID.","description":"This method will patch an existing registration deadline with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/registrationDeadlines/{tenantId}/{id}"},{"label":"Updates a registration deadline with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-deadlines/updateregistrationdeadline","routeSlug":"/apis/events/events-v1/registration-deadlines/updateregistrationdeadline","metadata":{"seo":{"title":"Updates a registration deadline with the specified ID.","description":"This method will update an existing registration deadline with the specified ID."}},"httpPath":"/registrationDeadlines/{tenantId}/{id}"}]},{"type":"group","label":"Registration Groups","link":"/apis/events/events-v1/registration-groups","routeSlug":"/apis/events/events-v1/registration-groups","items":[{"label":"Creates a new registration group record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-groups/createregistrationgroup","routeSlug":"/apis/events/events-v1/registration-groups/createregistrationgroup","metadata":{"seo":{"title":"Creates a new registration group record that does not already exist.","description":"This method will auto-generate an ID and create a new registration group. If an ID is specified for the registration group, an error will be thrown."}},"httpPath":"/registrationGroups/{tenantId}"},{"label":"Returns a list of records with the specified administrator_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-groups/listgroupsbyadministratorid","routeSlug":"/apis/events/events-v1/registration-groups/listgroupsbyadministratorid","metadata":{"seo":{"title":"Returns a list of records with the specified administrator_id","description":"Returns a list of records with the specified administrator_id"}},"httpPath":"/registrationGroups/{tenantId}/administrator/{event_id}/{administrator_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-groups/executebatchoperations","routeSlug":"/apis/events/events-v1/registration-groups/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/registrationGroups/{tenantId}/batch"},{"label":"Returns a list of records with the specified administrator_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-groups/getgroupcontact","routeSlug":"/apis/events/events-v1/registration-groups/getgroupcontact","metadata":{"seo":{"title":"Returns a list of records with the specified administrator_id","description":"Returns a list of records with the specified administrator_id"}},"httpPath":"/registrationGroups/{tenantId}/contact/{groupId}/{administratorId}/{contactId}"},{"label":"Searches for registration groups using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-groups/searchforregistrationgroups","routeSlug":"/apis/events/events-v1/registration-groups/searchforregistrationgroups","metadata":{"seo":{"title":"Searches for registration groups using predefined parameters","description":"Searches for registration groups using predefined parameters"}},"httpPath":"/registrationGroups/{tenantId}/search"},{"label":"Returns a registration group from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-groups/deleteregistrationgroup","routeSlug":"/apis/events/events-v1/registration-groups/deleteregistrationgroup","metadata":{"seo":{"title":"Returns a registration group from the system by its ID.","description":"This method will delete a registration group with the specified ID."}},"httpPath":"/registrationGroups/{tenantId}/{id}"},{"label":"Returns a registration group from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-groups/getregistrationgroup","routeSlug":"/apis/events/events-v1/registration-groups/getregistrationgroup","metadata":{"seo":{"title":"Returns a registration group from the system by its ID.","description":"This method will look up a registration group by the specified ID and return it back."}},"httpPath":"/registrationGroups/{tenantId}/{id}"},{"label":"Partially updates a registration group with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-groups/patchregistrationgroup","routeSlug":"/apis/events/events-v1/registration-groups/patchregistrationgroup","metadata":{"seo":{"title":"Partially updates a registration group with the specified ID.","description":"This method will patch an existing registration group with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/registrationGroups/{tenantId}/{id}"},{"label":"Updates a registration group with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-groups/updateregistrationgroup","routeSlug":"/apis/events/events-v1/registration-groups/updateregistrationgroup","metadata":{"seo":{"title":"Updates a registration group with the specified ID.","description":"This method will update an existing registration group with the specified ID."}},"httpPath":"/registrationGroups/{tenantId}/{id}"}]},{"type":"group","label":"Registration Packages","link":"/apis/events/events-v1/registration-packages","routeSlug":"/apis/events/events-v1/registration-packages","items":[{"label":"Creates a new registration package record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-packages/createregistrationpackage","routeSlug":"/apis/events/events-v1/registration-packages/createregistrationpackage","metadata":{"seo":{"title":"Creates a new registration package record that does not already exist.","description":"This method will auto-generate an ID and create a new registration package. If an ID is specified for the registration package, an error will be thrown."}},"httpPath":"/registrationPackages/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-packages/executebatchoperations","routeSlug":"/apis/events/events-v1/registration-packages/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/registrationPackages/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-packages/listpackagesbyeventid","routeSlug":"/apis/events/events-v1/registration-packages/listpackagesbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/registrationPackages/{tenantId}/event/{event_id}"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-packages/listpackagesbyeventidpublic","routeSlug":"/apis/events/events-v1/registration-packages/listpackagesbyeventidpublic","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/registrationPackages/{tenantId}/public/event/{event_id}"},{"label":"Get Packages for Online Store","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-packages/getpackagesforonlinestore","routeSlug":"/apis/events/events-v1/registration-packages/getpackagesforonlinestore","metadata":{"seo":{"title":"Get Packages for Online Store","description":"Public endpoint that gets packages for use in the online store"}},"httpPath":"/registrationPackages/{tenantId}/public/onlineStore"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-packages/getrateschedule","routeSlug":"/apis/events/events-v1/registration-packages/getrateschedule","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/registrationPackages/{tenantId}/public/rateSchedule/{eventId}"},{"label":"Returns a registration package from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-packages/deleteregistrationpackage","routeSlug":"/apis/events/events-v1/registration-packages/deleteregistrationpackage","metadata":{"seo":{"title":"Returns a registration package from the system by its ID.","description":"This method will delete a registration package with the specified ID."}},"httpPath":"/registrationPackages/{tenantId}/{id}"},{"label":"Returns a registration package from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-packages/getregistrationpackage","routeSlug":"/apis/events/events-v1/registration-packages/getregistrationpackage","metadata":{"seo":{"title":"Returns a registration package from the system by its ID.","description":"This method will look up a registration package by the specified ID and return it back."}},"httpPath":"/registrationPackages/{tenantId}/{id}"},{"label":"Partially updates a registration package with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-packages/patchregistrationpackage","routeSlug":"/apis/events/events-v1/registration-packages/patchregistrationpackage","metadata":{"seo":{"title":"Partially updates a registration package with the specified ID.","description":"This method will patch an existing registration package with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/registrationPackages/{tenantId}/{id}"},{"label":"Updates a registration package with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-packages/updateregistrationpackage","routeSlug":"/apis/events/events-v1/registration-packages/updateregistrationpackage","metadata":{"seo":{"title":"Updates a registration package with the specified ID.","description":"This method will update an existing registration package with the specified ID."}},"httpPath":"/registrationPackages/{tenantId}/{id}"}]},{"type":"group","label":"Registration Processes","link":"/apis/events/events-v1/registration-processes","routeSlug":"/apis/events/events-v1/registration-processes","items":[{"label":"Gets all of the registration processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-processes/listregistrationprocesses","routeSlug":"/apis/events/events-v1/registration-processes/listregistrationprocesses","metadata":{"seo":{"title":"Gets all of the registration processes in the system.","description":"This method will scan all registration processes and and return them to the caller."}},"httpPath":"/registrationProcesses/{tenantId}"},{"label":"Creates a new registration process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-processes/createregistrationprocess","routeSlug":"/apis/events/events-v1/registration-processes/createregistrationprocess","metadata":{"seo":{"title":"Creates a new registration process record that does not already exist.","description":"This method will auto-generate an ID and create a new registration process. If an ID is specified for the registration process, an error will be thrown."}},"httpPath":"/registrationProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-processes/executebatchoperations","routeSlug":"/apis/events/events-v1/registration-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/registrationProcesses/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-processes/listprocessesbyeventid","routeSlug":"/apis/events/events-v1/registration-processes/listprocessesbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/registrationProcesses/{tenantId}/event/{event_id}"},{"label":"Returns a registration process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-processes/deleteregistrationprocess","routeSlug":"/apis/events/events-v1/registration-processes/deleteregistrationprocess","metadata":{"seo":{"title":"Returns a registration process from the system by its ID.","description":"This method will delete a registration process with the specified ID."}},"httpPath":"/registrationProcesses/{tenantId}/{id}"},{"label":"Returns a registration process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-processes/getregistrationprocess","routeSlug":"/apis/events/events-v1/registration-processes/getregistrationprocess","metadata":{"seo":{"title":"Returns a registration process from the system by its ID.","description":"This method will look up a registration process by the specified ID and return it back."}},"httpPath":"/registrationProcesses/{tenantId}/{id}"},{"label":"Partially updates a registration process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-processes/patchregistrationprocess","routeSlug":"/apis/events/events-v1/registration-processes/patchregistrationprocess","metadata":{"seo":{"title":"Partially updates a registration process with the specified ID.","description":"This method will patch an existing registration process with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/registrationProcesses/{tenantId}/{id}"},{"label":"Updates a registration process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-processes/updateregistrationprocess","routeSlug":"/apis/events/events-v1/registration-processes/updateregistrationprocess","metadata":{"seo":{"title":"Updates a registration process with the specified ID.","description":"This method will update an existing registration process with the specified ID."}},"httpPath":"/registrationProcesses/{tenantId}/{id}"}]},{"type":"group","label":"Registration Settings","link":"/apis/events/events-v1/registration-settings","routeSlug":"/apis/events/events-v1/registration-settings","items":[{"label":"Creates a new registration setting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-settings/createregistrationsetting","routeSlug":"/apis/events/events-v1/registration-settings/createregistrationsetting","metadata":{"seo":{"title":"Creates a new registration setting record that does not already exist.","description":"This method will auto-generate an ID and create a new registration setting. If an ID is specified for the registration setting, an error will be thrown."}},"httpPath":"/registrationSettings/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-settings/executebatchoperations","routeSlug":"/apis/events/events-v1/registration-settings/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/registrationSettings/{tenantId}/batch"},{"label":"Returns a registration setting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-settings/getregistrationsettingpublic","routeSlug":"/apis/events/events-v1/registration-settings/getregistrationsettingpublic","metadata":{"seo":{"title":"Returns a registration setting from the system by its ID.","description":"This method will look up a registration setting by the specified ID and return it back."}},"httpPath":"/registrationSettings/{tenantId}/public/{id}"},{"label":"Returns a registration setting from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-settings/deleteregistrationsetting","routeSlug":"/apis/events/events-v1/registration-settings/deleteregistrationsetting","metadata":{"seo":{"title":"Returns a registration setting from the system by its ID.","description":"This method will delete a registration setting with the specified ID."}},"httpPath":"/registrationSettings/{tenantId}/{id}"},{"label":"Returns a registration setting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-settings/getregistrationsetting","routeSlug":"/apis/events/events-v1/registration-settings/getregistrationsetting","metadata":{"seo":{"title":"Returns a registration setting from the system by its ID.","description":"This method will look up a registration setting by the specified ID and return it back."}},"httpPath":"/registrationSettings/{tenantId}/{id}"},{"label":"Partially updates a registration setting with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-settings/patchregistrationsetting","routeSlug":"/apis/events/events-v1/registration-settings/patchregistrationsetting","metadata":{"seo":{"title":"Partially updates a registration setting with the specified ID.","description":"This method will patch an existing registration setting with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/registrationSettings/{tenantId}/{id}"},{"label":"Updates a registration setting with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-settings/updateregistrationsetting","routeSlug":"/apis/events/events-v1/registration-settings/updateregistrationsetting","metadata":{"seo":{"title":"Updates a registration setting with the specified ID.","description":"This method will update an existing registration setting with the specified ID."}},"httpPath":"/registrationSettings/{tenantId}/{id}"}]},{"type":"group","label":"Registration Substitutions","link":"/apis/events/events-v1/registration-substitutions","routeSlug":"/apis/events/events-v1/registration-substitutions","items":[{"label":"Creates a new registration substitution record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-substitutions/createregistrationsubstitution","routeSlug":"/apis/events/events-v1/registration-substitutions/createregistrationsubstitution","metadata":{"seo":{"title":"Creates a new registration substitution record that does not already exist.","description":"This method will auto-generate an ID and create a new registration substitution. If an ID is specified for the registration substitution, an error will be thrown."}},"httpPath":"/registrationSubstitutions/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-substitutions/executebatchoperations","routeSlug":"/apis/events/events-v1/registration-substitutions/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/registrationSubstitutions/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-substitutions/listsubstitutionsbyeventid","routeSlug":"/apis/events/events-v1/registration-substitutions/listsubstitutionsbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/registrationSubstitutions/{tenantId}/event/{event_id}"},{"label":"Returns a list of records with the specified new_contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-substitutions/listsubstitutionsbynewcontactid","routeSlug":"/apis/events/events-v1/registration-substitutions/listsubstitutionsbynewcontactid","metadata":{"seo":{"title":"Returns a list of records with the specified new_contact_id","description":"Returns a list of records with the specified new_contact_id"}},"httpPath":"/registrationSubstitutions/{tenantId}/newContact/{new_contact_id}"},{"label":"Returns a list of records with the specified previous_contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-substitutions/listsubstitutionsbypreviouscontactid","routeSlug":"/apis/events/events-v1/registration-substitutions/listsubstitutionsbypreviouscontactid","metadata":{"seo":{"title":"Returns a list of records with the specified previous_contact_id","description":"Returns a list of records with the specified previous_contact_id"}},"httpPath":"/registrationSubstitutions/{tenantId}/previousContact/{previous_contact_id}"},{"label":"Returns a list of records with the specified registration_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-substitutions/listsubstitutionsbyregistrationid","routeSlug":"/apis/events/events-v1/registration-substitutions/listsubstitutionsbyregistrationid","metadata":{"seo":{"title":"Returns a list of records with the specified registration_id","description":"Returns a list of records with the specified registration_id"}},"httpPath":"/registrationSubstitutions/{tenantId}/registration/{registration_id}"},{"label":"Returns a registration substitution from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-substitutions/deleteregistrationsubstitution","routeSlug":"/apis/events/events-v1/registration-substitutions/deleteregistrationsubstitution","metadata":{"seo":{"title":"Returns a registration substitution from the system by its ID.","description":"This method will delete a registration substitution with the specified ID."}},"httpPath":"/registrationSubstitutions/{tenantId}/{id}"},{"label":"Returns a registration substitution from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-substitutions/getregistrationsubstitution","routeSlug":"/apis/events/events-v1/registration-substitutions/getregistrationsubstitution","metadata":{"seo":{"title":"Returns a registration substitution from the system by its ID.","description":"This method will look up a registration substitution by the specified ID and return it back."}},"httpPath":"/registrationSubstitutions/{tenantId}/{id}"},{"label":"Partially updates a registration substitution with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-substitutions/patchregistrationsubstitution","routeSlug":"/apis/events/events-v1/registration-substitutions/patchregistrationsubstitution","metadata":{"seo":{"title":"Partially updates a registration substitution with the specified ID.","description":"This method will patch an existing registration substitution with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/registrationSubstitutions/{tenantId}/{id}"},{"label":"Updates a registration substitution with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-substitutions/updateregistrationsubstitution","routeSlug":"/apis/events/events-v1/registration-substitutions/updateregistrationsubstitution","metadata":{"seo":{"title":"Updates a registration substitution with the specified ID.","description":"This method will update an existing registration substitution with the specified ID."}},"httpPath":"/registrationSubstitutions/{tenantId}/{id}"}]},{"type":"group","label":"Registration Types","link":"/apis/events/events-v1/registration-types","routeSlug":"/apis/events/events-v1/registration-types","items":[{"label":"Creates a new registration type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-types/createregistrationtype","routeSlug":"/apis/events/events-v1/registration-types/createregistrationtype","metadata":{"seo":{"title":"Creates a new registration type record that does not already exist.","description":"This method will auto-generate an ID and create a new registration type. If an ID is specified for the registration type, an error will be thrown."}},"httpPath":"/registrationTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-types/executebatchoperations","routeSlug":"/apis/events/events-v1/registration-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/registrationTypes/{tenantId}/batch"},{"label":"Check Coupon Access","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-types/checkcouponaccess","routeSlug":"/apis/events/events-v1/registration-types/checkcouponaccess","metadata":{"seo":{"title":"Check Coupon Access","description":"Checks to see whether or not a person can access a registration type with a coupon"}},"httpPath":"/registrationTypes/{tenantId}/couponAccess/{id}"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-types/listtypesbyeventid","routeSlug":"/apis/events/events-v1/registration-types/listtypesbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/registrationTypes/{tenantId}/event/{event_id}"},{"label":"Returns a list of registration types for the specified contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-types/getapplicabletypesforcontact","routeSlug":"/apis/events/events-v1/registration-types/getapplicabletypesforcontact","metadata":{"seo":{"title":"Returns a list of registration types for the specified contact","description":"Returns a list of registration types for the specified contact"}},"httpPath":"/registrationTypes/{tenantId}/event/{event_id}/portal/{contact_id}"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-types/listtypesbyeventidpublic","routeSlug":"/apis/events/events-v1/registration-types/listtypesbyeventidpublic","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/registrationTypes/{tenantId}/public/event/{event_id}"},{"label":"Returns a registration type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-types/deleteregistrationtype","routeSlug":"/apis/events/events-v1/registration-types/deleteregistrationtype","metadata":{"seo":{"title":"Returns a registration type from the system by its ID.","description":"This method will delete a registration type with the specified ID."}},"httpPath":"/registrationTypes/{tenantId}/{id}"},{"label":"Returns a registration type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-types/getregistrationtype","routeSlug":"/apis/events/events-v1/registration-types/getregistrationtype","metadata":{"seo":{"title":"Returns a registration type from the system by its ID.","description":"This method will look up a registration type by the specified ID and return it back."}},"httpPath":"/registrationTypes/{tenantId}/{id}"},{"label":"Partially updates a registration type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-types/patchregistrationtype","routeSlug":"/apis/events/events-v1/registration-types/patchregistrationtype","metadata":{"seo":{"title":"Partially updates a registration type with the specified ID.","description":"This method will patch an existing registration type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/registrationTypes/{tenantId}/{id}"},{"label":"Updates a registration type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registration-types/updateregistrationtype","routeSlug":"/apis/events/events-v1/registration-types/updateregistrationtype","metadata":{"seo":{"title":"Updates a registration type with the specified ID.","description":"This method will update an existing registration type with the specified ID."}},"httpPath":"/registrationTypes/{tenantId}/{id}"}]},{"type":"group","label":"Registrations","link":"/apis/events/events-v1/registrations","routeSlug":"/apis/events/events-v1/registrations","items":[{"label":"Creates a new registration record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/createregistration","routeSlug":"/apis/events/events-v1/registrations/createregistration","metadata":{"seo":{"title":"Creates a new registration record that does not already exist.","description":"This method will auto-generate an ID and create a new registration. If an ID is specified for the registration, an error will be thrown."}},"httpPath":"/registrations/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/executebatchoperations","routeSlug":"/apis/events/events-v1/registrations/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/registrations/{tenantId}/batch"},{"label":"Downloads a Certificate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/downloadcertificate","routeSlug":"/apis/events/events-v1/registrations/downloadcertificate","metadata":{"seo":{"title":"Downloads a Certificate","description":"Returns the HTML for the certificate"}},"httpPath":"/registrations/{tenantId}/certificate/{id}"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/listregistrationsbycontactid","routeSlug":"/apis/events/events-v1/registrations/listregistrationsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/registrations/{tenantId}/contact/{contact_id}"},{"label":"Self Cancel Registration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/describeselfcancellation","routeSlug":"/apis/events/events-v1/registrations/describeselfcancellation","metadata":{"seo":{"title":"Self Cancel Registration","description":"This method will examine an event registration and generate an appropriate order"}},"httpPath":"/registrations/{tenantId}/describeSelfCancellation/{id}"},{"label":"Returns a list of records with the specified event_contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/listregistrationsbyeventcontactid","routeSlug":"/apis/events/events-v1/registrations/listregistrationsbyeventcontactid","metadata":{"seo":{"title":"Returns a list of records with the specified event_contact_id","description":"Returns a list of records with the specified event_contact_id"}},"httpPath":"/registrations/{tenantId}/eventContact/{eventId}/{contactId}"},{"label":"Returns a list of records with the specified event_organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/listregistrationsbyeventorganizationid","routeSlug":"/apis/events/events-v1/registrations/listregistrationsbyeventorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified event_organization_id","description":"Returns a list of records with the specified event_organization_id"}},"httpPath":"/registrations/{tenantId}/eventOrganization/{eventId}/{organizationId}"},{"label":"Generates an order for a registration group","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/generategrouporder","routeSlug":"/apis/events/events-v1/registrations/generategrouporder","metadata":{"seo":{"title":"Generates an order for a registration group","description":"Generates an order for a registration group"}},"httpPath":"/registrations/{tenantId}/generateGroupOrder/{groupId}"},{"label":"Generates an order from an event registration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/generateorder","routeSlug":"/apis/events/events-v1/registrations/generateorder","metadata":{"seo":{"title":"Generates an order from an event registration","description":"This method will examine an event registration and generate an appropriate order"}},"httpPath":"/registrations/{tenantId}/generateOrder"},{"label":"Returns a list of records with the specified group_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/listregistrationsbygroupid","routeSlug":"/apis/events/events-v1/registrations/listregistrationsbygroupid","metadata":{"seo":{"title":"Returns a list of records with the specified group_id","description":"Returns a list of records with the specified group_id"}},"httpPath":"/registrations/{tenantId}/group/{group_id}"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/listregistrationsbyorderid","routeSlug":"/apis/events/events-v1/registrations/listregistrationsbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"httpPath":"/registrations/{tenantId}/order/{order_id}"},{"label":"Returns a list of records with the specified parent_registration_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/listregistrationsbyparentregistrationid","routeSlug":"/apis/events/events-v1/registrations/listregistrationsbyparentregistrationid","metadata":{"seo":{"title":"Returns a list of records with the specified parent_registration_id","description":"Returns a list of records with the specified parent_registration_id"}},"httpPath":"/registrations/{tenantId}/parentRegistration/{parent_registration_id}"},{"label":"Examines a registration and detects any potential scheduling conflicts in the registration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/detectschedulingconflicts","routeSlug":"/apis/events/events-v1/registrations/detectschedulingconflicts","metadata":{"seo":{"title":"Examines a registration and detects any potential scheduling conflicts in the registration","description":"Examines a registration and detects any potential scheduling conflicts in the registration"}},"httpPath":"/registrations/{tenantId}/portal/detectSchedulingConflicts"},{"label":"Sends out a preview of the CRC notification certificate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/previewcertificate","routeSlug":"/apis/events/events-v1/registrations/previewcertificate","metadata":{"seo":{"title":"Sends out a preview of the CRC notification certificate","description":"Sends out a preview of the CRC notification certificate"}},"httpPath":"/registrations/{tenantId}/previewCertificate"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/previewemail","routeSlug":"/apis/events/events-v1/registrations/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/registrations/{tenantId}/previewEmail"},{"label":"Generates the payload necessary to edit a registration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/generateregistrationmodificationpayload","routeSlug":"/apis/events/events-v1/registrations/generateregistrationmodificationpayload","metadata":{"seo":{"title":"Generates the payload necessary to edit a registration","description":"This method will examine an event registration and generate an appropriate order"}},"httpPath":"/registrations/{tenantId}/registrationModificationPayload/{id}"},{"label":"Resends the confirmation email for a registration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/resendconfirmationemail","routeSlug":"/apis/events/events-v1/registrations/resendconfirmationemail","metadata":{"seo":{"title":"Resends the confirmation email for a registration","description":"Resends the confirmation email for a registration"}},"httpPath":"/registrations/{tenantId}/resendConfirmationEmail/{registration_id}"},{"label":"Searches for registrations using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/searchforregistrations","routeSlug":"/apis/events/events-v1/registrations/searchforregistrations","metadata":{"seo":{"title":"Searches for registrations using predefined parameters","description":"Searches for registrations using predefined parameters"}},"httpPath":"/registrations/{tenantId}/search"},{"label":"Self Cancel Registration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/performselfcancellation","routeSlug":"/apis/events/events-v1/registrations/performselfcancellation","metadata":{"seo":{"title":"Self Cancel Registration","description":"This method will examine an event registration and generate an appropriate order"}},"httpPath":"/registrations/{tenantId}/selfCancelRegistration/{id}"},{"label":"Transfers a registration","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/transferregistration","routeSlug":"/apis/events/events-v1/registrations/transferregistration","metadata":{"seo":{"title":"Transfers a registration","description":"Transfers a registration registration from one contact to another, and updates downstream session, tickets, and course registrations"}},"httpPath":"/registrations/{tenantId}/transfer/{id}/{contactId}"},{"label":"Returns a registration from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/deleteregistration","routeSlug":"/apis/events/events-v1/registrations/deleteregistration","metadata":{"seo":{"title":"Returns a registration from the system by its ID.","description":"This method will delete a registration with the specified ID."}},"httpPath":"/registrations/{tenantId}/{id}"},{"label":"Returns a registration from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/getregistration","routeSlug":"/apis/events/events-v1/registrations/getregistration","metadata":{"seo":{"title":"Returns a registration from the system by its ID.","description":"This method will look up a registration by the specified ID and return it back."}},"httpPath":"/registrations/{tenantId}/{id}"},{"label":"Partially updates a registration with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/patchregistration","routeSlug":"/apis/events/events-v1/registrations/patchregistration","metadata":{"seo":{"title":"Partially updates a registration with the specified ID.","description":"This method will patch an existing registration with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/registrations/{tenantId}/{id}"},{"label":"Updates a registration with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/registrations/updateregistration","routeSlug":"/apis/events/events-v1/registrations/updateregistration","metadata":{"seo":{"title":"Updates a registration with the specified ID.","description":"This method will update an existing registration with the specified ID."}},"httpPath":"/registrations/{tenantId}/{id}"}]},{"type":"group","label":"Ribbon Types","link":"/apis/events/events-v1/ribbon-types","routeSlug":"/apis/events/events-v1/ribbon-types","items":[{"label":"Gets all of the ribbon types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/ribbon-types/listribbontypes","routeSlug":"/apis/events/events-v1/ribbon-types/listribbontypes","metadata":{"seo":{"title":"Gets all of the ribbon types in the system.","description":"This method will scan all ribbon types and and return them to the caller."}},"httpPath":"/ribbonTypes/{tenantId}"},{"label":"Creates a new ribbon type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/ribbon-types/createribbontype","routeSlug":"/apis/events/events-v1/ribbon-types/createribbontype","metadata":{"seo":{"title":"Creates a new ribbon type record that does not already exist.","description":"This method will auto-generate an ID and create a new ribbon type. If an ID is specified for the ribbon type, an error will be thrown."}},"httpPath":"/ribbonTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/ribbon-types/executebatchoperations","routeSlug":"/apis/events/events-v1/ribbon-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/ribbonTypes/{tenantId}/batch"},{"label":"Returns a ribbon type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/ribbon-types/deleteribbontype","routeSlug":"/apis/events/events-v1/ribbon-types/deleteribbontype","metadata":{"seo":{"title":"Returns a ribbon type from the system by its ID.","description":"This method will delete a ribbon type with the specified ID."}},"httpPath":"/ribbonTypes/{tenantId}/{id}"},{"label":"Returns a ribbon type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/ribbon-types/getribbontype","routeSlug":"/apis/events/events-v1/ribbon-types/getribbontype","metadata":{"seo":{"title":"Returns a ribbon type from the system by its ID.","description":"This method will look up a ribbon type by the specified ID and return it back."}},"httpPath":"/ribbonTypes/{tenantId}/{id}"},{"label":"Partially updates a ribbon type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/ribbon-types/patchribbontype","routeSlug":"/apis/events/events-v1/ribbon-types/patchribbontype","metadata":{"seo":{"title":"Partially updates a ribbon type with the specified ID.","description":"This method will patch an existing ribbon type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/ribbonTypes/{tenantId}/{id}"},{"label":"Updates a ribbon type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/ribbon-types/updateribbontype","routeSlug":"/apis/events/events-v1/ribbon-types/updateribbontype","metadata":{"seo":{"title":"Updates a ribbon type with the specified ID.","description":"This method will update an existing ribbon type with the specified ID."}},"httpPath":"/ribbonTypes/{tenantId}/{id}"}]},{"type":"group","label":"Rooms","link":"/apis/events/events-v1/rooms","routeSlug":"/apis/events/events-v1/rooms","items":[{"label":"Creates a new room record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/rooms/createroom","routeSlug":"/apis/events/events-v1/rooms/createroom","metadata":{"seo":{"title":"Creates a new room record that does not already exist.","description":"This method will auto-generate an ID and create a new room. If an ID is specified for the room, an error will be thrown."}},"httpPath":"/rooms/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/rooms/executebatchoperations","routeSlug":"/apis/events/events-v1/rooms/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/rooms/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/rooms/listroomsbyeventid","routeSlug":"/apis/events/events-v1/rooms/listroomsbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/rooms/{tenantId}/event/{event_id}"},{"label":"Returns a room from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/rooms/deleteroom","routeSlug":"/apis/events/events-v1/rooms/deleteroom","metadata":{"seo":{"title":"Returns a room from the system by its ID.","description":"This method will delete a room with the specified ID."}},"httpPath":"/rooms/{tenantId}/{id}"},{"label":"Returns a room from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/rooms/getroom","routeSlug":"/apis/events/events-v1/rooms/getroom","metadata":{"seo":{"title":"Returns a room from the system by its ID.","description":"This method will look up a room by the specified ID and return it back."}},"httpPath":"/rooms/{tenantId}/{id}"},{"label":"Partially updates a room with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/rooms/patchroom","routeSlug":"/apis/events/events-v1/rooms/patchroom","metadata":{"seo":{"title":"Partially updates a room with the specified ID.","description":"This method will patch an existing room with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/rooms/{tenantId}/{id}"},{"label":"Updates a room with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/rooms/updateroom","routeSlug":"/apis/events/events-v1/rooms/updateroom","metadata":{"seo":{"title":"Updates a room with the specified ID.","description":"This method will update an existing room with the specified ID."}},"httpPath":"/rooms/{tenantId}/{id}"}]},{"type":"group","label":"Session Fees","link":"/apis/events/events-v1/session-fees","routeSlug":"/apis/events/events-v1/session-fees","items":[{"label":"Creates a new session fee record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-fees/createsessionfee","routeSlug":"/apis/events/events-v1/session-fees/createsessionfee","metadata":{"seo":{"title":"Creates a new session fee record that does not already exist.","description":"This method will auto-generate an ID and create a new session fee. If an ID is specified for the session fee, an error will be thrown."}},"httpPath":"/sessionFees/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-fees/executebatchoperations","routeSlug":"/apis/events/events-v1/session-fees/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/sessionFees/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-fees/listfeesbyeventid","routeSlug":"/apis/events/events-v1/session-fees/listfeesbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/sessionFees/{tenantId}/event/{event_id}"},{"label":"Returns a list of records with the specified session_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-fees/listfeesbysessionid","routeSlug":"/apis/events/events-v1/session-fees/listfeesbysessionid","metadata":{"seo":{"title":"Returns a list of records with the specified session_id","description":"Returns a list of records with the specified session_id"}},"httpPath":"/sessionFees/{tenantId}/session/{session_id}"},{"label":"Returns a session fee from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-fees/deletesessionfee","routeSlug":"/apis/events/events-v1/session-fees/deletesessionfee","metadata":{"seo":{"title":"Returns a session fee from the system by its ID.","description":"This method will delete a session fee with the specified ID."}},"httpPath":"/sessionFees/{tenantId}/{id}"},{"label":"Returns a session fee from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-fees/getsessionfee","routeSlug":"/apis/events/events-v1/session-fees/getsessionfee","metadata":{"seo":{"title":"Returns a session fee from the system by its ID.","description":"This method will look up a session fee by the specified ID and return it back."}},"httpPath":"/sessionFees/{tenantId}/{id}"},{"label":"Partially updates a session fee with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-fees/patchsessionfee","routeSlug":"/apis/events/events-v1/session-fees/patchsessionfee","metadata":{"seo":{"title":"Partially updates a session fee with the specified ID.","description":"This method will patch an existing session fee with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/sessionFees/{tenantId}/{id}"},{"label":"Updates a session fee with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-fees/updatesessionfee","routeSlug":"/apis/events/events-v1/session-fees/updatesessionfee","metadata":{"seo":{"title":"Updates a session fee with the specified ID.","description":"This method will update an existing session fee with the specified ID."}},"httpPath":"/sessionFees/{tenantId}/{id}"}]},{"type":"group","label":"Session Registrations","link":"/apis/events/events-v1/session-registrations","routeSlug":"/apis/events/events-v1/session-registrations","items":[{"label":"Creates a new session registration record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-registrations/createsessionregistration","routeSlug":"/apis/events/events-v1/session-registrations/createsessionregistration","metadata":{"seo":{"title":"Creates a new session registration record that does not already exist.","description":"This method will auto-generate an ID and create a new session registration. If an ID is specified for the session registration, an error will be thrown."}},"httpPath":"/sessionRegistrations/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-registrations/executebatchoperations","routeSlug":"/apis/events/events-v1/session-registrations/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/sessionRegistrations/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-registrations/listregistrationsbyeventcontactid","routeSlug":"/apis/events/events-v1/session-registrations/listregistrationsbyeventcontactid","metadata":{"seo":{"title":"Returns a list of records with the specified event_contact_id","description":"Returns a list of records with the specified event_contact_id"}},"httpPath":"/sessionRegistrations/{tenantId}/eventContact/{eventId}/{contactId}"},{"label":"Returns a list of records with the specified session_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-registrations/listregistrationsbysessionid","routeSlug":"/apis/events/events-v1/session-registrations/listregistrationsbysessionid","metadata":{"seo":{"title":"Returns a list of records with the specified session_id","description":"Returns a list of records with the specified session_id"}},"httpPath":"/sessionRegistrations/{tenantId}/session/{session_id}"},{"label":"Returns a session registration from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-registrations/deletesessionregistration","routeSlug":"/apis/events/events-v1/session-registrations/deletesessionregistration","metadata":{"seo":{"title":"Returns a session registration from the system by its ID.","description":"This method will delete a session registration with the specified ID."}},"httpPath":"/sessionRegistrations/{tenantId}/{id}"},{"label":"Returns a session registration from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-registrations/getsessionregistration","routeSlug":"/apis/events/events-v1/session-registrations/getsessionregistration","metadata":{"seo":{"title":"Returns a session registration from the system by its ID.","description":"This method will look up a session registration by the specified ID and return it back."}},"httpPath":"/sessionRegistrations/{tenantId}/{id}"},{"label":"Partially updates a session registration with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-registrations/patchsessionregistration","routeSlug":"/apis/events/events-v1/session-registrations/patchsessionregistration","metadata":{"seo":{"title":"Partially updates a session registration with the specified ID.","description":"This method will patch an existing session registration with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/sessionRegistrations/{tenantId}/{id}"},{"label":"Updates a session registration with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-registrations/updatesessionregistration","routeSlug":"/apis/events/events-v1/session-registrations/updatesessionregistration","metadata":{"seo":{"title":"Updates a session registration with the specified ID.","description":"This method will update an existing session registration with the specified ID."}},"httpPath":"/sessionRegistrations/{tenantId}/{id}"}]},{"type":"group","label":"Session Tracks","link":"/apis/events/events-v1/session-tracks","routeSlug":"/apis/events/events-v1/session-tracks","items":[{"label":"Creates a new session track record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-tracks/createsessiontrack","routeSlug":"/apis/events/events-v1/session-tracks/createsessiontrack","metadata":{"seo":{"title":"Creates a new session track record that does not already exist.","description":"This method will auto-generate an ID and create a new session track. If an ID is specified for the session track, an error will be thrown."}},"httpPath":"/sessionTracks/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-tracks/executebatchoperations","routeSlug":"/apis/events/events-v1/session-tracks/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/sessionTracks/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-tracks/listtracksbyeventid","routeSlug":"/apis/events/events-v1/session-tracks/listtracksbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/sessionTracks/{tenantId}/event/{event_id}"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-tracks/describetracksbyeventid","routeSlug":"/apis/events/events-v1/session-tracks/describetracksbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/sessionTracks/{tenantId}/public/event/{event_id}"},{"label":"Returns a session track from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-tracks/deletesessiontrack","routeSlug":"/apis/events/events-v1/session-tracks/deletesessiontrack","metadata":{"seo":{"title":"Returns a session track from the system by its ID.","description":"This method will delete a session track with the specified ID."}},"httpPath":"/sessionTracks/{tenantId}/{id}"},{"label":"Returns a session track from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-tracks/getsessiontrack","routeSlug":"/apis/events/events-v1/session-tracks/getsessiontrack","metadata":{"seo":{"title":"Returns a session track from the system by its ID.","description":"This method will look up a session track by the specified ID and return it back."}},"httpPath":"/sessionTracks/{tenantId}/{id}"},{"label":"Partially updates a session track with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-tracks/patchsessiontrack","routeSlug":"/apis/events/events-v1/session-tracks/patchsessiontrack","metadata":{"seo":{"title":"Partially updates a session track with the specified ID.","description":"This method will patch an existing session track with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/sessionTracks/{tenantId}/{id}"},{"label":"Updates a session track with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-tracks/updatesessiontrack","routeSlug":"/apis/events/events-v1/session-tracks/updatesessiontrack","metadata":{"seo":{"title":"Updates a session track with the specified ID.","description":"This method will update an existing session track with the specified ID."}},"httpPath":"/sessionTracks/{tenantId}/{id}"}]},{"type":"group","label":"Session Types","link":"/apis/events/events-v1/session-types","routeSlug":"/apis/events/events-v1/session-types","items":[{"label":"Gets all of the session types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-types/listsessiontypes","routeSlug":"/apis/events/events-v1/session-types/listsessiontypes","metadata":{"seo":{"title":"Gets all of the session types in the system.","description":"This method will scan all session types and and return them to the caller."}},"httpPath":"/sessionTypes/{tenantId}"},{"label":"Creates a new session type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-types/createsessiontype","routeSlug":"/apis/events/events-v1/session-types/createsessiontype","metadata":{"seo":{"title":"Creates a new session type record that does not already exist.","description":"This method will auto-generate an ID and create a new session type. If an ID is specified for the session type, an error will be thrown."}},"httpPath":"/sessionTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-types/executebatchoperations","routeSlug":"/apis/events/events-v1/session-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/sessionTypes/{tenantId}/batch"},{"label":"Gets all of the session types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-types/listsessiontypespublic","routeSlug":"/apis/events/events-v1/session-types/listsessiontypespublic","metadata":{"seo":{"title":"Gets all of the session types in the system.","description":"This method will scan all session types and and return them to the caller."}},"httpPath":"/sessionTypes/{tenantId}/public"},{"label":"Returns a session type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-types/deletesessiontype","routeSlug":"/apis/events/events-v1/session-types/deletesessiontype","metadata":{"seo":{"title":"Returns a session type from the system by its ID.","description":"This method will delete a session type with the specified ID."}},"httpPath":"/sessionTypes/{tenantId}/{id}"},{"label":"Returns a session type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-types/getsessiontype","routeSlug":"/apis/events/events-v1/session-types/getsessiontype","metadata":{"seo":{"title":"Returns a session type from the system by its ID.","description":"This method will look up a session type by the specified ID and return it back."}},"httpPath":"/sessionTypes/{tenantId}/{id}"},{"label":"Partially updates a session type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-types/patchsessiontype","routeSlug":"/apis/events/events-v1/session-types/patchsessiontype","metadata":{"seo":{"title":"Partially updates a session type with the specified ID.","description":"This method will patch an existing session type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/sessionTypes/{tenantId}/{id}"},{"label":"Updates a session type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/session-types/updatesessiontype","routeSlug":"/apis/events/events-v1/session-types/updatesessiontype","metadata":{"seo":{"title":"Updates a session type with the specified ID.","description":"This method will update an existing session type with the specified ID."}},"httpPath":"/sessionTypes/{tenantId}/{id}"}]},{"type":"group","label":"Sessions","link":"/apis/events/events-v1/sessions","routeSlug":"/apis/events/events-v1/sessions","items":[{"label":"Creates a new session record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sessions/createsession","routeSlug":"/apis/events/events-v1/sessions/createsession","metadata":{"seo":{"title":"Creates a new session record that does not already exist.","description":"This method will auto-generate an ID and create a new session. If an ID is specified for the session, an error will be thrown."}},"httpPath":"/sessions/{tenantId}"},{"label":"Returns a list of records with the specified abstract_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sessions/listsessionsbyabstractid","routeSlug":"/apis/events/events-v1/sessions/listsessionsbyabstractid","metadata":{"seo":{"title":"Returns a list of records with the specified abstract_id","description":"Returns a list of records with the specified abstract_id"}},"httpPath":"/sessions/{tenantId}/abstract/{abstract_id}"},{"label":"Generate Session from Abstract","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sessions/generatesessionfromabstract","routeSlug":"/apis/events/events-v1/sessions/generatesessionfromabstract","metadata":{"seo":{"title":"Generate Session from Abstract","description":"Generates a session with speaker information from an abstract record"}},"httpPath":"/sessions/{tenantId}/abstract/{abstract_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sessions/executebatchoperations","routeSlug":"/apis/events/events-v1/sessions/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/sessions/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sessions/listsessionsbyeventid","routeSlug":"/apis/events/events-v1/sessions/listsessionsbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/sessions/{tenantId}/event/{event_id}"},{"label":"Get Privileges for a session","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sessions/getprivileges","routeSlug":"/apis/events/events-v1/sessions/getprivileges","metadata":{"seo":{"title":"Get Privileges for a session","description":"Returns things a person can do for a session"}},"httpPath":"/sessions/{tenantId}/privileges/{id}/{contactId}"},{"label":"Describes all of the sessions for an event","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sessions/describesessionsforevent","routeSlug":"/apis/events/events-v1/sessions/describesessionsforevent","metadata":{"seo":{"title":"Describes all of the sessions for an event","description":"Returns a list of records with the specified event_id"}},"httpPath":"/sessions/{tenantId}/public/event/{event_id}"},{"label":"Searches for sessions using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sessions/publicsearchsessions","routeSlug":"/apis/events/events-v1/sessions/publicsearchsessions","metadata":{"seo":{"title":"Searches for sessions using predefined parameters","description":"Searches for sessions using predefined parameters"}},"httpPath":"/sessions/{tenantId}/public/search"},{"label":"Returns a session from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sessions/publicgetsession","routeSlug":"/apis/events/events-v1/sessions/publicgetsession","metadata":{"seo":{"title":"Returns a session from the system by its ID.","description":"This method will look up a session by the specified ID and return it back."}},"httpPath":"/sessions/{tenantId}/public/{id}"},{"label":"Searches for sessions using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sessions/searchforsessions","routeSlug":"/apis/events/events-v1/sessions/searchforsessions","metadata":{"seo":{"title":"Searches for sessions using predefined parameters","description":"Searches for sessions using predefined parameters"}},"httpPath":"/sessions/{tenantId}/search"},{"label":"Returns a session from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sessions/deletesession","routeSlug":"/apis/events/events-v1/sessions/deletesession","metadata":{"seo":{"title":"Returns a session from the system by its ID.","description":"This method will delete a session with the specified ID."}},"httpPath":"/sessions/{tenantId}/{id}"},{"label":"Returns a session from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sessions/getsession","routeSlug":"/apis/events/events-v1/sessions/getsession","metadata":{"seo":{"title":"Returns a session from the system by its ID.","description":"This method will look up a session by the specified ID and return it back."}},"httpPath":"/sessions/{tenantId}/{id}"},{"label":"Partially updates a session with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sessions/patchsession","routeSlug":"/apis/events/events-v1/sessions/patchsession","metadata":{"seo":{"title":"Partially updates a session with the specified ID.","description":"This method will patch an existing session with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/sessions/{tenantId}/{id}"},{"label":"Updates a session with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sessions/updatesession","routeSlug":"/apis/events/events-v1/sessions/updatesession","metadata":{"seo":{"title":"Updates a session with the specified ID.","description":"This method will update an existing session with the specified ID."}},"httpPath":"/sessions/{tenantId}/{id}"}]},{"type":"group","label":"Settings","link":"/apis/events/events-v1/settings","routeSlug":"/apis/events/events-v1/settings","items":[{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/settings/deletesetting","routeSlug":"/apis/events/events-v1/settings/deletesetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will delete a setting with the specified ID."}},"httpPath":"/settings/{tenantId}"},{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/settings/getsetting","routeSlug":"/apis/events/events-v1/settings/getsetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will look up a setting by the specified ID and return it back."}},"httpPath":"/settings/{tenantId}"},{"label":"Partially updates a setting with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/settings/patchsetting","routeSlug":"/apis/events/events-v1/settings/patchsetting","metadata":{"seo":{"title":"Partially updates a setting with the specified ID.","description":"This method will patch an existing setting with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/settings/{tenantId}"},{"label":"Creates a new setting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/settings/createsetting","routeSlug":"/apis/events/events-v1/settings/createsetting","metadata":{"seo":{"title":"Creates a new setting record that does not already exist.","description":"This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, an error will be thrown."}},"httpPath":"/settings/{tenantId}"},{"label":"Updates a setting with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/settings/updatesetting","routeSlug":"/apis/events/events-v1/settings/updatesetting","metadata":{"seo":{"title":"Updates a setting with the specified ID.","description":"This method will update an existing setting with the specified ID."}},"httpPath":"/settings/{tenantId}"}]},{"type":"group","label":"Show Floors","link":"/apis/events/events-v1/show-floors","routeSlug":"/apis/events/events-v1/show-floors","items":[{"label":"Creates a new show floor record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/show-floors/createshowfloor","routeSlug":"/apis/events/events-v1/show-floors/createshowfloor","metadata":{"seo":{"title":"Creates a new show floor record that does not already exist.","description":"This method will auto-generate an ID and create a new show floor. If an ID is specified for the show floor, an error will be thrown."}},"httpPath":"/showFloors/{tenantId}"},{"label":"Returns a show floor from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/show-floors/deleteshowfloor","routeSlug":"/apis/events/events-v1/show-floors/deleteshowfloor","metadata":{"seo":{"title":"Returns a show floor from the system by its ID.","description":"This method will delete a show floor with the specified ID."}},"httpPath":"/showFloors/{tenantId}/{id}"},{"label":"Returns a show floor from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/show-floors/getshowfloor","routeSlug":"/apis/events/events-v1/show-floors/getshowfloor","metadata":{"seo":{"title":"Returns a show floor from the system by its ID.","description":"This method will look up a show floor by the specified ID and return it back."}},"httpPath":"/showFloors/{tenantId}/{id}"},{"label":"Partially updates a show floor with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/show-floors/patchshowfloor","routeSlug":"/apis/events/events-v1/show-floors/patchshowfloor","metadata":{"seo":{"title":"Partially updates a show floor with the specified ID.","description":"This method will patch an existing show floor with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/showFloors/{tenantId}/{id}"},{"label":"Updates a show floor with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/show-floors/updateshowfloor","routeSlug":"/apis/events/events-v1/show-floors/updateshowfloor","metadata":{"seo":{"title":"Updates a show floor with the specified ID.","description":"This method will update an existing show floor with the specified ID."}},"httpPath":"/showFloors/{tenantId}/{id}"}]},{"type":"group","label":"Speaker Profiles","link":"/apis/events/events-v1/speaker-profiles","routeSlug":"/apis/events/events-v1/speaker-profiles","items":[{"label":"Creates a new speaker profile record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speaker-profiles/createspeakerprofile","routeSlug":"/apis/events/events-v1/speaker-profiles/createspeakerprofile","metadata":{"seo":{"title":"Creates a new speaker profile record that does not already exist.","description":"This method will auto-generate an ID and create a new speaker profile. If an ID is specified for the speaker profile, an error will be thrown."}},"httpPath":"/speakerProfiles/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speaker-profiles/executebatchoperations","routeSlug":"/apis/events/events-v1/speaker-profiles/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/speakerProfiles/{tenantId}/batch"},{"label":"Searches for speaker profiles using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speaker-profiles/searchforspeakerprofiles","routeSlug":"/apis/events/events-v1/speaker-profiles/searchforspeakerprofiles","metadata":{"seo":{"title":"Searches for speaker profiles using predefined parameters","description":"Searches for speaker profiles using predefined parameters"}},"httpPath":"/speakerProfiles/{tenantId}/search"},{"label":"Returns a speaker profile from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speaker-profiles/deletespeakerprofile","routeSlug":"/apis/events/events-v1/speaker-profiles/deletespeakerprofile","metadata":{"seo":{"title":"Returns a speaker profile from the system by its ID.","description":"This method will delete a speaker profile with the specified ID."}},"httpPath":"/speakerProfiles/{tenantId}/{id}"},{"label":"Returns a speaker profile from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speaker-profiles/getspeakerprofile","routeSlug":"/apis/events/events-v1/speaker-profiles/getspeakerprofile","metadata":{"seo":{"title":"Returns a speaker profile from the system by its ID.","description":"This method will look up a speaker profile by the specified ID and return it back."}},"httpPath":"/speakerProfiles/{tenantId}/{id}"},{"label":"Partially updates a speaker profile with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speaker-profiles/patchspeakerprofile","routeSlug":"/apis/events/events-v1/speaker-profiles/patchspeakerprofile","metadata":{"seo":{"title":"Partially updates a speaker profile with the specified ID.","description":"This method will patch an existing speaker profile with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/speakerProfiles/{tenantId}/{id}"},{"label":"Updates a speaker profile with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speaker-profiles/updatespeakerprofile","routeSlug":"/apis/events/events-v1/speaker-profiles/updatespeakerprofile","metadata":{"seo":{"title":"Updates a speaker profile with the specified ID.","description":"This method will update an existing speaker profile with the specified ID."}},"httpPath":"/speakerProfiles/{tenantId}/{id}"}]},{"type":"group","label":"Speaker Topics","link":"/apis/events/events-v1/speaker-topics","routeSlug":"/apis/events/events-v1/speaker-topics","items":[{"label":"Gets all of the speaker topics in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speaker-topics/listspeakertopics","routeSlug":"/apis/events/events-v1/speaker-topics/listspeakertopics","metadata":{"seo":{"title":"Gets all of the speaker topics in the system.","description":"This method will scan all speaker topics and and return them to the caller."}},"httpPath":"/speakerTopics/{tenantId}"},{"label":"Creates a new speaker topic record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speaker-topics/createspeakertopic","routeSlug":"/apis/events/events-v1/speaker-topics/createspeakertopic","metadata":{"seo":{"title":"Creates a new speaker topic record that does not already exist.","description":"This method will auto-generate an ID and create a new speaker topic. If an ID is specified for the speaker topic, an error will be thrown."}},"httpPath":"/speakerTopics/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speaker-topics/executebatchoperations","routeSlug":"/apis/events/events-v1/speaker-topics/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/speakerTopics/{tenantId}/batch"},{"label":"Returns a speaker topic from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speaker-topics/deletespeakertopic","routeSlug":"/apis/events/events-v1/speaker-topics/deletespeakertopic","metadata":{"seo":{"title":"Returns a speaker topic from the system by its ID.","description":"This method will delete a speaker topic with the specified ID."}},"httpPath":"/speakerTopics/{tenantId}/{id}"},{"label":"Returns a speaker topic from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speaker-topics/getspeakertopic","routeSlug":"/apis/events/events-v1/speaker-topics/getspeakertopic","metadata":{"seo":{"title":"Returns a speaker topic from the system by its ID.","description":"This method will look up a speaker topic by the specified ID and return it back."}},"httpPath":"/speakerTopics/{tenantId}/{id}"},{"label":"Partially updates a speaker topic with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speaker-topics/patchspeakertopic","routeSlug":"/apis/events/events-v1/speaker-topics/patchspeakertopic","metadata":{"seo":{"title":"Partially updates a speaker topic with the specified ID.","description":"This method will patch an existing speaker topic with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/speakerTopics/{tenantId}/{id}"},{"label":"Updates a speaker topic with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speaker-topics/updatespeakertopic","routeSlug":"/apis/events/events-v1/speaker-topics/updatespeakertopic","metadata":{"seo":{"title":"Updates a speaker topic with the specified ID.","description":"This method will update an existing speaker topic with the specified ID."}},"httpPath":"/speakerTopics/{tenantId}/{id}"}]},{"type":"group","label":"Speaker Types","link":"/apis/events/events-v1/speaker-types","routeSlug":"/apis/events/events-v1/speaker-types","items":[{"label":"Gets all of the speaker types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speaker-types/listspeakertypes","routeSlug":"/apis/events/events-v1/speaker-types/listspeakertypes","metadata":{"seo":{"title":"Gets all of the speaker types in the system.","description":"This method will scan all speaker types and and return them to the caller."}},"httpPath":"/speakerTypes/{tenantId}"},{"label":"Creates a new speaker type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speaker-types/createspeakertype","routeSlug":"/apis/events/events-v1/speaker-types/createspeakertype","metadata":{"seo":{"title":"Creates a new speaker type record that does not already exist.","description":"This method will auto-generate an ID and create a new speaker type. If an ID is specified for the speaker type, an error will be thrown."}},"httpPath":"/speakerTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speaker-types/executebatchoperations","routeSlug":"/apis/events/events-v1/speaker-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/speakerTypes/{tenantId}/batch"},{"label":"Returns a speaker type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speaker-types/deletespeakertype","routeSlug":"/apis/events/events-v1/speaker-types/deletespeakertype","metadata":{"seo":{"title":"Returns a speaker type from the system by its ID.","description":"This method will delete a speaker type with the specified ID."}},"httpPath":"/speakerTypes/{tenantId}/{id}"},{"label":"Returns a speaker type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speaker-types/getspeakertype","routeSlug":"/apis/events/events-v1/speaker-types/getspeakertype","metadata":{"seo":{"title":"Returns a speaker type from the system by its ID.","description":"This method will look up a speaker type by the specified ID and return it back."}},"httpPath":"/speakerTypes/{tenantId}/{id}"},{"label":"Partially updates a speaker type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speaker-types/patchspeakertype","routeSlug":"/apis/events/events-v1/speaker-types/patchspeakertype","metadata":{"seo":{"title":"Partially updates a speaker type with the specified ID.","description":"This method will patch an existing speaker type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/speakerTypes/{tenantId}/{id}"},{"label":"Updates a speaker type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speaker-types/updatespeakertype","routeSlug":"/apis/events/events-v1/speaker-types/updatespeakertype","metadata":{"seo":{"title":"Updates a speaker type with the specified ID.","description":"This method will update an existing speaker type with the specified ID."}},"httpPath":"/speakerTypes/{tenantId}/{id}"}]},{"type":"group","label":"Speakers","link":"/apis/events/events-v1/speakers","routeSlug":"/apis/events/events-v1/speakers","items":[{"label":"Creates a new speaker record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speakers/createspeaker","routeSlug":"/apis/events/events-v1/speakers/createspeaker","metadata":{"seo":{"title":"Creates a new speaker record that does not already exist.","description":"This method will auto-generate an ID and create a new speaker. If an ID is specified for the speaker, an error will be thrown."}},"httpPath":"/speakers/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speakers/executebatchoperations","routeSlug":"/apis/events/events-v1/speakers/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/speakers/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speakers/listspeakersbycontactid","routeSlug":"/apis/events/events-v1/speakers/listspeakersbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/speakers/{tenantId}/contact/{contact_id}"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speakers/listspeakersbyeventid","routeSlug":"/apis/events/events-v1/speakers/listspeakersbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/speakers/{tenantId}/event/{event_id}"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speakers/describespeakersforevent","routeSlug":"/apis/events/events-v1/speakers/describespeakersforevent","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/speakers/{tenantId}/public/event/{event_id}"},{"label":"Returns a speaker from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speakers/publicgetspeaker","routeSlug":"/apis/events/events-v1/speakers/publicgetspeaker","metadata":{"seo":{"title":"Returns a speaker from the system by its ID.","description":"This method will look up a speaker by the specified ID and return it back."}},"httpPath":"/speakers/{tenantId}/public/{id}"},{"label":"Searches for speakers using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speakers/searchforspeakers","routeSlug":"/apis/events/events-v1/speakers/searchforspeakers","metadata":{"seo":{"title":"Searches for speakers using predefined parameters","description":"Searches for speakers using predefined parameters"}},"httpPath":"/speakers/{tenantId}/search"},{"label":"Returns a speaker from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speakers/deletespeaker","routeSlug":"/apis/events/events-v1/speakers/deletespeaker","metadata":{"seo":{"title":"Returns a speaker from the system by its ID.","description":"This method will delete a speaker with the specified ID."}},"httpPath":"/speakers/{tenantId}/{id}"},{"label":"Returns a speaker from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speakers/getspeaker","routeSlug":"/apis/events/events-v1/speakers/getspeaker","metadata":{"seo":{"title":"Returns a speaker from the system by its ID.","description":"This method will look up a speaker by the specified ID and return it back."}},"httpPath":"/speakers/{tenantId}/{id}"},{"label":"Partially updates a speaker with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speakers/patchspeaker","routeSlug":"/apis/events/events-v1/speakers/patchspeaker","metadata":{"seo":{"title":"Partially updates a speaker with the specified ID.","description":"This method will patch an existing speaker with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/speakers/{tenantId}/{id}"},{"label":"Updates a speaker with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/speakers/updatespeaker","routeSlug":"/apis/events/events-v1/speakers/updatespeaker","metadata":{"seo":{"title":"Updates a speaker with the specified ID.","description":"This method will update an existing speaker with the specified ID."}},"httpPath":"/speakers/{tenantId}/{id}"}]},{"type":"group","label":"Sponsor Levels","link":"/apis/events/events-v1/sponsor-levels","routeSlug":"/apis/events/events-v1/sponsor-levels","items":[{"label":"Gets all of the sponsor levels in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sponsor-levels/listsponsorlevels","routeSlug":"/apis/events/events-v1/sponsor-levels/listsponsorlevels","metadata":{"seo":{"title":"Gets all of the sponsor levels in the system.","description":"This method will scan all sponsor levels and and return them to the caller."}},"httpPath":"/sponsorLevels/{tenantId}"},{"label":"Creates a new sponsor level record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sponsor-levels/createsponsorlevel","routeSlug":"/apis/events/events-v1/sponsor-levels/createsponsorlevel","metadata":{"seo":{"title":"Creates a new sponsor level record that does not already exist.","description":"This method will auto-generate an ID and create a new sponsor level. If an ID is specified for the sponsor level, an error will be thrown."}},"httpPath":"/sponsorLevels/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sponsor-levels/executebatchoperations","routeSlug":"/apis/events/events-v1/sponsor-levels/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/sponsorLevels/{tenantId}/batch"},{"label":"Returns a sponsor level from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sponsor-levels/deletesponsorlevel","routeSlug":"/apis/events/events-v1/sponsor-levels/deletesponsorlevel","metadata":{"seo":{"title":"Returns a sponsor level from the system by its ID.","description":"This method will delete a sponsor level with the specified ID."}},"httpPath":"/sponsorLevels/{tenantId}/{id}"},{"label":"Returns a sponsor level from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sponsor-levels/getsponsorlevel","routeSlug":"/apis/events/events-v1/sponsor-levels/getsponsorlevel","metadata":{"seo":{"title":"Returns a sponsor level from the system by its ID.","description":"This method will look up a sponsor level by the specified ID and return it back."}},"httpPath":"/sponsorLevels/{tenantId}/{id}"},{"label":"Partially updates a sponsor level with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sponsor-levels/patchsponsorlevel","routeSlug":"/apis/events/events-v1/sponsor-levels/patchsponsorlevel","metadata":{"seo":{"title":"Partially updates a sponsor level with the specified ID.","description":"This method will patch an existing sponsor level with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/sponsorLevels/{tenantId}/{id}"},{"label":"Updates a sponsor level with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sponsor-levels/updatesponsorlevel","routeSlug":"/apis/events/events-v1/sponsor-levels/updatesponsorlevel","metadata":{"seo":{"title":"Updates a sponsor level with the specified ID.","description":"This method will update an existing sponsor level with the specified ID."}},"httpPath":"/sponsorLevels/{tenantId}/{id}"}]},{"type":"group","label":"Sponsors","link":"/apis/events/events-v1/sponsors","routeSlug":"/apis/events/events-v1/sponsors","items":[{"label":"Creates a new sponsor record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sponsors/createsponsor","routeSlug":"/apis/events/events-v1/sponsors/createsponsor","metadata":{"seo":{"title":"Creates a new sponsor record that does not already exist.","description":"This method will auto-generate an ID and create a new sponsor. If an ID is specified for the sponsor, an error will be thrown."}},"httpPath":"/sponsors/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sponsors/executebatchoperations","routeSlug":"/apis/events/events-v1/sponsors/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/sponsors/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sponsors/listsponsorsbyeventid","routeSlug":"/apis/events/events-v1/sponsors/listsponsorsbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/sponsors/{tenantId}/event/{event_id}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sponsors/listsponsorsbyorganizationid","routeSlug":"/apis/events/events-v1/sponsors/listsponsorsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/sponsors/{tenantId}/organization/{organization_id}"},{"label":"Returns a sponsor from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sponsors/deletesponsor","routeSlug":"/apis/events/events-v1/sponsors/deletesponsor","metadata":{"seo":{"title":"Returns a sponsor from the system by its ID.","description":"This method will delete a sponsor with the specified ID."}},"httpPath":"/sponsors/{tenantId}/{id}"},{"label":"Returns a sponsor from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sponsors/getsponsor","routeSlug":"/apis/events/events-v1/sponsors/getsponsor","metadata":{"seo":{"title":"Returns a sponsor from the system by its ID.","description":"This method will look up a sponsor by the specified ID and return it back."}},"httpPath":"/sponsors/{tenantId}/{id}"},{"label":"Partially updates a sponsor with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sponsors/patchsponsor","routeSlug":"/apis/events/events-v1/sponsors/patchsponsor","metadata":{"seo":{"title":"Partially updates a sponsor with the specified ID.","description":"This method will patch an existing sponsor with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/sponsors/{tenantId}/{id}"},{"label":"Updates a sponsor with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/sponsors/updatesponsor","routeSlug":"/apis/events/events-v1/sponsors/updatesponsor","metadata":{"seo":{"title":"Updates a sponsor with the specified ID.","description":"This method will update an existing sponsor with the specified ID."}},"httpPath":"/sponsors/{tenantId}/{id}"}]},{"type":"group","label":"Statistics","link":"/apis/events/events-v1/statistics","routeSlug":"/apis/events/events-v1/statistics","items":[{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/statistics/executebatchoperations","routeSlug":"/apis/events/events-v1/statistics/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/statistics/{tenantId}/batch"},{"label":"Returns a statistic from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/statistics/getstatistic","routeSlug":"/apis/events/events-v1/statistics/getstatistic","metadata":{"seo":{"title":"Returns a statistic from the system by its ID.","description":"This method will look up a statistic by the specified ID and return it back."}},"httpPath":"/statistics/{tenantId}/{id}"}]},{"type":"group","label":"Types","link":"/apis/events/events-v1/types","routeSlug":"/apis/events/events-v1/types","items":[{"label":"Gets all of the types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/types/listtypes","routeSlug":"/apis/events/events-v1/types/listtypes","metadata":{"seo":{"title":"Gets all of the types in the system.","description":"This method will scan all types and and return them to the caller."}},"httpPath":"/types/{tenantId}"},{"label":"Creates a new type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/types/createtype","routeSlug":"/apis/events/events-v1/types/createtype","metadata":{"seo":{"title":"Creates a new type record that does not already exist.","description":"This method will auto-generate an ID and create a new type. If an ID is specified for the type, an error will be thrown."}},"httpPath":"/types/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/types/executebatchoperations","routeSlug":"/apis/events/events-v1/types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/types/{tenantId}/batch"},{"label":"Returns a type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/types/deletetype","routeSlug":"/apis/events/events-v1/types/deletetype","metadata":{"seo":{"title":"Returns a type from the system by its ID.","description":"This method will delete a type with the specified ID."}},"httpPath":"/types/{tenantId}/{id}"},{"label":"Returns a type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/types/gettype","routeSlug":"/apis/events/events-v1/types/gettype","metadata":{"seo":{"title":"Returns a type from the system by its ID.","description":"This method will look up a type by the specified ID and return it back."}},"httpPath":"/types/{tenantId}/{id}"},{"label":"Partially updates a type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/types/patchtype","routeSlug":"/apis/events/events-v1/types/patchtype","metadata":{"seo":{"title":"Partially updates a type with the specified ID.","description":"This method will patch an existing type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/types/{tenantId}/{id}"},{"label":"Updates a type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/types/updatetype","routeSlug":"/apis/events/events-v1/types/updatetype","metadata":{"seo":{"title":"Updates a type with the specified ID.","description":"This method will update an existing type with the specified ID."}},"httpPath":"/types/{tenantId}/{id}"}]},{"type":"group","label":"Venues","link":"/apis/events/events-v1/venues","routeSlug":"/apis/events/events-v1/venues","items":[{"label":"Gets all of the venues in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/venues/listvenues","routeSlug":"/apis/events/events-v1/venues/listvenues","metadata":{"seo":{"title":"Gets all of the venues in the system.","description":"This method will scan all venues and and return them to the caller."}},"httpPath":"/venues/{tenantId}"},{"label":"Creates a new venue record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/venues/createvenue","routeSlug":"/apis/events/events-v1/venues/createvenue","metadata":{"seo":{"title":"Creates a new venue record that does not already exist.","description":"This method will auto-generate an ID and create a new venue. If an ID is specified for the venue, an error will be thrown."}},"httpPath":"/venues/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/venues/executebatchoperations","routeSlug":"/apis/events/events-v1/venues/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/venues/{tenantId}/batch"},{"label":"Returns a venue from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/venues/deletevenue","routeSlug":"/apis/events/events-v1/venues/deletevenue","metadata":{"seo":{"title":"Returns a venue from the system by its ID.","description":"This method will delete a venue with the specified ID."}},"httpPath":"/venues/{tenantId}/{id}"},{"label":"Returns a venue from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/venues/getvenue","routeSlug":"/apis/events/events-v1/venues/getvenue","metadata":{"seo":{"title":"Returns a venue from the system by its ID.","description":"This method will look up a venue by the specified ID and return it back."}},"httpPath":"/venues/{tenantId}/{id}"},{"label":"Partially updates a venue with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/venues/patchvenue","routeSlug":"/apis/events/events-v1/venues/patchvenue","metadata":{"seo":{"title":"Partially updates a venue with the specified ID.","description":"This method will patch an existing venue with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/venues/{tenantId}/{id}"},{"label":"Updates a venue with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/venues/updatevenue","routeSlug":"/apis/events/events-v1/venues/updatevenue","metadata":{"seo":{"title":"Updates a venue with the specified ID.","description":"This method will update an existing venue with the specified ID."}},"httpPath":"/venues/{tenantId}/{id}"}]},{"type":"group","label":"Waitlist Processes","link":"/apis/events/events-v1/waitlist-processes","routeSlug":"/apis/events/events-v1/waitlist-processes","items":[{"label":"Gets all of the waitlist processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/waitlist-processes/listwaitlistprocesses","routeSlug":"/apis/events/events-v1/waitlist-processes/listwaitlistprocesses","metadata":{"seo":{"title":"Gets all of the waitlist processes in the system.","description":"This method will scan all waitlist processes and and return them to the caller."}},"httpPath":"/waitlistProcesses/{tenantId}"},{"label":"Creates a new waitlist process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/waitlist-processes/createwaitlistprocess","routeSlug":"/apis/events/events-v1/waitlist-processes/createwaitlistprocess","metadata":{"seo":{"title":"Creates a new waitlist process record that does not already exist.","description":"This method will auto-generate an ID and create a new waitlist process. If an ID is specified for the waitlist process, an error will be thrown."}},"httpPath":"/waitlistProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/waitlist-processes/executebatchoperations","routeSlug":"/apis/events/events-v1/waitlist-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/waitlistProcesses/{tenantId}/batch"},{"label":"Returns a waitlist process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/waitlist-processes/deletewaitlistprocess","routeSlug":"/apis/events/events-v1/waitlist-processes/deletewaitlistprocess","metadata":{"seo":{"title":"Returns a waitlist process from the system by its ID.","description":"This method will delete a waitlist process with the specified ID."}},"httpPath":"/waitlistProcesses/{tenantId}/{id}"},{"label":"Returns a waitlist process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/waitlist-processes/getwaitlistprocess","routeSlug":"/apis/events/events-v1/waitlist-processes/getwaitlistprocess","metadata":{"seo":{"title":"Returns a waitlist process from the system by its ID.","description":"This method will look up a waitlist process by the specified ID and return it back."}},"httpPath":"/waitlistProcesses/{tenantId}/{id}"},{"label":"Partially updates a waitlist process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/waitlist-processes/patchwaitlistprocess","routeSlug":"/apis/events/events-v1/waitlist-processes/patchwaitlistprocess","metadata":{"seo":{"title":"Partially updates a waitlist process with the specified ID.","description":"This method will patch an existing waitlist process with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/waitlistProcesses/{tenantId}/{id}"},{"label":"Updates a waitlist process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/waitlist-processes/updatewaitlistprocess","routeSlug":"/apis/events/events-v1/waitlist-processes/updatewaitlistprocess","metadata":{"seo":{"title":"Updates a waitlist process with the specified ID.","description":"This method will update an existing waitlist process with the specified ID."}},"httpPath":"/waitlistProcesses/{tenantId}/{id}"}]},{"type":"group","label":"Waitlisted Contacts","link":"/apis/events/events-v1/waitlisted-contacts","routeSlug":"/apis/events/events-v1/waitlisted-contacts","items":[{"label":"Creates a new waitlisted contact record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/waitlisted-contacts/createwaitlistedcontact","routeSlug":"/apis/events/events-v1/waitlisted-contacts/createwaitlistedcontact","metadata":{"seo":{"title":"Creates a new waitlisted contact record that does not already exist.","description":"This method will auto-generate an ID and create a new waitlisted contact. If an ID is specified for the waitlisted contact, an error will be thrown."}},"httpPath":"/waitlistedContacts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/waitlisted-contacts/executebatchoperations","routeSlug":"/apis/events/events-v1/waitlisted-contacts/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/waitlistedContacts/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/waitlisted-contacts/listwaitlistedeventsbycontactid","routeSlug":"/apis/events/events-v1/waitlisted-contacts/listwaitlistedeventsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/waitlistedContacts/{tenantId}/contact/{contact_id}"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/waitlisted-contacts/listcontactsbyeventid","routeSlug":"/apis/events/events-v1/waitlisted-contacts/listcontactsbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/waitlistedContacts/{tenantId}/event/{event_id}"},{"label":"Returns a list of records with the specified event_contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/waitlisted-contacts/listcontactsbyeventcontactid","routeSlug":"/apis/events/events-v1/waitlisted-contacts/listcontactsbyeventcontactid","metadata":{"seo":{"title":"Returns a list of records with the specified event_contact_id","description":"Returns a list of records with the specified event_contact_id"}},"httpPath":"/waitlistedContacts/{tenantId}/eventContact/{event_id}/{contact_id}"},{"label":"Returns a list of records with the specified function_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/waitlisted-contacts/listcontactsbyfunctionid","routeSlug":"/apis/events/events-v1/waitlisted-contacts/listcontactsbyfunctionid","metadata":{"seo":{"title":"Returns a list of records with the specified function_id","description":"Returns a list of records with the specified function_id"}},"httpPath":"/waitlistedContacts/{tenantId}/function/{function_id}"},{"label":"Preview Notification","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/waitlisted-contacts/previewnotification","routeSlug":"/apis/events/events-v1/waitlisted-contacts/previewnotification","metadata":{"seo":{"title":"Preview Notification","description":"Sends out a preview of the gift receipt email"}},"httpPath":"/waitlistedContacts/{tenantId}/previewNotification"},{"label":"Returns a list of records with the specified session_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/waitlisted-contacts/listcontactsbysessionid","routeSlug":"/apis/events/events-v1/waitlisted-contacts/listcontactsbysessionid","metadata":{"seo":{"title":"Returns a list of records with the specified session_id","description":"Returns a list of records with the specified session_id"}},"httpPath":"/waitlistedContacts/{tenantId}/session/{session_id}"},{"label":"Returns a waitlisted contact from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/waitlisted-contacts/deletewaitlistedcontact","routeSlug":"/apis/events/events-v1/waitlisted-contacts/deletewaitlistedcontact","metadata":{"seo":{"title":"Returns a waitlisted contact from the system by its ID.","description":"This method will delete a waitlisted contact with the specified ID."}},"httpPath":"/waitlistedContacts/{tenantId}/{id}"},{"label":"Returns a waitlisted contact from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/waitlisted-contacts/getwaitlistedcontact","routeSlug":"/apis/events/events-v1/waitlisted-contacts/getwaitlistedcontact","metadata":{"seo":{"title":"Returns a waitlisted contact from the system by its ID.","description":"This method will look up a waitlisted contact by the specified ID and return it back."}},"httpPath":"/waitlistedContacts/{tenantId}/{id}"},{"label":"Partially updates a waitlisted contact with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/waitlisted-contacts/patchwaitlistedcontact","routeSlug":"/apis/events/events-v1/waitlisted-contacts/patchwaitlistedcontact","metadata":{"seo":{"title":"Partially updates a waitlisted contact with the specified ID.","description":"This method will patch an existing waitlisted contact with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/waitlistedContacts/{tenantId}/{id}"},{"label":"Updates a waitlisted contact with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/events/events-v1/waitlisted-contacts/updatewaitlistedcontact","routeSlug":"/apis/events/events-v1/waitlisted-contacts/updatewaitlistedcontact","metadata":{"seo":{"title":"Updates a waitlisted contact with the specified ID.","description":"This method will update an existing waitlisted contact with the specified ID."}},"httpPath":"/waitlistedContacts/{tenantId}/{id}"}]}]},{"type":"group","label":"Fundraising","items":[{"type":"link","label":"Fundraising","link":"/apis/fundraising/fundraising-v1","routeSlug":"/apis/fundraising/fundraising-v1"},{"type":"group","label":"Appeals","link":"/apis/fundraising/fundraising-v1/appeals","routeSlug":"/apis/fundraising/fundraising-v1/appeals","items":[{"label":"Gets all of the appeals in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/appeals/listappeals","routeSlug":"/apis/fundraising/fundraising-v1/appeals/listappeals","metadata":{"seo":{"title":"Gets all of the appeals in the system.","description":"This method will scan all appeals and and return them to the caller."}},"httpPath":"/appeals/{tenantId}"},{"label":"Creates a new appeal record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/appeals/createappeal","routeSlug":"/apis/fundraising/fundraising-v1/appeals/createappeal","metadata":{"seo":{"title":"Creates a new appeal record that does not already exist.","description":"This method will auto-generate an ID and create a new appeal. If an ID is specified for the appeal, an error will be thrown."}},"httpPath":"/appeals/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/appeals/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/appeals/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/appeals/{tenantId}/batch"},{"label":"Returns a list of records with the specified campaign_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/appeals/listappealsbycampaignid","routeSlug":"/apis/fundraising/fundraising-v1/appeals/listappealsbycampaignid","metadata":{"seo":{"title":"Returns a list of records with the specified campaign_id","description":"Returns a list of records with the specified campaign_id"}},"httpPath":"/appeals/{tenantId}/campaign/{campaign_id}"},{"label":"Searches for appeals using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/appeals/searchforappeals","routeSlug":"/apis/fundraising/fundraising-v1/appeals/searchforappeals","metadata":{"seo":{"title":"Searches for appeals using predefined parameters","description":"Searches for appeals using predefined parameters"}},"httpPath":"/appeals/{tenantId}/search"},{"label":"Returns a appeal from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/appeals/deleteappeal","routeSlug":"/apis/fundraising/fundraising-v1/appeals/deleteappeal","metadata":{"seo":{"title":"Returns a appeal from the system by its ID.","description":"This method will delete a appeal with the specified ID."}},"httpPath":"/appeals/{tenantId}/{id}"},{"label":"Returns a appeal from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/appeals/getappeal","routeSlug":"/apis/fundraising/fundraising-v1/appeals/getappeal","metadata":{"seo":{"title":"Returns a appeal from the system by its ID.","description":"This method will look up a appeal by the specified ID and return it back."}},"httpPath":"/appeals/{tenantId}/{id}"},{"label":"Partially updates a appeal with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/appeals/patchappeal","routeSlug":"/apis/fundraising/fundraising-v1/appeals/patchappeal","metadata":{"seo":{"title":"Partially updates a appeal with the specified ID.","description":"This method will patch an existing appeal with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/appeals/{tenantId}/{id}"},{"label":"Updates a appeal with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/appeals/updateappeal","routeSlug":"/apis/fundraising/fundraising-v1/appeals/updateappeal","metadata":{"seo":{"title":"Updates a appeal with the specified ID.","description":"This method will update an existing appeal with the specified ID."}},"httpPath":"/appeals/{tenantId}/{id}"}]},{"type":"group","label":"Billing Templates","link":"/apis/fundraising/fundraising-v1/billing-templates","routeSlug":"/apis/fundraising/fundraising-v1/billing-templates","items":[{"label":"Gets all of the billing templates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/billing-templates/listbillingtemplates","routeSlug":"/apis/fundraising/fundraising-v1/billing-templates/listbillingtemplates","metadata":{"seo":{"title":"Gets all of the billing templates in the system.","description":"This method will scan all billing templates and and return them to the caller."}},"httpPath":"/billingTemplates/{tenantId}"},{"label":"Creates a new billing template record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/billing-templates/createbillingtemplate","routeSlug":"/apis/fundraising/fundraising-v1/billing-templates/createbillingtemplate","metadata":{"seo":{"title":"Creates a new billing template record that does not already exist.","description":"This method will auto-generate an ID and create a new billing template. If an ID is specified for the billing template, an error will be thrown."}},"httpPath":"/billingTemplates/{tenantId}"},{"label":"Generates a billing run from a template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/billing-templates/generatebillingrunfromtemplate","routeSlug":"/apis/fundraising/fundraising-v1/billing-templates/generatebillingrunfromtemplate","metadata":{"seo":{"title":"Generates a billing run from a template","description":"Generates a billing run from a template"}},"httpPath":"/billingTemplates/{tenantId}/fromTemplate/{templateId}/{referenceDate}"},{"label":"Returns a billing template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/billing-templates/deletebillingtemplate","routeSlug":"/apis/fundraising/fundraising-v1/billing-templates/deletebillingtemplate","metadata":{"seo":{"title":"Returns a billing template from the system by its ID.","description":"This method will delete a billing template with the specified ID."}},"httpPath":"/billingTemplates/{tenantId}/{id}"},{"label":"Returns a billing template from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/billing-templates/getbillingtemplate","routeSlug":"/apis/fundraising/fundraising-v1/billing-templates/getbillingtemplate","metadata":{"seo":{"title":"Returns a billing template from the system by its ID.","description":"This method will look up a billing template by the specified ID and return it back."}},"httpPath":"/billingTemplates/{tenantId}/{id}"},{"label":"Partially updates a billing template with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/billing-templates/patchbillingtemplate","routeSlug":"/apis/fundraising/fundraising-v1/billing-templates/patchbillingtemplate","metadata":{"seo":{"title":"Partially updates a billing template with the specified ID.","description":"This method will patch an existing billing template with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/billingTemplates/{tenantId}/{id}"},{"label":"Updates a billing template with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/billing-templates/updatebillingtemplate","routeSlug":"/apis/fundraising/fundraising-v1/billing-templates/updatebillingtemplate","metadata":{"seo":{"title":"Updates a billing template with the specified ID.","description":"This method will update an existing billing template with the specified ID."}},"httpPath":"/billingTemplates/{tenantId}/{id}"}]},{"type":"group","label":"Campaigns","link":"/apis/fundraising/fundraising-v1/campaigns","routeSlug":"/apis/fundraising/fundraising-v1/campaigns","items":[{"label":"Creates a new campaign record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/campaigns/createcampaign","routeSlug":"/apis/fundraising/fundraising-v1/campaigns/createcampaign","metadata":{"seo":{"title":"Creates a new campaign record that does not already exist.","description":"This method will auto-generate an ID and create a new campaign. If an ID is specified for the campaign, an error will be thrown."}},"httpPath":"/campaigns/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/campaigns/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/campaigns/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/campaigns/{tenantId}/batch"},{"label":"Searches for campaigns using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/campaigns/searchforcampaigns","routeSlug":"/apis/fundraising/fundraising-v1/campaigns/searchforcampaigns","metadata":{"seo":{"title":"Searches for campaigns using predefined parameters","description":"Searches for campaigns using predefined parameters"}},"httpPath":"/campaigns/{tenantId}/search"},{"label":"Returns a campaign from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/campaigns/deletecampaign","routeSlug":"/apis/fundraising/fundraising-v1/campaigns/deletecampaign","metadata":{"seo":{"title":"Returns a campaign from the system by its ID.","description":"This method will delete a campaign with the specified ID."}},"httpPath":"/campaigns/{tenantId}/{id}"},{"label":"Returns a campaign from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/campaigns/getcampaign","routeSlug":"/apis/fundraising/fundraising-v1/campaigns/getcampaign","metadata":{"seo":{"title":"Returns a campaign from the system by its ID.","description":"This method will look up a campaign by the specified ID and return it back."}},"httpPath":"/campaigns/{tenantId}/{id}"},{"label":"Partially updates a campaign with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/campaigns/patchcampaign","routeSlug":"/apis/fundraising/fundraising-v1/campaigns/patchcampaign","metadata":{"seo":{"title":"Partially updates a campaign with the specified ID.","description":"This method will patch an existing campaign with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/campaigns/{tenantId}/{id}"},{"label":"Updates a campaign with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/campaigns/updatecampaign","routeSlug":"/apis/fundraising/fundraising-v1/campaigns/updatecampaign","metadata":{"seo":{"title":"Updates a campaign with the specified ID.","description":"This method will update an existing campaign with the specified ID."}},"httpPath":"/campaigns/{tenantId}/{id}"}]},{"type":"group","label":"Donor Clubs","link":"/apis/fundraising/fundraising-v1/donor-clubs","routeSlug":"/apis/fundraising/fundraising-v1/donor-clubs","items":[{"label":"Gets all of the donor clubs in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-clubs/listdonorclubs","routeSlug":"/apis/fundraising/fundraising-v1/donor-clubs/listdonorclubs","metadata":{"seo":{"title":"Gets all of the donor clubs in the system.","description":"This method will scan all donor clubs and and return them to the caller."}},"httpPath":"/donorClubs/{tenantId}"},{"label":"Creates a new donor club record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-clubs/createdonorclub","routeSlug":"/apis/fundraising/fundraising-v1/donor-clubs/createdonorclub","metadata":{"seo":{"title":"Creates a new donor club record that does not already exist.","description":"This method will auto-generate an ID and create a new donor club. If an ID is specified for the donor club, an error will be thrown."}},"httpPath":"/donorClubs/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-clubs/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/donor-clubs/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/donorClubs/{tenantId}/batch"},{"label":"Returns a donor club from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-clubs/deletedonorclub","routeSlug":"/apis/fundraising/fundraising-v1/donor-clubs/deletedonorclub","metadata":{"seo":{"title":"Returns a donor club from the system by its ID.","description":"This method will delete a donor club with the specified ID."}},"httpPath":"/donorClubs/{tenantId}/{id}"},{"label":"Returns a donor club from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-clubs/getdonorclub","routeSlug":"/apis/fundraising/fundraising-v1/donor-clubs/getdonorclub","metadata":{"seo":{"title":"Returns a donor club from the system by its ID.","description":"This method will look up a donor club by the specified ID and return it back."}},"httpPath":"/donorClubs/{tenantId}/{id}"},{"label":"Partially updates a donor club with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-clubs/patchdonorclub","routeSlug":"/apis/fundraising/fundraising-v1/donor-clubs/patchdonorclub","metadata":{"seo":{"title":"Partially updates a donor club with the specified ID.","description":"This method will patch an existing donor club with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/donorClubs/{tenantId}/{id}"},{"label":"Updates a donor club with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-clubs/updatedonorclub","routeSlug":"/apis/fundraising/fundraising-v1/donor-clubs/updatedonorclub","metadata":{"seo":{"title":"Updates a donor club with the specified ID.","description":"This method will update an existing donor club with the specified ID."}},"httpPath":"/donorClubs/{tenantId}/{id}"}]},{"type":"group","label":"Donor Levels","link":"/apis/fundraising/fundraising-v1/donor-levels","routeSlug":"/apis/fundraising/fundraising-v1/donor-levels","items":[{"label":"Gets all of the donor levels in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-levels/listdonorlevels","routeSlug":"/apis/fundraising/fundraising-v1/donor-levels/listdonorlevels","metadata":{"seo":{"title":"Gets all of the donor levels in the system.","description":"This method will scan all donor levels and and return them to the caller."}},"httpPath":"/donorLevels/{tenantId}"},{"label":"Creates a new donor level record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-levels/createdonorlevel","routeSlug":"/apis/fundraising/fundraising-v1/donor-levels/createdonorlevel","metadata":{"seo":{"title":"Creates a new donor level record that does not already exist.","description":"This method will auto-generate an ID and create a new donor level. If an ID is specified for the donor level, an error will be thrown."}},"httpPath":"/donorLevels/{tenantId}"},{"label":"Returns a donor level from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-levels/deletedonorlevel","routeSlug":"/apis/fundraising/fundraising-v1/donor-levels/deletedonorlevel","metadata":{"seo":{"title":"Returns a donor level from the system by its ID.","description":"This method will delete a donor level with the specified ID."}},"httpPath":"/donorLevels/{tenantId}/{id}"},{"label":"Returns a donor level from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-levels/getdonorlevel","routeSlug":"/apis/fundraising/fundraising-v1/donor-levels/getdonorlevel","metadata":{"seo":{"title":"Returns a donor level from the system by its ID.","description":"This method will look up a donor level by the specified ID and return it back."}},"httpPath":"/donorLevels/{tenantId}/{id}"},{"label":"Partially updates a donor level with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-levels/patchdonorlevel","routeSlug":"/apis/fundraising/fundraising-v1/donor-levels/patchdonorlevel","metadata":{"seo":{"title":"Partially updates a donor level with the specified ID.","description":"This method will patch an existing donor level with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/donorLevels/{tenantId}/{id}"},{"label":"Updates a donor level with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-levels/updatedonorlevel","routeSlug":"/apis/fundraising/fundraising-v1/donor-levels/updatedonorlevel","metadata":{"seo":{"title":"Updates a donor level with the specified ID.","description":"This method will update an existing donor level with the specified ID."}},"httpPath":"/donorLevels/{tenantId}/{id}"}]},{"type":"group","label":"Donor Statement Templates","link":"/apis/fundraising/fundraising-v1/donor-statement-templates","routeSlug":"/apis/fundraising/fundraising-v1/donor-statement-templates","items":[{"label":"Gets all of the donor statement templates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statement-templates/listdonorstatementtemplates","routeSlug":"/apis/fundraising/fundraising-v1/donor-statement-templates/listdonorstatementtemplates","metadata":{"seo":{"title":"Gets all of the donor statement templates in the system.","description":"This method will scan all donor statement templates and and return them to the caller."}},"httpPath":"/donorStatementTemplates/{tenantId}"},{"label":"Creates a new donor statement template record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statement-templates/createdonorstatementtemplate","routeSlug":"/apis/fundraising/fundraising-v1/donor-statement-templates/createdonorstatementtemplate","metadata":{"seo":{"title":"Creates a new donor statement template record that does not already exist.","description":"This method will auto-generate an ID and create a new donor statement template. If an ID is specified for the donor statement template, an error will be thrown."}},"httpPath":"/donorStatementTemplates/{tenantId}"},{"label":"Returns a donor statement template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statement-templates/deletedonorstatementtemplate","routeSlug":"/apis/fundraising/fundraising-v1/donor-statement-templates/deletedonorstatementtemplate","metadata":{"seo":{"title":"Returns a donor statement template from the system by its ID.","description":"This method will delete a donor statement template with the specified ID."}},"httpPath":"/donorStatementTemplates/{tenantId}/{id}"},{"label":"Returns a donor statement template from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statement-templates/getdonorstatementtemplate","routeSlug":"/apis/fundraising/fundraising-v1/donor-statement-templates/getdonorstatementtemplate","metadata":{"seo":{"title":"Returns a donor statement template from the system by its ID.","description":"This method will look up a donor statement template by the specified ID and return it back."}},"httpPath":"/donorStatementTemplates/{tenantId}/{id}"},{"label":"Partially updates a donor statement template with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statement-templates/patchdonorstatementtemplate","routeSlug":"/apis/fundraising/fundraising-v1/donor-statement-templates/patchdonorstatementtemplate","metadata":{"seo":{"title":"Partially updates a donor statement template with the specified ID.","description":"This method will patch an existing donor statement template with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/donorStatementTemplates/{tenantId}/{id}"},{"label":"Updates a donor statement template with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statement-templates/updatedonorstatementtemplate","routeSlug":"/apis/fundraising/fundraising-v1/donor-statement-templates/updatedonorstatementtemplate","metadata":{"seo":{"title":"Updates a donor statement template with the specified ID.","description":"This method will update an existing donor statement template with the specified ID."}},"httpPath":"/donorStatementTemplates/{tenantId}/{id}"}]},{"type":"group","label":"Donor Statements","link":"/apis/fundraising/fundraising-v1/donor-statements","routeSlug":"/apis/fundraising/fundraising-v1/donor-statements","items":[{"label":"Creates a new donor statement record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statements/createdonorstatement","routeSlug":"/apis/fundraising/fundraising-v1/donor-statements/createdonorstatement","metadata":{"seo":{"title":"Creates a new donor statement record that does not already exist.","description":"This method will auto-generate an ID and create a new donor statement. If an ID is specified for the donor statement, an error will be thrown."}},"httpPath":"/donorStatements/{tenantId}"},{"label":"Returns a list of records with the specified donor_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statements/liststatementsbydonorid","routeSlug":"/apis/fundraising/fundraising-v1/donor-statements/liststatementsbydonorid","metadata":{"seo":{"title":"Returns a list of records with the specified donor_id","description":"Returns a list of records with the specified donor_id"}},"httpPath":"/donorStatements/{tenantId}/donor/{donor_type}/{donor_id}"},{"label":"Returns a donor statement from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statements/deletedonorstatement","routeSlug":"/apis/fundraising/fundraising-v1/donor-statements/deletedonorstatement","metadata":{"seo":{"title":"Returns a donor statement from the system by its ID.","description":"This method will delete a donor statement with the specified ID."}},"httpPath":"/donorStatements/{tenantId}/{id}"},{"label":"Returns a donor statement from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statements/getdonorstatement","routeSlug":"/apis/fundraising/fundraising-v1/donor-statements/getdonorstatement","metadata":{"seo":{"title":"Returns a donor statement from the system by its ID.","description":"This method will look up a donor statement by the specified ID and return it back."}},"httpPath":"/donorStatements/{tenantId}/{id}"},{"label":"Partially updates a donor statement with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statements/patchdonorstatement","routeSlug":"/apis/fundraising/fundraising-v1/donor-statements/patchdonorstatement","metadata":{"seo":{"title":"Partially updates a donor statement with the specified ID.","description":"This method will patch an existing donor statement with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/donorStatements/{tenantId}/{id}"},{"label":"Updates a donor statement with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donor-statements/updatedonorstatement","routeSlug":"/apis/fundraising/fundraising-v1/donor-statements/updatedonorstatement","metadata":{"seo":{"title":"Updates a donor statement with the specified ID.","description":"This method will update an existing donor statement with the specified ID."}},"httpPath":"/donorStatements/{tenantId}/{id}"}]},{"type":"group","label":"Donors","link":"/apis/fundraising/fundraising-v1/donors","routeSlug":"/apis/fundraising/fundraising-v1/donors","items":[{"label":"Creates a new donor record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donors/createdonor","routeSlug":"/apis/fundraising/fundraising-v1/donors/createdonor","metadata":{"seo":{"title":"Creates a new donor record that does not already exist.","description":"This method will auto-generate an ID and create a new donor. If an ID is specified for the donor, an error will be thrown."}},"httpPath":"/donors/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donors/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/donors/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/donors/{tenantId}/batch"},{"label":"Recalculate Totals/Donor Clubs","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donors/recalculatedonortotals","routeSlug":"/apis/fundraising/fundraising-v1/donors/recalculatedonortotals","metadata":{"seo":{"title":"Recalculate Totals/Donor Clubs","description":"Goes through and recalculates all donor totals and automatic donor club assignments"}},"httpPath":"/donors/{tenantId}/recalculateDonorTotals"},{"label":"Searches for donors using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donors/searchfordonors","routeSlug":"/apis/fundraising/fundraising-v1/donors/searchfordonors","metadata":{"seo":{"title":"Searches for donors using predefined parameters","description":"Searches for donors using predefined parameters"}},"httpPath":"/donors/{tenantId}/search"},{"label":"Returns a donor from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donors/deletedonor","routeSlug":"/apis/fundraising/fundraising-v1/donors/deletedonor","metadata":{"seo":{"title":"Returns a donor from the system by its ID.","description":"This method will delete a donor with the specified ID."}},"httpPath":"/donors/{tenantId}/{id}"},{"label":"Returns a donor from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donors/getdonor","routeSlug":"/apis/fundraising/fundraising-v1/donors/getdonor","metadata":{"seo":{"title":"Returns a donor from the system by its ID.","description":"This method will look up a donor by the specified ID and return it back."}},"httpPath":"/donors/{tenantId}/{id}"},{"label":"Partially updates a donor with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donors/patchdonor","routeSlug":"/apis/fundraising/fundraising-v1/donors/patchdonor","metadata":{"seo":{"title":"Partially updates a donor with the specified ID.","description":"This method will patch an existing donor with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/donors/{tenantId}/{id}"},{"label":"Updates a donor with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/donors/updatedonor","routeSlug":"/apis/fundraising/fundraising-v1/donors/updatedonor","metadata":{"seo":{"title":"Updates a donor with the specified ID.","description":"This method will update an existing donor with the specified ID."}},"httpPath":"/donors/{tenantId}/{id}"}]},{"type":"group","label":"Fund Categories","link":"/apis/fundraising/fundraising-v1/fund-categories","routeSlug":"/apis/fundraising/fundraising-v1/fund-categories","items":[{"label":"Gets all of the fund categories in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/fund-categories/listfundcategories","routeSlug":"/apis/fundraising/fundraising-v1/fund-categories/listfundcategories","metadata":{"seo":{"title":"Gets all of the fund categories in the system.","description":"This method will scan all fund categories and and return them to the caller."}},"httpPath":"/fundCategories/{tenantId}"},{"label":"Creates a new fund category record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/fund-categories/createfundcategory","routeSlug":"/apis/fundraising/fundraising-v1/fund-categories/createfundcategory","metadata":{"seo":{"title":"Creates a new fund category record that does not already exist.","description":"This method will auto-generate an ID and create a new fund category. If an ID is specified for the fund category, an error will be thrown."}},"httpPath":"/fundCategories/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/fund-categories/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/fund-categories/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/fundCategories/{tenantId}/batch"},{"label":"Returns a fund category from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/fund-categories/deletefundcategory","routeSlug":"/apis/fundraising/fundraising-v1/fund-categories/deletefundcategory","metadata":{"seo":{"title":"Returns a fund category from the system by its ID.","description":"This method will delete a fund category with the specified ID."}},"httpPath":"/fundCategories/{tenantId}/{id}"},{"label":"Returns a fund category from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/fund-categories/getfundcategory","routeSlug":"/apis/fundraising/fundraising-v1/fund-categories/getfundcategory","metadata":{"seo":{"title":"Returns a fund category from the system by its ID.","description":"This method will look up a fund category by the specified ID and return it back."}},"httpPath":"/fundCategories/{tenantId}/{id}"},{"label":"Partially updates a fund category with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/fund-categories/patchfundcategory","routeSlug":"/apis/fundraising/fundraising-v1/fund-categories/patchfundcategory","metadata":{"seo":{"title":"Partially updates a fund category with the specified ID.","description":"This method will patch an existing fund category with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/fundCategories/{tenantId}/{id}"},{"label":"Updates a fund category with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/fund-categories/updatefundcategory","routeSlug":"/apis/fundraising/fundraising-v1/fund-categories/updatefundcategory","metadata":{"seo":{"title":"Updates a fund category with the specified ID.","description":"This method will update an existing fund category with the specified ID."}},"httpPath":"/fundCategories/{tenantId}/{id}"}]},{"type":"group","label":"Funds","link":"/apis/fundraising/fundraising-v1/funds","routeSlug":"/apis/fundraising/fundraising-v1/funds","items":[{"label":"Gets all of the funds in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/funds/listfunds","routeSlug":"/apis/fundraising/fundraising-v1/funds/listfunds","metadata":{"seo":{"title":"Gets all of the funds in the system.","description":"This method will scan all funds and and return them to the caller."}},"httpPath":"/funds/{tenantId}"},{"label":"Creates a new fund record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/funds/createfund","routeSlug":"/apis/fundraising/fundraising-v1/funds/createfund","metadata":{"seo":{"title":"Creates a new fund record that does not already exist.","description":"This method will auto-generate an ID and create a new fund. If an ID is specified for the fund, an error will be thrown."}},"httpPath":"/funds/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/funds/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/funds/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/funds/{tenantId}/batch"},{"label":"Returns a fund from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/funds/deletefund","routeSlug":"/apis/fundraising/fundraising-v1/funds/deletefund","metadata":{"seo":{"title":"Returns a fund from the system by its ID.","description":"This method will delete a fund with the specified ID."}},"httpPath":"/funds/{tenantId}/{id}"},{"label":"Returns a fund from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/funds/getfund","routeSlug":"/apis/fundraising/fundraising-v1/funds/getfund","metadata":{"seo":{"title":"Returns a fund from the system by its ID.","description":"This method will look up a fund by the specified ID and return it back."}},"httpPath":"/funds/{tenantId}/{id}"},{"label":"Partially updates a fund with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/funds/patchfund","routeSlug":"/apis/fundraising/fundraising-v1/funds/patchfund","metadata":{"seo":{"title":"Partially updates a fund with the specified ID.","description":"This method will patch an existing fund with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/funds/{tenantId}/{id}"},{"label":"Updates a fund with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/funds/updatefund","routeSlug":"/apis/fundraising/fundraising-v1/funds/updatefund","metadata":{"seo":{"title":"Updates a fund with the specified ID.","description":"This method will update an existing fund with the specified ID."}},"httpPath":"/funds/{tenantId}/{id}"}]},{"type":"group","label":"Gift Notices","link":"/apis/fundraising/fundraising-v1/gift-notices","routeSlug":"/apis/fundraising/fundraising-v1/gift-notices","items":[{"label":"Gets all of the gift notices in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gift-notices/listgiftnotices","routeSlug":"/apis/fundraising/fundraising-v1/gift-notices/listgiftnotices","metadata":{"seo":{"title":"Gets all of the gift notices in the system.","description":"This method will scan all gift notices and and return them to the caller."}},"httpPath":"/giftNotices/{tenantId}"},{"label":"Creates a new gift notice record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gift-notices/creategiftnotice","routeSlug":"/apis/fundraising/fundraising-v1/gift-notices/creategiftnotice","metadata":{"seo":{"title":"Creates a new gift notice record that does not already exist.","description":"This method will auto-generate an ID and create a new gift notice. If an ID is specified for the gift notice, an error will be thrown."}},"httpPath":"/giftNotices/{tenantId}"},{"label":"Returns a gift notice from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gift-notices/deletegiftnotice","routeSlug":"/apis/fundraising/fundraising-v1/gift-notices/deletegiftnotice","metadata":{"seo":{"title":"Returns a gift notice from the system by its ID.","description":"This method will delete a gift notice with the specified ID."}},"httpPath":"/giftNotices/{tenantId}/{id}"},{"label":"Returns a gift notice from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gift-notices/getgiftnotice","routeSlug":"/apis/fundraising/fundraising-v1/gift-notices/getgiftnotice","metadata":{"seo":{"title":"Returns a gift notice from the system by its ID.","description":"This method will look up a gift notice by the specified ID and return it back."}},"httpPath":"/giftNotices/{tenantId}/{id}"},{"label":"Partially updates a gift notice with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gift-notices/patchgiftnotice","routeSlug":"/apis/fundraising/fundraising-v1/gift-notices/patchgiftnotice","metadata":{"seo":{"title":"Partially updates a gift notice with the specified ID.","description":"This method will patch an existing gift notice with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/giftNotices/{tenantId}/{id}"},{"label":"Updates a gift notice with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gift-notices/updategiftnotice","routeSlug":"/apis/fundraising/fundraising-v1/gift-notices/updategiftnotice","metadata":{"seo":{"title":"Updates a gift notice with the specified ID.","description":"This method will update an existing gift notice with the specified ID."}},"httpPath":"/giftNotices/{tenantId}/{id}"}]},{"type":"group","label":"Gifts","link":"/apis/fundraising/fundraising-v1/gifts","routeSlug":"/apis/fundraising/fundraising-v1/gifts","items":[{"label":"Gets all of the gifts in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/listgifts","routeSlug":"/apis/fundraising/fundraising-v1/gifts/listgifts","metadata":{"seo":{"title":"Gets all of the gifts in the system.","description":"This method will scan all gifts and and return them to the caller."}},"httpPath":"/gifts/{tenantId}"},{"label":"Creates a new gift record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/creategift","routeSlug":"/apis/fundraising/fundraising-v1/gifts/creategift","metadata":{"seo":{"title":"Creates a new gift record that does not already exist.","description":"This method will auto-generate an ID and create a new gift. If an ID is specified for the gift, an error will be thrown."}},"httpPath":"/gifts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/gifts/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/gifts/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/listgiftsbycontactid","routeSlug":"/apis/fundraising/fundraising-v1/gifts/listgiftsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/gifts/{tenantId}/contact/{contact_id}"},{"label":"Returns a list of records with the specified donor_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/listgiftsbydonorid","routeSlug":"/apis/fundraising/fundraising-v1/gifts/listgiftsbydonorid","metadata":{"seo":{"title":"Returns a list of records with the specified donor_id","description":"Returns a list of records with the specified donor_id"}},"httpPath":"/gifts/{tenantId}/donor/{donor_id}"},{"label":"Generates an order from a fundraising gift","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/generateorder","routeSlug":"/apis/fundraising/fundraising-v1/gifts/generateorder","metadata":{"seo":{"title":"Generates an order from a fundraising gift","description":"This method will examine a fundraising gift and generate an appropriate order"}},"httpPath":"/gifts/{tenantId}/generateOrder"},{"label":"Returns a list of records with the specified master_gift_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/listgiftsbymastergiftid","routeSlug":"/apis/fundraising/fundraising-v1/gifts/listgiftsbymastergiftid","metadata":{"seo":{"title":"Returns a list of records with the specified master_gift_id","description":"Returns a list of records with the specified master_gift_id"}},"httpPath":"/gifts/{tenantId}/masterGift/{master_gift_id}"},{"label":"Migrate Donation Orders","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/migratedonations","routeSlug":"/apis/fundraising/fundraising-v1/gifts/migratedonations","metadata":{"seo":{"title":"Migrate Donation Orders","description":"Will migrate all previous orders for donation products"}},"httpPath":"/gifts/{tenantId}/migrateDonationOrders"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/listgiftsbyorderid","routeSlug":"/apis/fundraising/fundraising-v1/gifts/listgiftsbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"httpPath":"/gifts/{tenantId}/order/{order_id}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/listgiftsbyorganizationid","routeSlug":"/apis/fundraising/fundraising-v1/gifts/listgiftsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/gifts/{tenantId}/organization/{organization_id}"},{"label":"Returns a list of records with the specified pledge_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/listgiftsbypledgeid","routeSlug":"/apis/fundraising/fundraising-v1/gifts/listgiftsbypledgeid","metadata":{"seo":{"title":"Returns a list of records with the specified pledge_id","description":"Returns a list of records with the specified pledge_id"}},"httpPath":"/gifts/{tenantId}/pledge/{pledge_id}"},{"label":"Preview Gift Receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/previewreceipt","routeSlug":"/apis/fundraising/fundraising-v1/gifts/previewreceipt","metadata":{"seo":{"title":"Preview Gift Receipt","description":"Sends out a preview of the gift receipt email"}},"httpPath":"/gifts/{tenantId}/previewReceipt"},{"label":"Resend Receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/processgift","routeSlug":"/apis/fundraising/fundraising-v1/gifts/processgift","metadata":{"seo":{"title":"Resend Receipt","description":"Resends the gift receipt"}},"httpPath":"/gifts/{tenantId}/process"},{"label":"Get Public Giving Form Manifest","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/getpublicgivingformmanifest","routeSlug":"/apis/fundraising/fundraising-v1/gifts/getpublicgivingformmanifest","metadata":{"seo":{"title":"Get Public Giving Form Manifest","description":"Public API Endpoint that gets information used to populate the giving form"}},"httpPath":"/gifts/{tenantId}/public/givingFormManifest"},{"label":"Resend Receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/processgiftpublicly","routeSlug":"/apis/fundraising/fundraising-v1/gifts/processgiftpublicly","metadata":{"seo":{"title":"Resend Receipt","description":"Resends the gift receipt"}},"httpPath":"/gifts/{tenantId}/public/process"},{"label":"Returns a list of records with the specified recurring_gift_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/listgiftsbyrecurringgiftid","routeSlug":"/apis/fundraising/fundraising-v1/gifts/listgiftsbyrecurringgiftid","metadata":{"seo":{"title":"Returns a list of records with the specified recurring_gift_id","description":"Returns a list of records with the specified recurring_gift_id"}},"httpPath":"/gifts/{tenantId}/recurringGift/{recurring_gift_id}"},{"label":"Resend Receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/resendreceipt","routeSlug":"/apis/fundraising/fundraising-v1/gifts/resendreceipt","metadata":{"seo":{"title":"Resend Receipt","description":"Resends the gift receipt"}},"httpPath":"/gifts/{tenantId}/resendReceipt/{id}"},{"label":"Searches for gifts using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/searchforgifts","routeSlug":"/apis/fundraising/fundraising-v1/gifts/searchforgifts","metadata":{"seo":{"title":"Searches for gifts using predefined parameters","description":"Searches for gifts using predefined parameters"}},"httpPath":"/gifts/{tenantId}/search"},{"label":"List Donor Soft Credits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/getsoftcreditsfordonor","routeSlug":"/apis/fundraising/fundraising-v1/gifts/getsoftcreditsfordonor","metadata":{"seo":{"title":"List Donor Soft Credits","description":"Lists all the soft credits for a donor"}},"httpPath":"/gifts/{tenantId}/softCredits/{donorId}"},{"label":"Returns a gift from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/deletegift","routeSlug":"/apis/fundraising/fundraising-v1/gifts/deletegift","metadata":{"seo":{"title":"Returns a gift from the system by its ID.","description":"This method will delete a gift with the specified ID."}},"httpPath":"/gifts/{tenantId}/{id}"},{"label":"Returns a gift from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/getgift","routeSlug":"/apis/fundraising/fundraising-v1/gifts/getgift","metadata":{"seo":{"title":"Returns a gift from the system by its ID.","description":"This method will look up a gift by the specified ID and return it back."}},"httpPath":"/gifts/{tenantId}/{id}"},{"label":"Partially updates a gift with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/patchgift","routeSlug":"/apis/fundraising/fundraising-v1/gifts/patchgift","metadata":{"seo":{"title":"Partially updates a gift with the specified ID.","description":"This method will patch an existing gift with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/gifts/{tenantId}/{id}"},{"label":"Updates a gift with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/gifts/updategift","routeSlug":"/apis/fundraising/fundraising-v1/gifts/updategift","metadata":{"seo":{"title":"Updates a gift with the specified ID.","description":"This method will update an existing gift with the specified ID."}},"httpPath":"/gifts/{tenantId}/{id}"}]},{"type":"group","label":"Giving Processes","link":"/apis/fundraising/fundraising-v1/giving-processes","routeSlug":"/apis/fundraising/fundraising-v1/giving-processes","items":[{"label":"Gets all of the giving processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/giving-processes/listgivingprocesses","routeSlug":"/apis/fundraising/fundraising-v1/giving-processes/listgivingprocesses","metadata":{"seo":{"title":"Gets all of the giving processes in the system.","description":"This method will scan all giving processes and and return them to the caller."}},"httpPath":"/givingProcesses/{tenantId}"},{"label":"Creates a new giving process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/giving-processes/creategivingprocess","routeSlug":"/apis/fundraising/fundraising-v1/giving-processes/creategivingprocess","metadata":{"seo":{"title":"Creates a new giving process record that does not already exist.","description":"This method will auto-generate an ID and create a new giving process. If an ID is specified for the giving process, an error will be thrown."}},"httpPath":"/givingProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/giving-processes/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/giving-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/givingProcesses/{tenantId}/batch"},{"label":"Gets all of the processes a contact/org is eligible to use","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/giving-processes/geteligibleprocesses","routeSlug":"/apis/fundraising/fundraising-v1/giving-processes/geteligibleprocesses","metadata":{"seo":{"title":"Gets all of the processes a contact/org is eligible to use","description":"Gets all of the processes a contact/org is eligible to use"}},"httpPath":"/givingProcesses/{tenantId}/eligible/{customerType}/{contactOrOrganizationId}"},{"label":"Returns a giving process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/giving-processes/deletegivingprocess","routeSlug":"/apis/fundraising/fundraising-v1/giving-processes/deletegivingprocess","metadata":{"seo":{"title":"Returns a giving process from the system by its ID.","description":"This method will delete a giving process with the specified ID."}},"httpPath":"/givingProcesses/{tenantId}/{id}"},{"label":"Returns a giving process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/giving-processes/getgivingprocess","routeSlug":"/apis/fundraising/fundraising-v1/giving-processes/getgivingprocess","metadata":{"seo":{"title":"Returns a giving process from the system by its ID.","description":"This method will look up a giving process by the specified ID and return it back."}},"httpPath":"/givingProcesses/{tenantId}/{id}"},{"label":"Partially updates a giving process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/giving-processes/patchgivingprocess","routeSlug":"/apis/fundraising/fundraising-v1/giving-processes/patchgivingprocess","metadata":{"seo":{"title":"Partially updates a giving process with the specified ID.","description":"This method will patch an existing giving process with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/givingProcesses/{tenantId}/{id}"},{"label":"Updates a giving process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/giving-processes/updategivingprocess","routeSlug":"/apis/fundraising/fundraising-v1/giving-processes/updategivingprocess","metadata":{"seo":{"title":"Updates a giving process with the specified ID.","description":"This method will update an existing giving process with the specified ID."}},"httpPath":"/givingProcesses/{tenantId}/{id}"}]},{"type":"group","label":"Pledge Levels","link":"/apis/fundraising/fundraising-v1/pledge-levels","routeSlug":"/apis/fundraising/fundraising-v1/pledge-levels","items":[{"label":"Gets all of the pledge levels in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-levels/listpledgelevels","routeSlug":"/apis/fundraising/fundraising-v1/pledge-levels/listpledgelevels","metadata":{"seo":{"title":"Gets all of the pledge levels in the system.","description":"This method will scan all pledge levels and and return them to the caller."}},"httpPath":"/pledgeLevels/{tenantId}"},{"label":"Creates a new pledge level record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-levels/createpledgelevel","routeSlug":"/apis/fundraising/fundraising-v1/pledge-levels/createpledgelevel","metadata":{"seo":{"title":"Creates a new pledge level record that does not already exist.","description":"This method will auto-generate an ID and create a new pledge level. If an ID is specified for the pledge level, an error will be thrown."}},"httpPath":"/pledgeLevels/{tenantId}"},{"label":"Returns a pledge level from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-levels/deletepledgelevel","routeSlug":"/apis/fundraising/fundraising-v1/pledge-levels/deletepledgelevel","metadata":{"seo":{"title":"Returns a pledge level from the system by its ID.","description":"This method will delete a pledge level with the specified ID."}},"httpPath":"/pledgeLevels/{tenantId}/{id}"},{"label":"Returns a pledge level from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-levels/getpledgelevel","routeSlug":"/apis/fundraising/fundraising-v1/pledge-levels/getpledgelevel","metadata":{"seo":{"title":"Returns a pledge level from the system by its ID.","description":"This method will look up a pledge level by the specified ID and return it back."}},"httpPath":"/pledgeLevels/{tenantId}/{id}"},{"label":"Partially updates a pledge level with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-levels/patchpledgelevel","routeSlug":"/apis/fundraising/fundraising-v1/pledge-levels/patchpledgelevel","metadata":{"seo":{"title":"Partially updates a pledge level with the specified ID.","description":"This method will patch an existing pledge level with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/pledgeLevels/{tenantId}/{id}"},{"label":"Updates a pledge level with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-levels/updatepledgelevel","routeSlug":"/apis/fundraising/fundraising-v1/pledge-levels/updatepledgelevel","metadata":{"seo":{"title":"Updates a pledge level with the specified ID.","description":"This method will update an existing pledge level with the specified ID."}},"httpPath":"/pledgeLevels/{tenantId}/{id}"}]},{"type":"group","label":"Pledge Notices","link":"/apis/fundraising/fundraising-v1/pledge-notices","routeSlug":"/apis/fundraising/fundraising-v1/pledge-notices","items":[{"label":"Gets all of the pledge notices in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-notices/listpledgenotices","routeSlug":"/apis/fundraising/fundraising-v1/pledge-notices/listpledgenotices","metadata":{"seo":{"title":"Gets all of the pledge notices in the system.","description":"This method will scan all pledge notices and and return them to the caller."}},"httpPath":"/pledgeNotices/{tenantId}"},{"label":"Creates a new pledge notice record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-notices/createpledgenotice","routeSlug":"/apis/fundraising/fundraising-v1/pledge-notices/createpledgenotice","metadata":{"seo":{"title":"Creates a new pledge notice record that does not already exist.","description":"This method will auto-generate an ID and create a new pledge notice. If an ID is specified for the pledge notice, an error will be thrown."}},"httpPath":"/pledgeNotices/{tenantId}"},{"label":"Returns a pledge notice from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-notices/deletepledgenotice","routeSlug":"/apis/fundraising/fundraising-v1/pledge-notices/deletepledgenotice","metadata":{"seo":{"title":"Returns a pledge notice from the system by its ID.","description":"This method will delete a pledge notice with the specified ID."}},"httpPath":"/pledgeNotices/{tenantId}/{id}"},{"label":"Returns a pledge notice from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-notices/getpledgenotice","routeSlug":"/apis/fundraising/fundraising-v1/pledge-notices/getpledgenotice","metadata":{"seo":{"title":"Returns a pledge notice from the system by its ID.","description":"This method will look up a pledge notice by the specified ID and return it back."}},"httpPath":"/pledgeNotices/{tenantId}/{id}"},{"label":"Partially updates a pledge notice with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-notices/patchpledgenotice","routeSlug":"/apis/fundraising/fundraising-v1/pledge-notices/patchpledgenotice","metadata":{"seo":{"title":"Partially updates a pledge notice with the specified ID.","description":"This method will patch an existing pledge notice with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/pledgeNotices/{tenantId}/{id}"},{"label":"Updates a pledge notice with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledge-notices/updatepledgenotice","routeSlug":"/apis/fundraising/fundraising-v1/pledge-notices/updatepledgenotice","metadata":{"seo":{"title":"Updates a pledge notice with the specified ID.","description":"This method will update an existing pledge notice with the specified ID."}},"httpPath":"/pledgeNotices/{tenantId}/{id}"}]},{"type":"group","label":"Pledges","link":"/apis/fundraising/fundraising-v1/pledges","routeSlug":"/apis/fundraising/fundraising-v1/pledges","items":[{"label":"Creates a new pledge record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/createpledge","routeSlug":"/apis/fundraising/fundraising-v1/pledges/createpledge","metadata":{"seo":{"title":"Creates a new pledge record that does not already exist.","description":"This method will auto-generate an ID and create a new pledge. If an ID is specified for the pledge, an error will be thrown."}},"httpPath":"/pledges/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/pledges/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/pledges/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/listpledgesbycontactid","routeSlug":"/apis/fundraising/fundraising-v1/pledges/listpledgesbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/pledges/{tenantId}/contact/{contact_id}"},{"label":"Returns a list of records with the specified donor_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/listpledgesbydonorid","routeSlug":"/apis/fundraising/fundraising-v1/pledges/listpledgesbydonorid","metadata":{"seo":{"title":"Returns a list of records with the specified donor_id","description":"Returns a list of records with the specified donor_id"}},"httpPath":"/pledges/{tenantId}/donor/{donor_id}"},{"label":"Generates an order from a fundraising pledge","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/generateorder","routeSlug":"/apis/fundraising/fundraising-v1/pledges/generateorder","metadata":{"seo":{"title":"Generates an order from a fundraising pledge","description":"This method will examine a fundraising pledge and generate an appropriate order"}},"httpPath":"/pledges/{tenantId}/generateOrder"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/listpledgesbyorderid","routeSlug":"/apis/fundraising/fundraising-v1/pledges/listpledgesbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"httpPath":"/pledges/{tenantId}/order/{order_id}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/listpledgesbyorganizationid","routeSlug":"/apis/fundraising/fundraising-v1/pledges/listpledgesbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/pledges/{tenantId}/organization/{organization_id}"},{"label":"Sends out a preview of the pledge notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/previewemail","routeSlug":"/apis/fundraising/fundraising-v1/pledges/previewemail","metadata":{"seo":{"title":"Sends out a preview of the pledge notification email","description":"Sends out a preview of the pledge notification email"}},"httpPath":"/pledges/{tenantId}/previewEmail"},{"label":"Preview Pledge Receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/previewreceipt","routeSlug":"/apis/fundraising/fundraising-v1/pledges/previewreceipt","metadata":{"seo":{"title":"Preview Pledge Receipt","description":"Sends out a preview of the pledge receipt email"}},"httpPath":"/pledges/{tenantId}/previewReceipt"},{"label":"Resend Receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/processpledge","routeSlug":"/apis/fundraising/fundraising-v1/pledges/processpledge","metadata":{"seo":{"title":"Resend Receipt","description":"Resends the pledge receipt"}},"httpPath":"/pledges/{tenantId}/process"},{"label":"Resend Receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/processpledgepublicly","routeSlug":"/apis/fundraising/fundraising-v1/pledges/processpledgepublicly","metadata":{"seo":{"title":"Resend Receipt","description":"Resends the pledge receipt"}},"httpPath":"/pledges/{tenantId}/public/process"},{"label":"Resend Receipt","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/resendreceipt","routeSlug":"/apis/fundraising/fundraising-v1/pledges/resendreceipt","metadata":{"seo":{"title":"Resend Receipt","description":"Resends the pledge receipt"}},"httpPath":"/pledges/{tenantId}/resendReceipt/{id}"},{"label":"Searches for pledges using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/searchforpledges","routeSlug":"/apis/fundraising/fundraising-v1/pledges/searchforpledges","metadata":{"seo":{"title":"Searches for pledges using predefined parameters","description":"Searches for pledges using predefined parameters"}},"httpPath":"/pledges/{tenantId}/search"},{"label":"Returns a pledge from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/deletepledge","routeSlug":"/apis/fundraising/fundraising-v1/pledges/deletepledge","metadata":{"seo":{"title":"Returns a pledge from the system by its ID.","description":"This method will delete a pledge with the specified ID."}},"httpPath":"/pledges/{tenantId}/{id}"},{"label":"Returns a pledge from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/getpledge","routeSlug":"/apis/fundraising/fundraising-v1/pledges/getpledge","metadata":{"seo":{"title":"Returns a pledge from the system by its ID.","description":"This method will look up a pledge by the specified ID and return it back."}},"httpPath":"/pledges/{tenantId}/{id}"},{"label":"Partially updates a pledge with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/patchpledge","routeSlug":"/apis/fundraising/fundraising-v1/pledges/patchpledge","metadata":{"seo":{"title":"Partially updates a pledge with the specified ID.","description":"This method will patch an existing pledge with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/pledges/{tenantId}/{id}"},{"label":"Updates a pledge with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/pledges/updatepledge","routeSlug":"/apis/fundraising/fundraising-v1/pledges/updatepledge","metadata":{"seo":{"title":"Updates a pledge with the specified ID.","description":"This method will update an existing pledge with the specified ID."}},"httpPath":"/pledges/{tenantId}/{id}"}]},{"type":"group","label":"Premiums","link":"/apis/fundraising/fundraising-v1/premiums","routeSlug":"/apis/fundraising/fundraising-v1/premiums","items":[{"label":"Gets all of the premiums in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/premiums/listpremiums","routeSlug":"/apis/fundraising/fundraising-v1/premiums/listpremiums","metadata":{"seo":{"title":"Gets all of the premiums in the system.","description":"This method will scan all premiums and and return them to the caller."}},"httpPath":"/premiums/{tenantId}"},{"label":"Creates a new premium record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/premiums/createpremium","routeSlug":"/apis/fundraising/fundraising-v1/premiums/createpremium","metadata":{"seo":{"title":"Creates a new premium record that does not already exist.","description":"This method will auto-generate an ID and create a new premium. If an ID is specified for the premium, an error will be thrown."}},"httpPath":"/premiums/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/premiums/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/premiums/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/premiums/{tenantId}/batch"},{"label":"Returns a premium from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/premiums/deletepremium","routeSlug":"/apis/fundraising/fundraising-v1/premiums/deletepremium","metadata":{"seo":{"title":"Returns a premium from the system by its ID.","description":"This method will delete a premium with the specified ID."}},"httpPath":"/premiums/{tenantId}/{id}"},{"label":"Returns a premium from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/premiums/getpremium","routeSlug":"/apis/fundraising/fundraising-v1/premiums/getpremium","metadata":{"seo":{"title":"Returns a premium from the system by its ID.","description":"This method will look up a premium by the specified ID and return it back."}},"httpPath":"/premiums/{tenantId}/{id}"},{"label":"Partially updates a premium with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/premiums/patchpremium","routeSlug":"/apis/fundraising/fundraising-v1/premiums/patchpremium","metadata":{"seo":{"title":"Partially updates a premium with the specified ID.","description":"This method will patch an existing premium with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/premiums/{tenantId}/{id}"},{"label":"Updates a premium with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/premiums/updatepremium","routeSlug":"/apis/fundraising/fundraising-v1/premiums/updatepremium","metadata":{"seo":{"title":"Updates a premium with the specified ID.","description":"This method will update an existing premium with the specified ID."}},"httpPath":"/premiums/{tenantId}/{id}"}]},{"type":"group","label":"Products","link":"/apis/fundraising/fundraising-v1/products","routeSlug":"/apis/fundraising/fundraising-v1/products","items":[{"label":"Gets all of the products in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/products/listproducts","routeSlug":"/apis/fundraising/fundraising-v1/products/listproducts","metadata":{"seo":{"title":"Gets all of the products in the system.","description":"This method will scan all products and and return them to the caller."}},"httpPath":"/products/{tenantId}"},{"label":"Creates a new product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/products/createproduct","routeSlug":"/apis/fundraising/fundraising-v1/products/createproduct","metadata":{"seo":{"title":"Creates a new product record that does not already exist.","description":"This method will auto-generate an ID and create a new product. If an ID is specified for the product, an error will be thrown."}},"httpPath":"/products/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/products/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/products/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/products/{tenantId}/batch"},{"label":"Returns a list of records with the specified fund_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/products/listproductsbyfundid","routeSlug":"/apis/fundraising/fundraising-v1/products/listproductsbyfundid","metadata":{"seo":{"title":"Returns a list of records with the specified fund_id","description":"Returns a list of records with the specified fund_id"}},"httpPath":"/products/{tenantId}/fund/{fund_id}"},{"label":"Returns a product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/products/deleteproduct","routeSlug":"/apis/fundraising/fundraising-v1/products/deleteproduct","metadata":{"seo":{"title":"Returns a product from the system by its ID.","description":"This method will delete a product with the specified ID."}},"httpPath":"/products/{tenantId}/{id}"},{"label":"Returns a product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/products/getproduct","routeSlug":"/apis/fundraising/fundraising-v1/products/getproduct","metadata":{"seo":{"title":"Returns a product from the system by its ID.","description":"This method will look up a product by the specified ID and return it back."}},"httpPath":"/products/{tenantId}/{id}"},{"label":"Partially updates a product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/products/patchproduct","routeSlug":"/apis/fundraising/fundraising-v1/products/patchproduct","metadata":{"seo":{"title":"Partially updates a product with the specified ID.","description":"This method will patch an existing product with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/products/{tenantId}/{id}"},{"label":"Updates a product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/products/updateproduct","routeSlug":"/apis/fundraising/fundraising-v1/products/updateproduct","metadata":{"seo":{"title":"Updates a product with the specified ID.","description":"This method will update an existing product with the specified ID."}},"httpPath":"/products/{tenantId}/{id}"}]},{"type":"group","label":"Query Definitions","link":"/apis/fundraising/fundraising-v1/query-definitions","routeSlug":"/apis/fundraising/fundraising-v1/query-definitions","items":[{"label":"Returns a list of records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/query-definitions/getquerydefinitions","routeSlug":"/apis/fundraising/fundraising-v1/query-definitions/getquerydefinitions","metadata":{"seo":{"title":"Returns a list of records","description":"Returns a list of records"}},"httpPath":"/queryDefinitions/{tenantId}"}]},{"type":"group","label":"Recurring Gifts","link":"/apis/fundraising/fundraising-v1/recurring-gifts","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts","items":[{"label":"Gets all of the recurring gifts in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/recurring-gifts/listrecurringgifts","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts/listrecurringgifts","metadata":{"seo":{"title":"Gets all of the recurring gifts in the system.","description":"This method will scan all recurring gifts and and return them to the caller."}},"httpPath":"/recurringGifts/{tenantId}"},{"label":"Creates a new recurring gift record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/recurring-gifts/createrecurringgift","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts/createrecurringgift","metadata":{"seo":{"title":"Creates a new recurring gift record that does not already exist.","description":"This method will auto-generate an ID and create a new recurring gift. If an ID is specified for the recurring gift, an error will be thrown."}},"httpPath":"/recurringGifts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/recurring-gifts/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/recurringGifts/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/recurring-gifts/listrecurringgiftsbycontactid","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts/listrecurringgiftsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/recurringGifts/{tenantId}/contact/{contact_id}"},{"label":"Returns a list of records with the specified donor_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/recurring-gifts/listgiftsbydonorid","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts/listgiftsbydonorid","metadata":{"seo":{"title":"Returns a list of records with the specified donor_id","description":"Returns a list of records with the specified donor_id"}},"httpPath":"/recurringGifts/{tenantId}/donor/{donor_id}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/recurring-gifts/listrecurringgiftsbyorganizationid","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts/listrecurringgiftsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/recurringGifts/{tenantId}/organization/{organization_id}"},{"label":"Searches for recurring gifts using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/recurring-gifts/searchforrecurringgifts","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts/searchforrecurringgifts","metadata":{"seo":{"title":"Searches for recurring gifts using predefined parameters","description":"Searches for recurring gifts using predefined parameters"}},"httpPath":"/recurringGifts/{tenantId}/search"},{"label":"Returns a recurring gift from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/recurring-gifts/deleterecurringgift","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts/deleterecurringgift","metadata":{"seo":{"title":"Returns a recurring gift from the system by its ID.","description":"This method will delete a recurring gift with the specified ID."}},"httpPath":"/recurringGifts/{tenantId}/{id}"},{"label":"Returns a recurring gift from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/recurring-gifts/getrecurringgift","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts/getrecurringgift","metadata":{"seo":{"title":"Returns a recurring gift from the system by its ID.","description":"This method will look up a recurring gift by the specified ID and return it back."}},"httpPath":"/recurringGifts/{tenantId}/{id}"},{"label":"Partially updates a recurring gift with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/recurring-gifts/patchrecurringgift","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts/patchrecurringgift","metadata":{"seo":{"title":"Partially updates a recurring gift with the specified ID.","description":"This method will patch an existing recurring gift with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/recurringGifts/{tenantId}/{id}"},{"label":"Updates a recurring gift with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/recurring-gifts/updaterecurringgift","routeSlug":"/apis/fundraising/fundraising-v1/recurring-gifts/updaterecurringgift","metadata":{"seo":{"title":"Updates a recurring gift with the specified ID.","description":"This method will update an existing recurring gift with the specified ID."}},"httpPath":"/recurringGifts/{tenantId}/{id}"}]},{"type":"group","label":"Settings","link":"/apis/fundraising/fundraising-v1/settings","routeSlug":"/apis/fundraising/fundraising-v1/settings","items":[{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/settings/deletesetting","routeSlug":"/apis/fundraising/fundraising-v1/settings/deletesetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will delete a setting with the specified ID."}},"httpPath":"/settings/{tenantId}"},{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/settings/getsetting","routeSlug":"/apis/fundraising/fundraising-v1/settings/getsetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will look up a setting by the specified ID and return it back."}},"httpPath":"/settings/{tenantId}"},{"label":"Partially updates a setting with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/settings/patchsetting","routeSlug":"/apis/fundraising/fundraising-v1/settings/patchsetting","metadata":{"seo":{"title":"Partially updates a setting with the specified ID.","description":"This method will patch an existing setting with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/settings/{tenantId}"},{"label":"Creates a new setting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/settings/createsetting","routeSlug":"/apis/fundraising/fundraising-v1/settings/createsetting","metadata":{"seo":{"title":"Creates a new setting record that does not already exist.","description":"This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, an error will be thrown."}},"httpPath":"/settings/{tenantId}"},{"label":"Updates a setting with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/settings/updatesetting","routeSlug":"/apis/fundraising/fundraising-v1/settings/updatesetting","metadata":{"seo":{"title":"Updates a setting with the specified ID.","description":"This method will update an existing setting with the specified ID."}},"httpPath":"/settings/{tenantId}"}]},{"type":"group","label":"Statistics","link":"/apis/fundraising/fundraising-v1/statistics","routeSlug":"/apis/fundraising/fundraising-v1/statistics","items":[{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/statistics/executebatchoperations","routeSlug":"/apis/fundraising/fundraising-v1/statistics/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/statistics/{tenantId}/batch"},{"label":"Returns a statistic from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/fundraising/fundraising-v1/statistics/getstatistic","routeSlug":"/apis/fundraising/fundraising-v1/statistics/getstatistic","metadata":{"seo":{"title":"Returns a statistic from the system by its ID.","description":"This method will look up a statistic by the specified ID and return it back."}},"httpPath":"/statistics/{tenantId}/{id}"}]}]},{"type":"group","label":"Membership","items":[{"type":"link","label":"Membership","link":"/apis/membership/membership-v1","routeSlug":"/apis/membership/membership-v1"},{"type":"group","label":"Add On Products","link":"/apis/membership/membership-v1/add-on-products","routeSlug":"/apis/membership/membership-v1/add-on-products","items":[{"label":"Gets all of the add on products in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-products/listaddonproducts","routeSlug":"/apis/membership/membership-v1/add-on-products/listaddonproducts","metadata":{"seo":{"title":"Gets all of the add on products in the system.","description":"This method will scan all add on products and and return them to the caller."}},"httpPath":"/addOnProducts/{tenantId}"},{"label":"Creates a new add on product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-products/createaddonproduct","routeSlug":"/apis/membership/membership-v1/add-on-products/createaddonproduct","metadata":{"seo":{"title":"Creates a new add on product record that does not already exist.","description":"This method will auto-generate an ID and create a new add on product. If an ID is specified for the add on product, an error will be thrown."}},"httpPath":"/addOnProducts/{tenantId}"},{"label":"Returns a list of records with the specified add_on_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-products/listproductsbyaddonid","routeSlug":"/apis/membership/membership-v1/add-on-products/listproductsbyaddonid","metadata":{"seo":{"title":"Returns a list of records with the specified add_on_id","description":"Returns a list of records with the specified add_on_id"}},"httpPath":"/addOnProducts/{tenantId}/addOn/{add_on_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-products/executebatchoperations","routeSlug":"/apis/membership/membership-v1/add-on-products/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/addOnProducts/{tenantId}/batch"},{"label":"Returns a add on product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-products/deleteaddonproduct","routeSlug":"/apis/membership/membership-v1/add-on-products/deleteaddonproduct","metadata":{"seo":{"title":"Returns a add on product from the system by its ID.","description":"This method will delete a add on product with the specified ID."}},"httpPath":"/addOnProducts/{tenantId}/{id}"},{"label":"Returns a add on product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-products/getaddonproduct","routeSlug":"/apis/membership/membership-v1/add-on-products/getaddonproduct","metadata":{"seo":{"title":"Returns a add on product from the system by its ID.","description":"This method will look up a add on product by the specified ID and return it back."}},"httpPath":"/addOnProducts/{tenantId}/{id}"},{"label":"Partially updates a add on product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-products/patchaddonproduct","routeSlug":"/apis/membership/membership-v1/add-on-products/patchaddonproduct","metadata":{"seo":{"title":"Partially updates a add on product with the specified ID.","description":"This method will patch an existing add on product with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/addOnProducts/{tenantId}/{id}"},{"label":"Updates a add on product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-products/updateaddonproduct","routeSlug":"/apis/membership/membership-v1/add-on-products/updateaddonproduct","metadata":{"seo":{"title":"Updates a add on product with the specified ID.","description":"This method will update an existing add on product with the specified ID."}},"httpPath":"/addOnProducts/{tenantId}/{id}"}]},{"type":"group","label":"Add On Types","link":"/apis/membership/membership-v1/add-on-types","routeSlug":"/apis/membership/membership-v1/add-on-types","items":[{"label":"Gets all of the add on types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-types/listaddontypes","routeSlug":"/apis/membership/membership-v1/add-on-types/listaddontypes","metadata":{"seo":{"title":"Gets all of the add on types in the system.","description":"This method will scan all add on types and and return them to the caller."}},"httpPath":"/addOnTypes/{tenantId}"},{"label":"Creates a new add on type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-types/createaddontype","routeSlug":"/apis/membership/membership-v1/add-on-types/createaddontype","metadata":{"seo":{"title":"Creates a new add on type record that does not already exist.","description":"This method will auto-generate an ID and create a new add on type. If an ID is specified for the add on type, an error will be thrown."}},"httpPath":"/addOnTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-types/executebatchoperations","routeSlug":"/apis/membership/membership-v1/add-on-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/addOnTypes/{tenantId}/batch"},{"label":"Returns a add on type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-types/deleteaddontype","routeSlug":"/apis/membership/membership-v1/add-on-types/deleteaddontype","metadata":{"seo":{"title":"Returns a add on type from the system by its ID.","description":"This method will delete a add on type with the specified ID."}},"httpPath":"/addOnTypes/{tenantId}/{id}"},{"label":"Returns a add on type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-types/getaddontype","routeSlug":"/apis/membership/membership-v1/add-on-types/getaddontype","metadata":{"seo":{"title":"Returns a add on type from the system by its ID.","description":"This method will look up a add on type by the specified ID and return it back."}},"httpPath":"/addOnTypes/{tenantId}/{id}"},{"label":"Partially updates a add on type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-types/patchaddontype","routeSlug":"/apis/membership/membership-v1/add-on-types/patchaddontype","metadata":{"seo":{"title":"Partially updates a add on type with the specified ID.","description":"This method will patch an existing add on type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/addOnTypes/{tenantId}/{id}"},{"label":"Updates a add on type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-on-types/updateaddontype","routeSlug":"/apis/membership/membership-v1/add-on-types/updateaddontype","metadata":{"seo":{"title":"Updates a add on type with the specified ID.","description":"This method will update an existing add on type with the specified ID."}},"httpPath":"/addOnTypes/{tenantId}/{id}"}]},{"type":"group","label":"Add Ons","link":"/apis/membership/membership-v1/add-ons","routeSlug":"/apis/membership/membership-v1/add-ons","items":[{"label":"Gets all of the add ons in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-ons/listaddons","routeSlug":"/apis/membership/membership-v1/add-ons/listaddons","metadata":{"seo":{"title":"Gets all of the add ons in the system.","description":"This method will scan all add ons and and return them to the caller."}},"httpPath":"/addOns/{tenantId}"},{"label":"Creates a new add on record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-ons/createaddon","routeSlug":"/apis/membership/membership-v1/add-ons/createaddon","metadata":{"seo":{"title":"Creates a new add on record that does not already exist.","description":"This method will auto-generate an ID and create a new add on. If an ID is specified for the add on, an error will be thrown."}},"httpPath":"/addOns/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-ons/executebatchoperations","routeSlug":"/apis/membership/membership-v1/add-ons/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/addOns/{tenantId}/batch"},{"label":"List all applicable add ons for a contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-ons/listapplicableaddons","routeSlug":"/apis/membership/membership-v1/add-ons/listapplicableaddons","metadata":{"seo":{"title":"List all applicable add ons for a contact","description":"List all applicable add ons for a contact"}},"httpPath":"/addOns/{tenantId}/portal/getApplicable/{customerType}/{contactOrOrganizationId}"},{"label":"Returns a add on from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-ons/deleteaddon","routeSlug":"/apis/membership/membership-v1/add-ons/deleteaddon","metadata":{"seo":{"title":"Returns a add on from the system by its ID.","description":"This method will delete a add on with the specified ID."}},"httpPath":"/addOns/{tenantId}/{id}"},{"label":"Returns a add on from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-ons/getaddon","routeSlug":"/apis/membership/membership-v1/add-ons/getaddon","metadata":{"seo":{"title":"Returns a add on from the system by its ID.","description":"This method will look up a add on by the specified ID and return it back."}},"httpPath":"/addOns/{tenantId}/{id}"},{"label":"Partially updates a add on with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-ons/patchaddon","routeSlug":"/apis/membership/membership-v1/add-ons/patchaddon","metadata":{"seo":{"title":"Partially updates a add on with the specified ID.","description":"This method will patch an existing add on with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/addOns/{tenantId}/{id}"},{"label":"Updates a add on with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/add-ons/updateaddon","routeSlug":"/apis/membership/membership-v1/add-ons/updateaddon","metadata":{"seo":{"title":"Updates a add on with the specified ID.","description":"This method will update an existing add on with the specified ID."}},"httpPath":"/addOns/{tenantId}/{id}"}]},{"type":"group","label":"App Reference Types","link":"/apis/membership/membership-v1/app-reference-types","routeSlug":"/apis/membership/membership-v1/app-reference-types","items":[{"label":"Gets all of the app reference types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/app-reference-types/listappreferencetypes","routeSlug":"/apis/membership/membership-v1/app-reference-types/listappreferencetypes","metadata":{"seo":{"title":"Gets all of the app reference types in the system.","description":"This method will scan all app reference types and and return them to the caller."}},"httpPath":"/appReferenceTypes/{tenantId}"},{"label":"Creates a new app reference type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/app-reference-types/createappreferencetype","routeSlug":"/apis/membership/membership-v1/app-reference-types/createappreferencetype","metadata":{"seo":{"title":"Creates a new app reference type record that does not already exist.","description":"This method will auto-generate an ID and create a new app reference type. If an ID is specified for the app reference type, an error will be thrown."}},"httpPath":"/appReferenceTypes/{tenantId}"},{"label":"Returns a app reference type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/app-reference-types/deleteappreferencetype","routeSlug":"/apis/membership/membership-v1/app-reference-types/deleteappreferencetype","metadata":{"seo":{"title":"Returns a app reference type from the system by its ID.","description":"This method will delete a app reference type with the specified ID."}},"httpPath":"/appReferenceTypes/{tenantId}/{id}"},{"label":"Returns a app reference type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/app-reference-types/getappreferencetype","routeSlug":"/apis/membership/membership-v1/app-reference-types/getappreferencetype","metadata":{"seo":{"title":"Returns a app reference type from the system by its ID.","description":"This method will look up a app reference type by the specified ID and return it back."}},"httpPath":"/appReferenceTypes/{tenantId}/{id}"},{"label":"Partially updates a app reference type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/app-reference-types/patchappreferencetype","routeSlug":"/apis/membership/membership-v1/app-reference-types/patchappreferencetype","metadata":{"seo":{"title":"Partially updates a app reference type with the specified ID.","description":"This method will patch an existing app reference type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/appReferenceTypes/{tenantId}/{id}"},{"label":"Updates a app reference type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/app-reference-types/updateappreferencetype","routeSlug":"/apis/membership/membership-v1/app-reference-types/updateappreferencetype","metadata":{"seo":{"title":"Updates a app reference type with the specified ID.","description":"This method will update an existing app reference type with the specified ID."}},"httpPath":"/appReferenceTypes/{tenantId}/{id}"}]},{"type":"group","label":"Application Groups","link":"/apis/membership/membership-v1/application-groups","routeSlug":"/apis/membership/membership-v1/application-groups","items":[{"label":"Creates a new application group record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-groups/createapplicationgroup","routeSlug":"/apis/membership/membership-v1/application-groups/createapplicationgroup","metadata":{"seo":{"title":"Creates a new application group record that does not already exist.","description":"This method will auto-generate an ID and create a new application group. If an ID is specified for the application group, an error will be thrown."}},"httpPath":"/applicationGroups/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-groups/executebatchoperations","routeSlug":"/apis/membership/membership-v1/application-groups/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/applicationGroups/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-groups/listgroupsbycontactid","routeSlug":"/apis/membership/membership-v1/application-groups/listgroupsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/applicationGroups/{tenantId}/contact/{contact_id}"},{"label":"Searches for application groups using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-groups/searchforapplicationgroups","routeSlug":"/apis/membership/membership-v1/application-groups/searchforapplicationgroups","metadata":{"seo":{"title":"Searches for application groups using predefined parameters","description":"Searches for application groups using predefined parameters"}},"httpPath":"/applicationGroups/{tenantId}/search"},{"label":"Returns a application group from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-groups/deleteapplicationgroup","routeSlug":"/apis/membership/membership-v1/application-groups/deleteapplicationgroup","metadata":{"seo":{"title":"Returns a application group from the system by its ID.","description":"This method will delete a application group with the specified ID."}},"httpPath":"/applicationGroups/{tenantId}/{id}"},{"label":"Returns a application group from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-groups/getapplicationgroup","routeSlug":"/apis/membership/membership-v1/application-groups/getapplicationgroup","metadata":{"seo":{"title":"Returns a application group from the system by its ID.","description":"This method will look up a application group by the specified ID and return it back."}},"httpPath":"/applicationGroups/{tenantId}/{id}"},{"label":"Partially updates a application group with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-groups/patchapplicationgroup","routeSlug":"/apis/membership/membership-v1/application-groups/patchapplicationgroup","metadata":{"seo":{"title":"Partially updates a application group with the specified ID.","description":"This method will patch an existing application group with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/applicationGroups/{tenantId}/{id}"},{"label":"Updates a application group with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-groups/updateapplicationgroup","routeSlug":"/apis/membership/membership-v1/application-groups/updateapplicationgroup","metadata":{"seo":{"title":"Updates a application group with the specified ID.","description":"This method will update an existing application group with the specified ID."}},"httpPath":"/applicationGroups/{tenantId}/{id}"}]},{"type":"group","label":"Application Processes","link":"/apis/membership/membership-v1/application-processes","routeSlug":"/apis/membership/membership-v1/application-processes","items":[{"label":"Gets all of the application processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-processes/listapplicationprocesses","routeSlug":"/apis/membership/membership-v1/application-processes/listapplicationprocesses","metadata":{"seo":{"title":"Gets all of the application processes in the system.","description":"This method will scan all application processes and and return them to the caller."}},"httpPath":"/applicationProcesses/{tenantId}"},{"label":"Creates a new application process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-processes/createapplicationprocess","routeSlug":"/apis/membership/membership-v1/application-processes/createapplicationprocess","metadata":{"seo":{"title":"Creates a new application process record that does not already exist.","description":"This method will auto-generate an ID and create a new application process. If an ID is specified for the application process, an error will be thrown."}},"httpPath":"/applicationProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-processes/executebatchoperations","routeSlug":"/apis/membership/membership-v1/application-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/applicationProcesses/{tenantId}/batch"},{"label":"Gets all of the processes a contact/org is eligible to use","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-processes/geteligibleprocesses","routeSlug":"/apis/membership/membership-v1/application-processes/geteligibleprocesses","metadata":{"seo":{"title":"Gets all of the processes a contact/org is eligible to use","description":"Gets all of the processes a contact/org is eligible to use"}},"httpPath":"/applicationProcesses/{tenantId}/eligible/{customerType}/{contactOrOrganizationId}"},{"label":"Returns a application process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-processes/deleteapplicationprocess","routeSlug":"/apis/membership/membership-v1/application-processes/deleteapplicationprocess","metadata":{"seo":{"title":"Returns a application process from the system by its ID.","description":"This method will delete a application process with the specified ID."}},"httpPath":"/applicationProcesses/{tenantId}/{id}"},{"label":"Returns a application process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-processes/getapplicationprocess","routeSlug":"/apis/membership/membership-v1/application-processes/getapplicationprocess","metadata":{"seo":{"title":"Returns a application process from the system by its ID.","description":"This method will look up a application process by the specified ID and return it back."}},"httpPath":"/applicationProcesses/{tenantId}/{id}"},{"label":"Partially updates a application process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-processes/patchapplicationprocess","routeSlug":"/apis/membership/membership-v1/application-processes/patchapplicationprocess","metadata":{"seo":{"title":"Partially updates a application process with the specified ID.","description":"This method will patch an existing application process with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/applicationProcesses/{tenantId}/{id}"},{"label":"Updates a application process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-processes/updateapplicationprocess","routeSlug":"/apis/membership/membership-v1/application-processes/updateapplicationprocess","metadata":{"seo":{"title":"Updates a application process with the specified ID.","description":"This method will update an existing application process with the specified ID."}},"httpPath":"/applicationProcesses/{tenantId}/{id}"}]},{"type":"group","label":"Application Status Reasons","link":"/apis/membership/membership-v1/application-status-reasons","routeSlug":"/apis/membership/membership-v1/application-status-reasons","items":[{"label":"Gets all of the application status reasons in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-status-reasons/listapplicationstatusreasons","routeSlug":"/apis/membership/membership-v1/application-status-reasons/listapplicationstatusreasons","metadata":{"seo":{"title":"Gets all of the application status reasons in the system.","description":"This method will scan all application status reasons and and return them to the caller."}},"httpPath":"/applicationStatusReasons/{tenantId}"},{"label":"Creates a new application status reason record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-status-reasons/createapplicationstatusreason","routeSlug":"/apis/membership/membership-v1/application-status-reasons/createapplicationstatusreason","metadata":{"seo":{"title":"Creates a new application status reason record that does not already exist.","description":"This method will auto-generate an ID and create a new application status reason. If an ID is specified for the application status reason, an error will be thrown."}},"httpPath":"/applicationStatusReasons/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-status-reasons/executebatchoperations","routeSlug":"/apis/membership/membership-v1/application-status-reasons/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/applicationStatusReasons/{tenantId}/batch"},{"label":"Returns a application status reason from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-status-reasons/deleteapplicationstatusreason","routeSlug":"/apis/membership/membership-v1/application-status-reasons/deleteapplicationstatusreason","metadata":{"seo":{"title":"Returns a application status reason from the system by its ID.","description":"This method will delete a application status reason with the specified ID."}},"httpPath":"/applicationStatusReasons/{tenantId}/{id}"},{"label":"Returns a application status reason from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-status-reasons/getapplicationstatusreason","routeSlug":"/apis/membership/membership-v1/application-status-reasons/getapplicationstatusreason","metadata":{"seo":{"title":"Returns a application status reason from the system by its ID.","description":"This method will look up a application status reason by the specified ID and return it back."}},"httpPath":"/applicationStatusReasons/{tenantId}/{id}"},{"label":"Partially updates a application status reason with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-status-reasons/patchapplicationstatusreason","routeSlug":"/apis/membership/membership-v1/application-status-reasons/patchapplicationstatusreason","metadata":{"seo":{"title":"Partially updates a application status reason with the specified ID.","description":"This method will patch an existing application status reason with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/applicationStatusReasons/{tenantId}/{id}"},{"label":"Updates a application status reason with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/application-status-reasons/updateapplicationstatusreason","routeSlug":"/apis/membership/membership-v1/application-status-reasons/updateapplicationstatusreason","metadata":{"seo":{"title":"Updates a application status reason with the specified ID.","description":"This method will update an existing application status reason with the specified ID."}},"httpPath":"/applicationStatusReasons/{tenantId}/{id}"}]},{"type":"group","label":"Applications","link":"/apis/membership/membership-v1/applications","routeSlug":"/apis/membership/membership-v1/applications","items":[{"label":"Creates a new application record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/applications/createapplication","routeSlug":"/apis/membership/membership-v1/applications/createapplication","metadata":{"seo":{"title":"Creates a new application record that does not already exist.","description":"This method will auto-generate an ID and create a new application. If an ID is specified for the application, an error will be thrown."}},"httpPath":"/applications/{tenantId}"},{"label":"Returns a list of records with the specified application_group_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/applications/listapplicationsbyapplicationgroupid","routeSlug":"/apis/membership/membership-v1/applications/listapplicationsbyapplicationgroupid","metadata":{"seo":{"title":"Returns a list of records with the specified application_group_id","description":"Returns a list of records with the specified application_group_id"}},"httpPath":"/applications/{tenantId}/applicationGroup/{application_group_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/applications/executebatchoperations","routeSlug":"/apis/membership/membership-v1/applications/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/applications/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/applications/listapplicationsbycontactid","routeSlug":"/apis/membership/membership-v1/applications/listapplicationsbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/applications/{tenantId}/contact/{contact_id}"},{"label":"Generates an application for a contact or organization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/applications/generateapplications","routeSlug":"/apis/membership/membership-v1/applications/generateapplications","metadata":{"seo":{"title":"Generates an application for a contact or organization","description":"Generates an application for a contact or organization"}},"httpPath":"/applications/{tenantId}/generateApplication/{processId}/{ownerType}/{id}"},{"label":"Generates an group order from a membership application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/applications/generategrouporder","routeSlug":"/apis/membership/membership-v1/applications/generategrouporder","metadata":{"seo":{"title":"Generates an group order from a membership application","description":"This method will examine a membership application and generate an appropriate order"}},"httpPath":"/applications/{tenantId}/generateGroupOrder/{groupId}"},{"label":"Generates an order from a membership application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/applications/generateorder","routeSlug":"/apis/membership/membership-v1/applications/generateorder","metadata":{"seo":{"title":"Generates an order from a membership application","description":"This method will examine a membership application and generate an appropriate order"}},"httpPath":"/applications/{tenantId}/generateOrder"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/applications/listapplicationsbyorganizationid","routeSlug":"/apis/membership/membership-v1/applications/listapplicationsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/applications/{tenantId}/organization/{organization_id}"},{"label":"Searches for applications using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/applications/searchforapplications","routeSlug":"/apis/membership/membership-v1/applications/searchforapplications","metadata":{"seo":{"title":"Searches for applications using predefined parameters","description":"Searches for applications using predefined parameters"}},"httpPath":"/applications/{tenantId}/search"},{"label":"Returns a application from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/applications/deleteapplication","routeSlug":"/apis/membership/membership-v1/applications/deleteapplication","metadata":{"seo":{"title":"Returns a application from the system by its ID.","description":"This method will delete a application with the specified ID."}},"httpPath":"/applications/{tenantId}/{id}"},{"label":"Returns a application from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/applications/getapplication","routeSlug":"/apis/membership/membership-v1/applications/getapplication","metadata":{"seo":{"title":"Returns a application from the system by its ID.","description":"This method will look up a application by the specified ID and return it back."}},"httpPath":"/applications/{tenantId}/{id}"},{"label":"Partially updates a application with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/applications/patchapplication","routeSlug":"/apis/membership/membership-v1/applications/patchapplication","metadata":{"seo":{"title":"Partially updates a application with the specified ID.","description":"This method will patch an existing application with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/applications/{tenantId}/{id}"},{"label":"Updates a application with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/applications/updateapplication","routeSlug":"/apis/membership/membership-v1/applications/updateapplication","metadata":{"seo":{"title":"Updates a application with the specified ID.","description":"This method will update an existing application with the specified ID."}},"httpPath":"/applications/{tenantId}/{id}"}]},{"type":"group","label":"Ballots","link":"/apis/membership/membership-v1/ballots","routeSlug":"/apis/membership/membership-v1/ballots","items":[{"label":"Creates a new ballot record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/ballots/createballot","routeSlug":"/apis/membership/membership-v1/ballots/createballot","metadata":{"seo":{"title":"Creates a new ballot record that does not already exist.","description":"This method will auto-generate an ID and create a new ballot. If an ID is specified for the ballot, an error will be thrown."}},"httpPath":"/ballots/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/ballots/executebatchoperations","routeSlug":"/apis/membership/membership-v1/ballots/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/ballots/{tenantId}/batch"},{"label":"Returns a ballot from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/ballots/deleteballot","routeSlug":"/apis/membership/membership-v1/ballots/deleteballot","metadata":{"seo":{"title":"Returns a ballot from the system by its ID.","description":"This method will delete a ballot with the specified ID."}},"httpPath":"/ballots/{tenantId}/{id}"},{"label":"Returns a ballot from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/ballots/getballot","routeSlug":"/apis/membership/membership-v1/ballots/getballot","metadata":{"seo":{"title":"Returns a ballot from the system by its ID.","description":"This method will look up a ballot by the specified ID and return it back."}},"httpPath":"/ballots/{tenantId}/{id}"},{"label":"Partially updates a ballot with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/ballots/patchballot","routeSlug":"/apis/membership/membership-v1/ballots/patchballot","metadata":{"seo":{"title":"Partially updates a ballot with the specified ID.","description":"This method will patch an existing ballot with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/ballots/{tenantId}/{id}"},{"label":"Updates a ballot with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/ballots/updateballot","routeSlug":"/apis/membership/membership-v1/ballots/updateballot","metadata":{"seo":{"title":"Updates a ballot with the specified ID.","description":"This method will update an existing ballot with the specified ID."}},"httpPath":"/ballots/{tenantId}/{id}"}]},{"type":"group","label":"Billing Notices","link":"/apis/membership/membership-v1/billing-notices","routeSlug":"/apis/membership/membership-v1/billing-notices","items":[{"label":"Gets all of the billing notices in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-notices/listbillingnotices","routeSlug":"/apis/membership/membership-v1/billing-notices/listbillingnotices","metadata":{"seo":{"title":"Gets all of the billing notices in the system.","description":"This method will scan all billing notices and and return them to the caller."}},"httpPath":"/billingNotices/{tenantId}"},{"label":"Creates a new billing notice record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-notices/createbillingnotice","routeSlug":"/apis/membership/membership-v1/billing-notices/createbillingnotice","metadata":{"seo":{"title":"Creates a new billing notice record that does not already exist.","description":"This method will auto-generate an ID and create a new billing notice. If an ID is specified for the billing notice, an error will be thrown."}},"httpPath":"/billingNotices/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-notices/executebatchoperations","routeSlug":"/apis/membership/membership-v1/billing-notices/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/billingNotices/{tenantId}/batch"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-notices/previewemail","routeSlug":"/apis/membership/membership-v1/billing-notices/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/billingNotices/{tenantId}/previewEmail"},{"label":"Returns a billing notice from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-notices/deletebillingnotice","routeSlug":"/apis/membership/membership-v1/billing-notices/deletebillingnotice","metadata":{"seo":{"title":"Returns a billing notice from the system by its ID.","description":"This method will delete a billing notice with the specified ID."}},"httpPath":"/billingNotices/{tenantId}/{id}"},{"label":"Returns a billing notice from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-notices/getbillingnotice","routeSlug":"/apis/membership/membership-v1/billing-notices/getbillingnotice","metadata":{"seo":{"title":"Returns a billing notice from the system by its ID.","description":"This method will look up a billing notice by the specified ID and return it back."}},"httpPath":"/billingNotices/{tenantId}/{id}"},{"label":"Partially updates a billing notice with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-notices/patchbillingnotice","routeSlug":"/apis/membership/membership-v1/billing-notices/patchbillingnotice","metadata":{"seo":{"title":"Partially updates a billing notice with the specified ID.","description":"This method will patch an existing billing notice with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/billingNotices/{tenantId}/{id}"},{"label":"Updates a billing notice with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-notices/updatebillingnotice","routeSlug":"/apis/membership/membership-v1/billing-notices/updatebillingnotice","metadata":{"seo":{"title":"Updates a billing notice with the specified ID.","description":"This method will update an existing billing notice with the specified ID."}},"httpPath":"/billingNotices/{tenantId}/{id}"}]},{"type":"group","label":"Billing Run Actions","link":"/apis/membership/membership-v1/billing-run-actions","routeSlug":"/apis/membership/membership-v1/billing-run-actions","items":[{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-run-actions/executebatchoperations","routeSlug":"/apis/membership/membership-v1/billing-run-actions/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/billingRunActions/{tenantId}/batch"},{"label":"Returns a list of records with the specified billing_run_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-run-actions/listactionsbybillingrunid","routeSlug":"/apis/membership/membership-v1/billing-run-actions/listactionsbybillingrunid","metadata":{"seo":{"title":"Returns a list of records with the specified billing_run_id","description":"Returns a list of records with the specified billing_run_id"}},"httpPath":"/billingRunActions/{tenantId}/billingRun/{billing_run_id}"},{"label":"Returns a list of records with the specified membership_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-run-actions/listactionsbymembershipid","routeSlug":"/apis/membership/membership-v1/billing-run-actions/listactionsbymembershipid","metadata":{"seo":{"title":"Returns a list of records with the specified membership_id","description":"Returns a list of records with the specified membership_id"}},"httpPath":"/billingRunActions/{tenantId}/membership/{membership_id}"},{"label":"Returns a billing run action from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-run-actions/getbillingrunaction","routeSlug":"/apis/membership/membership-v1/billing-run-actions/getbillingrunaction","metadata":{"seo":{"title":"Returns a billing run action from the system by its ID.","description":"This method will look up a billing run action by the specified ID and return it back."}},"httpPath":"/billingRunActions/{tenantId}/{id}"},{"label":"Partially updates a billing run action with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-run-actions/patchbillingrunaction","routeSlug":"/apis/membership/membership-v1/billing-run-actions/patchbillingrunaction","metadata":{"seo":{"title":"Partially updates a billing run action with the specified ID.","description":"This method will patch an existing billing run action with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/billingRunActions/{tenantId}/{id}"},{"label":"Updates a billing run action with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-run-actions/updatebillingrunaction","routeSlug":"/apis/membership/membership-v1/billing-run-actions/updatebillingrunaction","metadata":{"seo":{"title":"Updates a billing run action with the specified ID.","description":"This method will update an existing billing run action with the specified ID."}},"httpPath":"/billingRunActions/{tenantId}/{id}"}]},{"type":"group","label":"Billing Runs","link":"/apis/membership/membership-v1/billing-runs","routeSlug":"/apis/membership/membership-v1/billing-runs","items":[{"label":"Creates a new billing run record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-runs/createbillingrun","routeSlug":"/apis/membership/membership-v1/billing-runs/createbillingrun","metadata":{"seo":{"title":"Creates a new billing run record that does not already exist.","description":"This method will auto-generate an ID and create a new billing run. If an ID is specified for the billing run, an error will be thrown."}},"httpPath":"/billingRuns/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-runs/executebatchoperations","routeSlug":"/apis/membership/membership-v1/billing-runs/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/billingRuns/{tenantId}/batch"},{"label":"Generates a billing run from a template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-runs/generatebillingrunfromtemplate","routeSlug":"/apis/membership/membership-v1/billing-runs/generatebillingrunfromtemplate","metadata":{"seo":{"title":"Generates a billing run from a template","description":"Generates a billing run from a template"}},"httpPath":"/billingRuns/{tenantId}/fromTemplate/{templateId}/{referenceDate}"},{"label":"Returns a list of records with the specified recurring_billing_run_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-runs/listrunsbyrecurringbillingrunid","routeSlug":"/apis/membership/membership-v1/billing-runs/listrunsbyrecurringbillingrunid","metadata":{"seo":{"title":"Returns a list of records with the specified recurring_billing_run_id","description":"Returns a list of records with the specified recurring_billing_run_id"}},"httpPath":"/billingRuns/{tenantId}/recurringBillingRun/{recurring_billing_run_id}"},{"label":"Refreshes a billing run","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-runs/refreshbillingrun","routeSlug":"/apis/membership/membership-v1/billing-runs/refreshbillingrun","metadata":{"seo":{"title":"Refreshes a billing run","description":"Refreshes a billing run"}},"httpPath":"/billingRuns/{tenantId}/refresh/{id}"},{"label":"Searches for billing runs using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-runs/searchforbillingruns","routeSlug":"/apis/membership/membership-v1/billing-runs/searchforbillingruns","metadata":{"seo":{"title":"Searches for billing runs using predefined parameters","description":"Searches for billing runs using predefined parameters"}},"httpPath":"/billingRuns/{tenantId}/search"},{"label":"Returns a billing run from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-runs/deletebillingrun","routeSlug":"/apis/membership/membership-v1/billing-runs/deletebillingrun","metadata":{"seo":{"title":"Returns a billing run from the system by its ID.","description":"This method will delete a billing run with the specified ID."}},"httpPath":"/billingRuns/{tenantId}/{id}"},{"label":"Returns a billing run from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-runs/getbillingrun","routeSlug":"/apis/membership/membership-v1/billing-runs/getbillingrun","metadata":{"seo":{"title":"Returns a billing run from the system by its ID.","description":"This method will look up a billing run by the specified ID and return it back."}},"httpPath":"/billingRuns/{tenantId}/{id}"},{"label":"Partially updates a billing run with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-runs/patchbillingrun","routeSlug":"/apis/membership/membership-v1/billing-runs/patchbillingrun","metadata":{"seo":{"title":"Partially updates a billing run with the specified ID.","description":"This method will patch an existing billing run with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/billingRuns/{tenantId}/{id}"},{"label":"Updates a billing run with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-runs/updatebillingrun","routeSlug":"/apis/membership/membership-v1/billing-runs/updatebillingrun","metadata":{"seo":{"title":"Updates a billing run with the specified ID.","description":"This method will update an existing billing run with the specified ID."}},"httpPath":"/billingRuns/{tenantId}/{id}"}]},{"type":"group","label":"Billing Templates","link":"/apis/membership/membership-v1/billing-templates","routeSlug":"/apis/membership/membership-v1/billing-templates","items":[{"label":"Gets all of the billing templates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-templates/listbillingtemplates","routeSlug":"/apis/membership/membership-v1/billing-templates/listbillingtemplates","metadata":{"seo":{"title":"Gets all of the billing templates in the system.","description":"This method will scan all billing templates and and return them to the caller."}},"httpPath":"/billingTemplates/{tenantId}"},{"label":"Creates a new billing template record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-templates/createbillingtemplate","routeSlug":"/apis/membership/membership-v1/billing-templates/createbillingtemplate","metadata":{"seo":{"title":"Creates a new billing template record that does not already exist.","description":"This method will auto-generate an ID and create a new billing template. If an ID is specified for the billing template, an error will be thrown."}},"httpPath":"/billingTemplates/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-templates/executebatchoperations","routeSlug":"/apis/membership/membership-v1/billing-templates/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/billingTemplates/{tenantId}/batch"},{"label":"Returns a billing template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-templates/deletebillingtemplate","routeSlug":"/apis/membership/membership-v1/billing-templates/deletebillingtemplate","metadata":{"seo":{"title":"Returns a billing template from the system by its ID.","description":"This method will delete a billing template with the specified ID."}},"httpPath":"/billingTemplates/{tenantId}/{id}"},{"label":"Returns a billing template from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-templates/getbillingtemplate","routeSlug":"/apis/membership/membership-v1/billing-templates/getbillingtemplate","metadata":{"seo":{"title":"Returns a billing template from the system by its ID.","description":"This method will look up a billing template by the specified ID and return it back."}},"httpPath":"/billingTemplates/{tenantId}/{id}"},{"label":"Partially updates a billing template with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-templates/patchbillingtemplate","routeSlug":"/apis/membership/membership-v1/billing-templates/patchbillingtemplate","metadata":{"seo":{"title":"Partially updates a billing template with the specified ID.","description":"This method will patch an existing billing template with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/billingTemplates/{tenantId}/{id}"},{"label":"Updates a billing template with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/billing-templates/updatebillingtemplate","routeSlug":"/apis/membership/membership-v1/billing-templates/updatebillingtemplate","metadata":{"seo":{"title":"Updates a billing template with the specified ID.","description":"This method will update an existing billing template with the specified ID."}},"httpPath":"/billingTemplates/{tenantId}/{id}"}]},{"type":"group","label":"Change Fees","link":"/apis/membership/membership-v1/change-fees","routeSlug":"/apis/membership/membership-v1/change-fees","items":[{"label":"Gets all of the change fees in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/change-fees/listchangefees","routeSlug":"/apis/membership/membership-v1/change-fees/listchangefees","metadata":{"seo":{"title":"Gets all of the change fees in the system.","description":"This method will scan all change fees and and return them to the caller."}},"httpPath":"/changeFees/{tenantId}"},{"label":"Creates a new change fee record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/change-fees/createchangefee","routeSlug":"/apis/membership/membership-v1/change-fees/createchangefee","metadata":{"seo":{"title":"Creates a new change fee record that does not already exist.","description":"This method will auto-generate an ID and create a new change fee. If an ID is specified for the change fee, an error will be thrown."}},"httpPath":"/changeFees/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/change-fees/executebatchoperations","routeSlug":"/apis/membership/membership-v1/change-fees/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/changeFees/{tenantId}/batch"},{"label":"Returns a change fee from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/change-fees/deletechangefee","routeSlug":"/apis/membership/membership-v1/change-fees/deletechangefee","metadata":{"seo":{"title":"Returns a change fee from the system by its ID.","description":"This method will delete a change fee with the specified ID."}},"httpPath":"/changeFees/{tenantId}/{id}"},{"label":"Returns a change fee from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/change-fees/getchangefee","routeSlug":"/apis/membership/membership-v1/change-fees/getchangefee","metadata":{"seo":{"title":"Returns a change fee from the system by its ID.","description":"This method will look up a change fee by the specified ID and return it back."}},"httpPath":"/changeFees/{tenantId}/{id}"},{"label":"Partially updates a change fee with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/change-fees/patchchangefee","routeSlug":"/apis/membership/membership-v1/change-fees/patchchangefee","metadata":{"seo":{"title":"Partially updates a change fee with the specified ID.","description":"This method will patch an existing change fee with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/changeFees/{tenantId}/{id}"},{"label":"Updates a change fee with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/change-fees/updatechangefee","routeSlug":"/apis/membership/membership-v1/change-fees/updatechangefee","metadata":{"seo":{"title":"Updates a change fee with the specified ID.","description":"This method will update an existing change fee with the specified ID."}},"httpPath":"/changeFees/{tenantId}/{id}"}]},{"type":"group","label":"Chapter Dues Products","link":"/apis/membership/membership-v1/chapter-dues-products","routeSlug":"/apis/membership/membership-v1/chapter-dues-products","items":[{"label":"Gets all of the chapter dues products in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-dues-products/listchapterduesproducts","routeSlug":"/apis/membership/membership-v1/chapter-dues-products/listchapterduesproducts","metadata":{"seo":{"title":"Gets all of the chapter dues products in the system.","description":"This method will scan all chapter dues products and and return them to the caller."}},"httpPath":"/chapterDuesProducts/{tenantId}"},{"label":"Creates a new chapter dues product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-dues-products/createchapterduesproduct","routeSlug":"/apis/membership/membership-v1/chapter-dues-products/createchapterduesproduct","metadata":{"seo":{"title":"Creates a new chapter dues product record that does not already exist.","description":"This method will auto-generate an ID and create a new chapter dues product. If an ID is specified for the chapter dues product, an error will be thrown."}},"httpPath":"/chapterDuesProducts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-dues-products/executebatchoperations","routeSlug":"/apis/membership/membership-v1/chapter-dues-products/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/chapterDuesProducts/{tenantId}/batch"},{"label":"Returns a list of records with the specified chapter_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-dues-products/listproductsbychapterid","routeSlug":"/apis/membership/membership-v1/chapter-dues-products/listproductsbychapterid","metadata":{"seo":{"title":"Returns a list of records with the specified chapter_id","description":"Returns a list of records with the specified chapter_id"}},"httpPath":"/chapterDuesProducts/{tenantId}/chapter/{chapter_id}"},{"label":"Returns a chapter dues product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-dues-products/deletechapterduesproduct","routeSlug":"/apis/membership/membership-v1/chapter-dues-products/deletechapterduesproduct","metadata":{"seo":{"title":"Returns a chapter dues product from the system by its ID.","description":"This method will delete a chapter dues product with the specified ID."}},"httpPath":"/chapterDuesProducts/{tenantId}/{id}"},{"label":"Returns a chapter dues product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-dues-products/getchapterduesproduct","routeSlug":"/apis/membership/membership-v1/chapter-dues-products/getchapterduesproduct","metadata":{"seo":{"title":"Returns a chapter dues product from the system by its ID.","description":"This method will look up a chapter dues product by the specified ID and return it back."}},"httpPath":"/chapterDuesProducts/{tenantId}/{id}"},{"label":"Partially updates a chapter dues product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-dues-products/patchchapterduesproduct","routeSlug":"/apis/membership/membership-v1/chapter-dues-products/patchchapterduesproduct","metadata":{"seo":{"title":"Partially updates a chapter dues product with the specified ID.","description":"This method will patch an existing chapter dues product with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/chapterDuesProducts/{tenantId}/{id}"},{"label":"Updates a chapter dues product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-dues-products/updatechapterduesproduct","routeSlug":"/apis/membership/membership-v1/chapter-dues-products/updatechapterduesproduct","metadata":{"seo":{"title":"Updates a chapter dues product with the specified ID.","description":"This method will update an existing chapter dues product with the specified ID."}},"httpPath":"/chapterDuesProducts/{tenantId}/{id}"}]},{"type":"group","label":"Chapter Types","link":"/apis/membership/membership-v1/chapter-types","routeSlug":"/apis/membership/membership-v1/chapter-types","items":[{"label":"Gets all of the chapter types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-types/listchaptertypes","routeSlug":"/apis/membership/membership-v1/chapter-types/listchaptertypes","metadata":{"seo":{"title":"Gets all of the chapter types in the system.","description":"This method will scan all chapter types and and return them to the caller."}},"httpPath":"/chapterTypes/{tenantId}"},{"label":"Creates a new chapter type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-types/createchaptertype","routeSlug":"/apis/membership/membership-v1/chapter-types/createchaptertype","metadata":{"seo":{"title":"Creates a new chapter type record that does not already exist.","description":"This method will auto-generate an ID and create a new chapter type. If an ID is specified for the chapter type, an error will be thrown."}},"httpPath":"/chapterTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-types/executebatchoperations","routeSlug":"/apis/membership/membership-v1/chapter-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/chapterTypes/{tenantId}/batch"},{"label":"Returns a chapter type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-types/deletechaptertype","routeSlug":"/apis/membership/membership-v1/chapter-types/deletechaptertype","metadata":{"seo":{"title":"Returns a chapter type from the system by its ID.","description":"This method will delete a chapter type with the specified ID."}},"httpPath":"/chapterTypes/{tenantId}/{id}"},{"label":"Returns a chapter type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-types/getchaptertype","routeSlug":"/apis/membership/membership-v1/chapter-types/getchaptertype","metadata":{"seo":{"title":"Returns a chapter type from the system by its ID.","description":"This method will look up a chapter type by the specified ID and return it back."}},"httpPath":"/chapterTypes/{tenantId}/{id}"},{"label":"Partially updates a chapter type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-types/patchchaptertype","routeSlug":"/apis/membership/membership-v1/chapter-types/patchchaptertype","metadata":{"seo":{"title":"Partially updates a chapter type with the specified ID.","description":"This method will patch an existing chapter type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/chapterTypes/{tenantId}/{id}"},{"label":"Updates a chapter type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapter-types/updatechaptertype","routeSlug":"/apis/membership/membership-v1/chapter-types/updatechaptertype","metadata":{"seo":{"title":"Updates a chapter type with the specified ID.","description":"This method will update an existing chapter type with the specified ID."}},"httpPath":"/chapterTypes/{tenantId}/{id}"}]},{"type":"group","label":"Chapters","link":"/apis/membership/membership-v1/chapters","routeSlug":"/apis/membership/membership-v1/chapters","items":[{"label":"Gets all of the chapters in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/listchapters","routeSlug":"/apis/membership/membership-v1/chapters/listchapters","metadata":{"seo":{"title":"Gets all of the chapters in the system.","description":"This method will scan all chapters and and return them to the caller."}},"httpPath":"/chapters/{tenantId}"},{"label":"Creates a new chapter record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/createchapter","routeSlug":"/apis/membership/membership-v1/chapters/createchapter","metadata":{"seo":{"title":"Creates a new chapter record that does not already exist.","description":"This method will auto-generate an ID and create a new chapter. If an ID is specified for the chapter, an error will be thrown."}},"httpPath":"/chapters/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/executebatchoperations","routeSlug":"/apis/membership/membership-v1/chapters/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/chapters/{tenantId}/batch"},{"label":"Change chapter committee terms","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/patchchaptercommittee","routeSlug":"/apis/membership/membership-v1/chapters/patchchaptercommittee","metadata":{"seo":{"title":"Change chapter committee terms","description":"Allows for chapter administrators to change committee terms"}},"httpPath":"/chapters/{tenantId}/committee/{chapterId}/{committeeId}"},{"label":"Create a chapter committee membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/createchaptercommitteemembership","routeSlug":"/apis/membership/membership-v1/chapters/createchaptercommitteemembership","metadata":{"seo":{"title":"Create a chapter committee membership","description":"Add a membership to a chapter committee"}},"httpPath":"/chapters/{tenantId}/committeeMembership/{chapterId}"},{"label":"Delete a chapter committee membership","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/deletechaptercommitteemembership","routeSlug":"/apis/membership/membership-v1/chapters/deletechaptercommitteemembership","metadata":{"seo":{"title":"Delete a chapter committee membership","description":"Changes a chapter committee membership"}},"httpPath":"/chapters/{tenantId}/committeeMembership/{chapterId}/{id}"},{"label":"Update a chapter committee membership","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/updatechaptercommitteemembership","routeSlug":"/apis/membership/membership-v1/chapters/updatechaptercommitteemembership","metadata":{"seo":{"title":"Update a chapter committee membership","description":"Changes a chapter committee membership"}},"httpPath":"/chapters/{tenantId}/committeeMembership/{chapterId}/{id}"},{"label":"Creates a new contact on behalf of a chapter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/createchaptermembercontact","routeSlug":"/apis/membership/membership-v1/chapters/createchaptermembercontact","metadata":{"seo":{"title":"Creates a new contact on behalf of a chapter","description":"Allows for a portal user to update the contact info of a chapter member"}},"httpPath":"/chapters/{tenantId}/contact/{chapterId}"},{"label":"Get chapter member contact info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/getchaptermembercontact","routeSlug":"/apis/membership/membership-v1/chapters/getchaptermembercontact","metadata":{"seo":{"title":"Get chapter member contact info","description":"Allows for a portal user to get the contact info of a chapter member"}},"httpPath":"/chapters/{tenantId}/contact/{chapterId}/{contactId}"},{"label":"Update chapter member contact info","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/updatechaptermembercontact","routeSlug":"/apis/membership/membership-v1/chapters/updatechaptermembercontact","metadata":{"seo":{"title":"Update chapter member contact info","description":"Allows for a portal user to update the contact info of a chapter member"}},"httpPath":"/chapters/{tenantId}/contact/{chapterId}/{contactId}"},{"label":"Generates an application for a contact or organization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/generatechaptermembershipapplication","routeSlug":"/apis/membership/membership-v1/chapters/generatechaptermembershipapplication","metadata":{"seo":{"title":"Generates an application for a contact or organization","description":"Generates an application for a contact or organization"}},"httpPath":"/chapters/{tenantId}/generateApplication/{chapterId}/{processId}/{ownerType}/{id}"},{"label":"Generates an order from a membership application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/generatechaptermembershiporder","routeSlug":"/apis/membership/membership-v1/chapters/generatechaptermembershiporder","metadata":{"seo":{"title":"Generates an order from a membership application","description":"This method will examine a membership application and generate an appropriate order"}},"httpPath":"/chapters/{tenantId}/generateOrder/{chapterId}"},{"label":"Update chapter member membership info","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/updatechaptermembermembership","routeSlug":"/apis/membership/membership-v1/chapters/updatechaptermembermembership","metadata":{"seo":{"title":"Update chapter member membership info","description":"Allows for a portal user to update the membership info of a chapter member"}},"httpPath":"/chapters/{tenantId}/membership/{chapterId}/{membershipId}"},{"label":"Returns a list of chapters for a given membership package","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/describechaptersformembershippackage","routeSlug":"/apis/membership/membership-v1/chapters/describechaptersformembershippackage","metadata":{"seo":{"title":"Returns a list of chapters for a given membership package","description":"Returns a list of chapters for a given membership package"}},"httpPath":"/chapters/{tenantId}/portal/describeChapters/{membershipPackageId}"},{"label":"Returns a list of chapters for a given membership package","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/describechaptersformembershippackageandmember","routeSlug":"/apis/membership/membership-v1/chapters/describechaptersformembershippackageandmember","metadata":{"seo":{"title":"Returns a list of chapters for a given membership package","description":"Returns a list of chapters for a given membership package"}},"httpPath":"/chapters/{tenantId}/portal/describeChapters/{membershipPackageId}/{memberType}/{contactOrOrganizationId}"},{"label":"Searches for the nearest chapters to the latitude and longitude supplied","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/findnearestchapter","routeSlug":"/apis/membership/membership-v1/chapters/findnearestchapter","metadata":{"seo":{"title":"Searches for the nearest chapters to the latitude and longitude supplied","description":"Returns a list of chapters for a given membership package"}},"httpPath":"/chapters/{tenantId}/portal/findNearest/{latitude}/{longitude}"},{"label":"Get eligible application processes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/geteligibleappprocesses","routeSlug":"/apis/membership/membership-v1/chapters/geteligibleappprocesses","metadata":{"seo":{"title":"Get eligible application processes","description":"Get eligible application processes"}},"httpPath":"/chapters/{tenantId}/portal/getEligibleAppProcesses/{chapterId}/{contactId}"},{"label":"Get portal permissions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/getportalpermissions","routeSlug":"/apis/membership/membership-v1/chapters/getportalpermissions","metadata":{"seo":{"title":"Get portal permissions","description":"Determines the permissions available in the portal for a portal user."}},"httpPath":"/chapters/{tenantId}/portalPermissions/{chapterId}/{contactId}"},{"label":"Runs a saved query on behalf of a chapter","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/runchapterquery","routeSlug":"/apis/membership/membership-v1/chapters/runchapterquery","metadata":{"seo":{"title":"Runs a saved query on behalf of a chapter","description":"Runs a saved query on behalf of a chapter"}},"httpPath":"/chapters/{tenantId}/query/{chapterId}/{savedQueryId}/{outputFormat}"},{"label":"View chapter roster","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/viewchapterroster","routeSlug":"/apis/membership/membership-v1/chapters/viewchapterroster","metadata":{"seo":{"title":"View chapter roster","description":"Allows for a portal user to view the roster"}},"httpPath":"/chapters/{tenantId}/roster/{chapterId}"},{"label":"Searches for chapters using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/searchforchapters","routeSlug":"/apis/membership/membership-v1/chapters/searchforchapters","metadata":{"seo":{"title":"Searches for chapters using predefined parameters","description":"Searches for chapters using predefined parameters"}},"httpPath":"/chapters/{tenantId}/search"},{"label":"Returns a chapter from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/deletechapter","routeSlug":"/apis/membership/membership-v1/chapters/deletechapter","metadata":{"seo":{"title":"Returns a chapter from the system by its ID.","description":"This method will delete a chapter with the specified ID."}},"httpPath":"/chapters/{tenantId}/{id}"},{"label":"Returns a chapter from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/getchapter","routeSlug":"/apis/membership/membership-v1/chapters/getchapter","metadata":{"seo":{"title":"Returns a chapter from the system by its ID.","description":"This method will look up a chapter by the specified ID and return it back."}},"httpPath":"/chapters/{tenantId}/{id}"},{"label":"Partially updates a chapter with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/patchchapter","routeSlug":"/apis/membership/membership-v1/chapters/patchchapter","metadata":{"seo":{"title":"Partially updates a chapter with the specified ID.","description":"This method will patch an existing chapter with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/chapters/{tenantId}/{id}"},{"label":"Updates a chapter with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/chapters/updatechapter","routeSlug":"/apis/membership/membership-v1/chapters/updatechapter","metadata":{"seo":{"title":"Updates a chapter with the specified ID.","description":"This method will update an existing chapter with the specified ID."}},"httpPath":"/chapters/{tenantId}/{id}"}]},{"type":"group","label":"Coupons","link":"/apis/membership/membership-v1/coupons","routeSlug":"/apis/membership/membership-v1/coupons","items":[{"label":"Gets all of the coupons in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/coupons/listcoupons","routeSlug":"/apis/membership/membership-v1/coupons/listcoupons","metadata":{"seo":{"title":"Gets all of the coupons in the system.","description":"This method will scan all coupons and and return them to the caller."}},"httpPath":"/coupons/{tenantId}"},{"label":"Creates a new coupon record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/coupons/createcoupon","routeSlug":"/apis/membership/membership-v1/coupons/createcoupon","metadata":{"seo":{"title":"Creates a new coupon record that does not already exist.","description":"This method will auto-generate an ID and create a new coupon. If an ID is specified for the coupon, an error will be thrown."}},"httpPath":"/coupons/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/coupons/executebatchoperations","routeSlug":"/apis/membership/membership-v1/coupons/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/coupons/{tenantId}/batch"},{"label":"Returns a coupon from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/coupons/deletecoupon","routeSlug":"/apis/membership/membership-v1/coupons/deletecoupon","metadata":{"seo":{"title":"Returns a coupon from the system by its ID.","description":"This method will delete a coupon with the specified ID."}},"httpPath":"/coupons/{tenantId}/{id}"},{"label":"Returns a coupon from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/coupons/getcoupon","routeSlug":"/apis/membership/membership-v1/coupons/getcoupon","metadata":{"seo":{"title":"Returns a coupon from the system by its ID.","description":"This method will look up a coupon by the specified ID and return it back."}},"httpPath":"/coupons/{tenantId}/{id}"},{"label":"Partially updates a coupon with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/coupons/patchcoupon","routeSlug":"/apis/membership/membership-v1/coupons/patchcoupon","metadata":{"seo":{"title":"Partially updates a coupon with the specified ID.","description":"This method will patch an existing coupon with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/coupons/{tenantId}/{id}"},{"label":"Updates a coupon with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/coupons/updatecoupon","routeSlug":"/apis/membership/membership-v1/coupons/updatecoupon","metadata":{"seo":{"title":"Updates a coupon with the specified ID.","description":"This method will update an existing coupon with the specified ID."}},"httpPath":"/coupons/{tenantId}/{id}"}]},{"type":"group","label":"Directories","link":"/apis/membership/membership-v1/directories","routeSlug":"/apis/membership/membership-v1/directories","items":[{"label":"Gets all of the directories in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/directories/listdirectories","routeSlug":"/apis/membership/membership-v1/directories/listdirectories","metadata":{"seo":{"title":"Gets all of the directories in the system.","description":"This method will scan all directories and and return them to the caller."}},"httpPath":"/directories/{tenantId}"},{"label":"Creates a new directory record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/directories/createdirectory","routeSlug":"/apis/membership/membership-v1/directories/createdirectory","metadata":{"seo":{"title":"Creates a new directory record that does not already exist.","description":"This method will auto-generate an ID and create a new directory. If an ID is specified for the directory, an error will be thrown."}},"httpPath":"/directories/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/directories/executebatchoperations","routeSlug":"/apis/membership/membership-v1/directories/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/directories/{tenantId}/batch"},{"label":"Gets an entry in the directory","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/directories/getdirectoryentry","routeSlug":"/apis/membership/membership-v1/directories/getdirectoryentry","metadata":{"seo":{"title":"Gets an entry in the directory","description":"Gets an entry in the directory"}},"httpPath":"/directories/{tenantId}/public/entry/{id}/{entryId}"},{"label":"Searches the directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/directories/searchpublicdirectory","routeSlug":"/apis/membership/membership-v1/directories/searchpublicdirectory","metadata":{"seo":{"title":"Searches the directory","description":"Searches the directory"}},"httpPath":"/directories/{tenantId}/public/search/{id}"},{"label":"Sends a message to an entry in the directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/directories/senddirectorymessage","routeSlug":"/apis/membership/membership-v1/directories/senddirectorymessage","metadata":{"seo":{"title":"Sends a message to an entry in the directory","description":"Sends a message to an entry in the directory"}},"httpPath":"/directories/{tenantId}/public/sendMessage/{directoryId}/{entryId}"},{"label":"Returns a directory from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/directories/getpublicdirectory","routeSlug":"/apis/membership/membership-v1/directories/getpublicdirectory","metadata":{"seo":{"title":"Returns a directory from the system by its ID.","description":"This method will look up a directory by the specified ID and return it back."}},"httpPath":"/directories/{tenantId}/public/{id}"},{"label":"Searches the directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/directories/searchdirectory","routeSlug":"/apis/membership/membership-v1/directories/searchdirectory","metadata":{"seo":{"title":"Searches the directory","description":"Searches the directory"}},"httpPath":"/directories/{tenantId}/search/{id}"},{"label":"Returns a directory from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/directories/deletedirectory","routeSlug":"/apis/membership/membership-v1/directories/deletedirectory","metadata":{"seo":{"title":"Returns a directory from the system by its ID.","description":"This method will delete a directory with the specified ID."}},"httpPath":"/directories/{tenantId}/{id}"},{"label":"Returns a directory from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/directories/getdirectory","routeSlug":"/apis/membership/membership-v1/directories/getdirectory","metadata":{"seo":{"title":"Returns a directory from the system by its ID.","description":"This method will look up a directory by the specified ID and return it back."}},"httpPath":"/directories/{tenantId}/{id}"},{"label":"Partially updates a directory with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/directories/patchdirectory","routeSlug":"/apis/membership/membership-v1/directories/patchdirectory","metadata":{"seo":{"title":"Partially updates a directory with the specified ID.","description":"This method will patch an existing directory with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/directories/{tenantId}/{id}"},{"label":"Updates a directory with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/directories/updatedirectory","routeSlug":"/apis/membership/membership-v1/directories/updatedirectory","metadata":{"seo":{"title":"Updates a directory with the specified ID.","description":"This method will update an existing directory with the specified ID."}},"httpPath":"/directories/{tenantId}/{id}"}]},{"type":"group","label":"Elections","link":"/apis/membership/membership-v1/elections","routeSlug":"/apis/membership/membership-v1/elections","items":[{"label":"Creates a new election record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/elections/createelection","routeSlug":"/apis/membership/membership-v1/elections/createelection","metadata":{"seo":{"title":"Creates a new election record that does not already exist.","description":"This method will auto-generate an ID and create a new election. If an ID is specified for the election, an error will be thrown."}},"httpPath":"/elections/{tenantId}"},{"label":"Returns a list of records with the specified chapter_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/elections/listelectionsbychapterid","routeSlug":"/apis/membership/membership-v1/elections/listelectionsbychapterid","metadata":{"seo":{"title":"Returns a list of records with the specified chapter_id","description":"Returns a list of records with the specified chapter_id"}},"httpPath":"/elections/{tenantId}/chapter/{chapter_id}"},{"label":"Returns a list of records with the specified committee_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/elections/listelectionsbycommitteeid","routeSlug":"/apis/membership/membership-v1/elections/listelectionsbycommitteeid","metadata":{"seo":{"title":"Returns a list of records with the specified committee_id","description":"Returns a list of records with the specified committee_id"}},"httpPath":"/elections/{tenantId}/committee/{committee_id}"},{"label":"Returns a list of records with the specified section_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/elections/listelectionsbysectionid","routeSlug":"/apis/membership/membership-v1/elections/listelectionsbysectionid","metadata":{"seo":{"title":"Returns a list of records with the specified section_id","description":"Returns a list of records with the specified section_id"}},"httpPath":"/elections/{tenantId}/section/{section_id}"},{"label":"Returns a election from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/elections/deleteelection","routeSlug":"/apis/membership/membership-v1/elections/deleteelection","metadata":{"seo":{"title":"Returns a election from the system by its ID.","description":"This method will delete a election with the specified ID."}},"httpPath":"/elections/{tenantId}/{id}"},{"label":"Returns a election from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/elections/getelection","routeSlug":"/apis/membership/membership-v1/elections/getelection","metadata":{"seo":{"title":"Returns a election from the system by its ID.","description":"This method will look up a election by the specified ID and return it back."}},"httpPath":"/elections/{tenantId}/{id}"},{"label":"Partially updates a election with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/elections/patchelection","routeSlug":"/apis/membership/membership-v1/elections/patchelection","metadata":{"seo":{"title":"Partially updates a election with the specified ID.","description":"This method will patch an existing election with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/elections/{tenantId}/{id}"},{"label":"Updates a election with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/elections/updateelection","routeSlug":"/apis/membership/membership-v1/elections/updateelection","metadata":{"seo":{"title":"Updates a election with the specified ID.","description":"This method will update an existing election with the specified ID."}},"httpPath":"/elections/{tenantId}/{id}"}]},{"type":"group","label":"Group Application Processes","link":"/apis/membership/membership-v1/group-application-processes","routeSlug":"/apis/membership/membership-v1/group-application-processes","items":[{"label":"Gets all of the group application processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/group-application-processes/listgroupapplicationprocesses","routeSlug":"/apis/membership/membership-v1/group-application-processes/listgroupapplicationprocesses","metadata":{"seo":{"title":"Gets all of the group application processes in the system.","description":"This method will scan all group application processes and and return them to the caller."}},"httpPath":"/groupApplicationProcesses/{tenantId}"},{"label":"Creates a new group application process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/group-application-processes/creategroupapplicationprocess","routeSlug":"/apis/membership/membership-v1/group-application-processes/creategroupapplicationprocess","metadata":{"seo":{"title":"Creates a new group application process record that does not already exist.","description":"This method will auto-generate an ID and create a new group application process. If an ID is specified for the group application process, an error will be thrown."}},"httpPath":"/groupApplicationProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/group-application-processes/executebatchoperations","routeSlug":"/apis/membership/membership-v1/group-application-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/groupApplicationProcesses/{tenantId}/batch"},{"label":"Gets all of the processes a contact is eligible to use","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/group-application-processes/geteligibleprocesses","routeSlug":"/apis/membership/membership-v1/group-application-processes/geteligibleprocesses","metadata":{"seo":{"title":"Gets all of the processes a contact is eligible to use","description":"Gets all of the processes a contact is eligible to use"}},"httpPath":"/groupApplicationProcesses/{tenantId}/eligible/{contactId}"},{"label":"Returns a group application process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/group-application-processes/deletegroupapplicationprocess","routeSlug":"/apis/membership/membership-v1/group-application-processes/deletegroupapplicationprocess","metadata":{"seo":{"title":"Returns a group application process from the system by its ID.","description":"This method will delete a group application process with the specified ID."}},"httpPath":"/groupApplicationProcesses/{tenantId}/{id}"},{"label":"Returns a group application process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/group-application-processes/getgroupapplicationprocess","routeSlug":"/apis/membership/membership-v1/group-application-processes/getgroupapplicationprocess","metadata":{"seo":{"title":"Returns a group application process from the system by its ID.","description":"This method will look up a group application process by the specified ID and return it back."}},"httpPath":"/groupApplicationProcesses/{tenantId}/{id}"},{"label":"Partially updates a group application process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/group-application-processes/patchgroupapplicationprocess","routeSlug":"/apis/membership/membership-v1/group-application-processes/patchgroupapplicationprocess","metadata":{"seo":{"title":"Partially updates a group application process with the specified ID.","description":"This method will patch an existing group application process with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/groupApplicationProcesses/{tenantId}/{id}"},{"label":"Updates a group application process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/group-application-processes/updategroupapplicationprocess","routeSlug":"/apis/membership/membership-v1/group-application-processes/updategroupapplicationprocess","metadata":{"seo":{"title":"Updates a group application process with the specified ID.","description":"This method will update an existing group application process with the specified ID."}},"httpPath":"/groupApplicationProcesses/{tenantId}/{id}"}]},{"type":"group","label":"Id Card Templates","link":"/apis/membership/membership-v1/id-card-templates","routeSlug":"/apis/membership/membership-v1/id-card-templates","items":[{"label":"Gets all of the id card templates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/id-card-templates/listidcardtemplates","routeSlug":"/apis/membership/membership-v1/id-card-templates/listidcardtemplates","metadata":{"seo":{"title":"Gets all of the id card templates in the system.","description":"This method will scan all id card templates and and return them to the caller."}},"httpPath":"/idCardTemplates/{tenantId}"},{"label":"Creates a new id card template record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/id-card-templates/createidcardtemplate","routeSlug":"/apis/membership/membership-v1/id-card-templates/createidcardtemplate","metadata":{"seo":{"title":"Creates a new id card template record that does not already exist.","description":"This method will auto-generate an ID and create a new id card template. If an ID is specified for the id card template, an error will be thrown."}},"httpPath":"/idCardTemplates/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/id-card-templates/executebatchoperations","routeSlug":"/apis/membership/membership-v1/id-card-templates/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/idCardTemplates/{tenantId}/batch"},{"label":"Returns a id card template from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/id-card-templates/deleteidcardtemplate","routeSlug":"/apis/membership/membership-v1/id-card-templates/deleteidcardtemplate","metadata":{"seo":{"title":"Returns a id card template from the system by its ID.","description":"This method will delete a id card template with the specified ID."}},"httpPath":"/idCardTemplates/{tenantId}/{id}"},{"label":"Returns a id card template from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/id-card-templates/getidcardtemplate","routeSlug":"/apis/membership/membership-v1/id-card-templates/getidcardtemplate","metadata":{"seo":{"title":"Returns a id card template from the system by its ID.","description":"This method will look up a id card template by the specified ID and return it back."}},"httpPath":"/idCardTemplates/{tenantId}/{id}"},{"label":"Partially updates a id card template with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/id-card-templates/patchidcardtemplate","routeSlug":"/apis/membership/membership-v1/id-card-templates/patchidcardtemplate","metadata":{"seo":{"title":"Partially updates a id card template with the specified ID.","description":"This method will patch an existing id card template with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/idCardTemplates/{tenantId}/{id}"},{"label":"Updates a id card template with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/id-card-templates/updateidcardtemplate","routeSlug":"/apis/membership/membership-v1/id-card-templates/updateidcardtemplate","metadata":{"seo":{"title":"Updates a id card template with the specified ID.","description":"This method will update an existing id card template with the specified ID."}},"httpPath":"/idCardTemplates/{tenantId}/{id}"}]},{"type":"group","label":"Memberships","link":"/apis/membership/membership-v1/memberships","routeSlug":"/apis/membership/membership-v1/memberships","items":[{"label":"Creates a new membership record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/createmembership","routeSlug":"/apis/membership/membership-v1/memberships/createmembership","metadata":{"seo":{"title":"Creates a new membership record that does not already exist.","description":"This method will auto-generate an ID and create a new membership. If an ID is specified for the membership, an error will be thrown."}},"httpPath":"/memberships/{tenantId}"},{"label":"Activate membership","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/activatemembership","routeSlug":"/apis/membership/membership-v1/memberships/activatemembership","metadata":{"seo":{"title":"Activate membership","description":"Activate membership"}},"httpPath":"/memberships/{tenantId}/activate/{application_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/executebatchoperations","routeSlug":"/apis/membership/membership-v1/memberships/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/memberships/{tenantId}/batch"},{"label":"Downloads a Certificate","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/downloadcertificate","routeSlug":"/apis/membership/membership-v1/memberships/downloadcertificate","metadata":{"seo":{"title":"Downloads a Certificate","description":"Returns the HTML for the certificate"}},"httpPath":"/memberships/{tenantId}/certificate/{id}"},{"label":"Returns a list of records with the specified chapter_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/listmembershipsbychapterid","routeSlug":"/apis/membership/membership-v1/memberships/listmembershipsbychapterid","metadata":{"seo":{"title":"Returns a list of records with the specified chapter_id","description":"Returns a list of records with the specified chapter_id"}},"httpPath":"/memberships/{tenantId}/chapter/{chapter_id}"},{"label":"Gets a membership by contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/getmembershipforcontact","routeSlug":"/apis/membership/membership-v1/memberships/getmembershipforcontact","metadata":{"seo":{"title":"Gets a membership by contact","description":"Gets a membership by contact"}},"httpPath":"/memberships/{tenantId}/contact/{contactId}"},{"label":"Given a set of expiration options, allows for the calculation of an expiration date","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/calculateexpirationdate","routeSlug":"/apis/membership/membership-v1/memberships/calculateexpirationdate","metadata":{"seo":{"title":"Given a set of expiration options, allows for the calculation of an expiration date","description":"Given a set of expiration options, allows for the calculation of an expiration date"}},"httpPath":"/memberships/{tenantId}/expirationDateCalculation/{dateToUseAsBasisForCalculation}"},{"label":"Generates a PDF for the ID Card and returns the public link for download","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/downloadidcard","routeSlug":"/apis/membership/membership-v1/memberships/downloadidcard","metadata":{"seo":{"title":"Generates a PDF for the ID Card and returns the public link for download","description":"Generates a PDF for the ID Card and returns the public link for download"}},"httpPath":"/memberships/{tenantId}/idCard/{id}"},{"label":"Generates snapshot lookback for a tenant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/initiatesnapshotlookback","routeSlug":"/apis/membership/membership-v1/memberships/initiatesnapshotlookback","metadata":{"seo":{"title":"Generates snapshot lookback for a tenant","description":"Given a set of expiration options, allows for the calculation of an expiration date"}},"httpPath":"/memberships/{tenantId}/initiateSnapshotLookback"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/listmembershipsbyorderid","routeSlug":"/apis/membership/membership-v1/memberships/listmembershipsbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"httpPath":"/memberships/{tenantId}/order/{order_id}"},{"label":"Gets a membership by organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/getmembershipfororganization","routeSlug":"/apis/membership/membership-v1/memberships/getmembershipfororganization","metadata":{"seo":{"title":"Gets a membership by organization","description":"Gets a membership by organization"}},"httpPath":"/memberships/{tenantId}/organization/{organizationId}"},{"label":"Returns a list of records with the specified parent_membership_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/listmembershipsbyparentmembershipid","routeSlug":"/apis/membership/membership-v1/memberships/listmembershipsbyparentmembershipid","metadata":{"seo":{"title":"Returns a list of records with the specified parent_membership_id","description":"Returns a list of records with the specified parent_membership_id"}},"httpPath":"/memberships/{tenantId}/parentMembership/{parent_membership_id}"},{"label":"Returns a membership from the system by its ID for a given contact.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/getmembershipforportal","routeSlug":"/apis/membership/membership-v1/memberships/getmembershipforportal","metadata":{"seo":{"title":"Returns a membership from the system by its ID for a given contact.","description":"This method will look up a membership by the specified ID and return it back (for a portal contact)"}},"httpPath":"/memberships/{tenantId}/portal/contact/{portalContactId}/{id}"},{"label":"Sends out a preview of the CRC notification certificate","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/previewcertificate","routeSlug":"/apis/membership/membership-v1/memberships/previewcertificate","metadata":{"seo":{"title":"Sends out a preview of the CRC notification certificate","description":"Sends out a preview of the CRC notification certificate"}},"httpPath":"/memberships/{tenantId}/previewCertificate"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/previewemail","routeSlug":"/apis/membership/membership-v1/memberships/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/memberships/{tenantId}/previewEmail"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/previewgroupapplicationemail","routeSlug":"/apis/membership/membership-v1/memberships/previewgroupapplicationemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/memberships/{tenantId}/previewGroupApplicationEmail"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/previewidcard","routeSlug":"/apis/membership/membership-v1/memberships/previewidcard","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/memberships/{tenantId}/previewIdCard/{id}"},{"label":"Re-runs flowdown for all organizations in the system","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/reprocessflowdown","routeSlug":"/apis/membership/membership-v1/memberships/reprocessflowdown","metadata":{"seo":{"title":"Re-runs flowdown for all organizations in the system","description":"Given a set of expiration options, allows for the calculation of an expiration date"}},"httpPath":"/memberships/{tenantId}/reprocessFlowDown"},{"label":"Searches for memberships using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/searchformemberships","routeSlug":"/apis/membership/membership-v1/memberships/searchformemberships","metadata":{"seo":{"title":"Searches for memberships using predefined parameters","description":"Searches for memberships using predefined parameters"}},"httpPath":"/memberships/{tenantId}/search"},{"label":"Returns a list of records with the specified section_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/listmembershipsbysectionid","routeSlug":"/apis/membership/membership-v1/memberships/listmembershipsbysectionid","metadata":{"seo":{"title":"Returns a list of records with the specified section_id","description":"Returns a list of records with the specified section_id"}},"httpPath":"/memberships/{tenantId}/section/{section_id}"},{"label":"Returns a membership from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/deletemembership","routeSlug":"/apis/membership/membership-v1/memberships/deletemembership","metadata":{"seo":{"title":"Returns a membership from the system by its ID.","description":"This method will delete a membership with the specified ID."}},"httpPath":"/memberships/{tenantId}/{id}"},{"label":"Returns a membership from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/getmembership","routeSlug":"/apis/membership/membership-v1/memberships/getmembership","metadata":{"seo":{"title":"Returns a membership from the system by its ID.","description":"This method will look up a membership by the specified ID and return it back."}},"httpPath":"/memberships/{tenantId}/{id}"},{"label":"Partially updates a membership with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/patchmembership","routeSlug":"/apis/membership/membership-v1/memberships/patchmembership","metadata":{"seo":{"title":"Partially updates a membership with the specified ID.","description":"This method will patch an existing membership with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/memberships/{tenantId}/{id}"},{"label":"Updates a membership with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/memberships/updatemembership","routeSlug":"/apis/membership/membership-v1/memberships/updatemembership","metadata":{"seo":{"title":"Updates a membership with the specified ID.","description":"This method will update an existing membership with the specified ID."}},"httpPath":"/memberships/{tenantId}/{id}"}]},{"type":"group","label":"Packages","link":"/apis/membership/membership-v1/packages","routeSlug":"/apis/membership/membership-v1/packages","items":[{"label":"Gets all of the packages in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/packages/listpackages","routeSlug":"/apis/membership/membership-v1/packages/listpackages","metadata":{"seo":{"title":"Gets all of the packages in the system.","description":"This method will scan all packages and and return them to the caller."}},"httpPath":"/packages/{tenantId}"},{"label":"Creates a new package record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/packages/createpackage","routeSlug":"/apis/membership/membership-v1/packages/createpackage","metadata":{"seo":{"title":"Creates a new package record that does not already exist.","description":"This method will auto-generate an ID and create a new package. If an ID is specified for the package, an error will be thrown."}},"httpPath":"/packages/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/packages/executebatchoperations","routeSlug":"/apis/membership/membership-v1/packages/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/packages/{tenantId}/batch"},{"label":"Get Packages for Online Store","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/packages/getpackagesforonlinestore","routeSlug":"/apis/membership/membership-v1/packages/getpackagesforonlinestore","metadata":{"seo":{"title":"Get Packages for Online Store","description":"Public endpoint that gets packages for use in the online store"}},"httpPath":"/packages/{tenantId}/public/onlineStore"},{"label":"Returns a package from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/packages/deletepackage","routeSlug":"/apis/membership/membership-v1/packages/deletepackage","metadata":{"seo":{"title":"Returns a package from the system by its ID.","description":"This method will delete a package with the specified ID."}},"httpPath":"/packages/{tenantId}/{id}"},{"label":"Returns a package from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/packages/getpackage","routeSlug":"/apis/membership/membership-v1/packages/getpackage","metadata":{"seo":{"title":"Returns a package from the system by its ID.","description":"This method will look up a package by the specified ID and return it back."}},"httpPath":"/packages/{tenantId}/{id}"},{"label":"Partially updates a package with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/packages/patchpackage","routeSlug":"/apis/membership/membership-v1/packages/patchpackage","metadata":{"seo":{"title":"Partially updates a package with the specified ID.","description":"This method will patch an existing package with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/packages/{tenantId}/{id}"},{"label":"Updates a package with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/packages/updatepackage","routeSlug":"/apis/membership/membership-v1/packages/updatepackage","metadata":{"seo":{"title":"Updates a package with the specified ID.","description":"This method will update an existing package with the specified ID."}},"httpPath":"/packages/{tenantId}/{id}"}]},{"type":"group","label":"Query Definitions","link":"/apis/membership/membership-v1/query-definitions","routeSlug":"/apis/membership/membership-v1/query-definitions","items":[{"label":"Returns a list of records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/query-definitions/getquerydefinitions","routeSlug":"/apis/membership/membership-v1/query-definitions/getquerydefinitions","metadata":{"seo":{"title":"Returns a list of records","description":"Returns a list of records"}},"httpPath":"/queryDefinitions/{tenantId}"}]},{"type":"group","label":"Recurring Billing Runs","link":"/apis/membership/membership-v1/recurring-billing-runs","routeSlug":"/apis/membership/membership-v1/recurring-billing-runs","items":[{"label":"Gets all of the recurring billing runs in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/recurring-billing-runs/listrecurringbillingruns","routeSlug":"/apis/membership/membership-v1/recurring-billing-runs/listrecurringbillingruns","metadata":{"seo":{"title":"Gets all of the recurring billing runs in the system.","description":"This method will scan all recurring billing runs and and return them to the caller."}},"httpPath":"/recurringBillingRuns/{tenantId}"},{"label":"Creates a new recurring billing run record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/recurring-billing-runs/createrecurringbillingrun","routeSlug":"/apis/membership/membership-v1/recurring-billing-runs/createrecurringbillingrun","metadata":{"seo":{"title":"Creates a new recurring billing run record that does not already exist.","description":"This method will auto-generate an ID and create a new recurring billing run. If an ID is specified for the recurring billing run, an error will be thrown."}},"httpPath":"/recurringBillingRuns/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/recurring-billing-runs/executebatchoperations","routeSlug":"/apis/membership/membership-v1/recurring-billing-runs/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/recurringBillingRuns/{tenantId}/batch"},{"label":"Returns a list of records with the specified template_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/recurring-billing-runs/listrunsbytemplateid","routeSlug":"/apis/membership/membership-v1/recurring-billing-runs/listrunsbytemplateid","metadata":{"seo":{"title":"Returns a list of records with the specified template_id","description":"Returns a list of records with the specified template_id"}},"httpPath":"/recurringBillingRuns/{tenantId}/template/{template_id}"},{"label":"Returns a recurring billing run from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/recurring-billing-runs/deleterecurringbillingrun","routeSlug":"/apis/membership/membership-v1/recurring-billing-runs/deleterecurringbillingrun","metadata":{"seo":{"title":"Returns a recurring billing run from the system by its ID.","description":"This method will delete a recurring billing run with the specified ID."}},"httpPath":"/recurringBillingRuns/{tenantId}/{id}"},{"label":"Returns a recurring billing run from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/recurring-billing-runs/getrecurringbillingrun","routeSlug":"/apis/membership/membership-v1/recurring-billing-runs/getrecurringbillingrun","metadata":{"seo":{"title":"Returns a recurring billing run from the system by its ID.","description":"This method will look up a recurring billing run by the specified ID and return it back."}},"httpPath":"/recurringBillingRuns/{tenantId}/{id}"},{"label":"Partially updates a recurring billing run with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/recurring-billing-runs/patchrecurringbillingrun","routeSlug":"/apis/membership/membership-v1/recurring-billing-runs/patchrecurringbillingrun","metadata":{"seo":{"title":"Partially updates a recurring billing run with the specified ID.","description":"This method will patch an existing recurring billing run with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/recurringBillingRuns/{tenantId}/{id}"},{"label":"Updates a recurring billing run with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/recurring-billing-runs/updaterecurringbillingrun","routeSlug":"/apis/membership/membership-v1/recurring-billing-runs/updaterecurringbillingrun","metadata":{"seo":{"title":"Updates a recurring billing run with the specified ID.","description":"This method will update an existing recurring billing run with the specified ID."}},"httpPath":"/recurringBillingRuns/{tenantId}/{id}"}]},{"type":"group","label":"Section Dues Products","link":"/apis/membership/membership-v1/section-dues-products","routeSlug":"/apis/membership/membership-v1/section-dues-products","items":[{"label":"Gets all of the section dues products in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-dues-products/listsectionduesproducts","routeSlug":"/apis/membership/membership-v1/section-dues-products/listsectionduesproducts","metadata":{"seo":{"title":"Gets all of the section dues products in the system.","description":"This method will scan all section dues products and and return them to the caller."}},"httpPath":"/sectionDuesProducts/{tenantId}"},{"label":"Creates a new section dues product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-dues-products/createsectionduesproduct","routeSlug":"/apis/membership/membership-v1/section-dues-products/createsectionduesproduct","metadata":{"seo":{"title":"Creates a new section dues product record that does not already exist.","description":"This method will auto-generate an ID and create a new section dues product. If an ID is specified for the section dues product, an error will be thrown."}},"httpPath":"/sectionDuesProducts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-dues-products/executebatchoperations","routeSlug":"/apis/membership/membership-v1/section-dues-products/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/sectionDuesProducts/{tenantId}/batch"},{"label":"Returns a list of records with the specified section_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-dues-products/listproductsbysectionid","routeSlug":"/apis/membership/membership-v1/section-dues-products/listproductsbysectionid","metadata":{"seo":{"title":"Returns a list of records with the specified section_id","description":"Returns a list of records with the specified section_id"}},"httpPath":"/sectionDuesProducts/{tenantId}/section/{section_id}"},{"label":"Returns a section dues product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-dues-products/deletesectionduesproduct","routeSlug":"/apis/membership/membership-v1/section-dues-products/deletesectionduesproduct","metadata":{"seo":{"title":"Returns a section dues product from the system by its ID.","description":"This method will delete a section dues product with the specified ID."}},"httpPath":"/sectionDuesProducts/{tenantId}/{id}"},{"label":"Returns a section dues product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-dues-products/getsectionduesproduct","routeSlug":"/apis/membership/membership-v1/section-dues-products/getsectionduesproduct","metadata":{"seo":{"title":"Returns a section dues product from the system by its ID.","description":"This method will look up a section dues product by the specified ID and return it back."}},"httpPath":"/sectionDuesProducts/{tenantId}/{id}"},{"label":"Partially updates a section dues product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-dues-products/patchsectionduesproduct","routeSlug":"/apis/membership/membership-v1/section-dues-products/patchsectionduesproduct","metadata":{"seo":{"title":"Partially updates a section dues product with the specified ID.","description":"This method will patch an existing section dues product with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/sectionDuesProducts/{tenantId}/{id}"},{"label":"Updates a section dues product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-dues-products/updatesectionduesproduct","routeSlug":"/apis/membership/membership-v1/section-dues-products/updatesectionduesproduct","metadata":{"seo":{"title":"Updates a section dues product with the specified ID.","description":"This method will update an existing section dues product with the specified ID."}},"httpPath":"/sectionDuesProducts/{tenantId}/{id}"}]},{"type":"group","label":"Section Types","link":"/apis/membership/membership-v1/section-types","routeSlug":"/apis/membership/membership-v1/section-types","items":[{"label":"Gets all of the section types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-types/listsectiontypes","routeSlug":"/apis/membership/membership-v1/section-types/listsectiontypes","metadata":{"seo":{"title":"Gets all of the section types in the system.","description":"This method will scan all section types and and return them to the caller."}},"httpPath":"/sectionTypes/{tenantId}"},{"label":"Creates a new section type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-types/createsectiontype","routeSlug":"/apis/membership/membership-v1/section-types/createsectiontype","metadata":{"seo":{"title":"Creates a new section type record that does not already exist.","description":"This method will auto-generate an ID and create a new section type. If an ID is specified for the section type, an error will be thrown."}},"httpPath":"/sectionTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-types/executebatchoperations","routeSlug":"/apis/membership/membership-v1/section-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/sectionTypes/{tenantId}/batch"},{"label":"Returns a section type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-types/deletesectiontype","routeSlug":"/apis/membership/membership-v1/section-types/deletesectiontype","metadata":{"seo":{"title":"Returns a section type from the system by its ID.","description":"This method will delete a section type with the specified ID."}},"httpPath":"/sectionTypes/{tenantId}/{id}"},{"label":"Returns a section type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-types/getsectiontype","routeSlug":"/apis/membership/membership-v1/section-types/getsectiontype","metadata":{"seo":{"title":"Returns a section type from the system by its ID.","description":"This method will look up a section type by the specified ID and return it back."}},"httpPath":"/sectionTypes/{tenantId}/{id}"},{"label":"Partially updates a section type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-types/patchsectiontype","routeSlug":"/apis/membership/membership-v1/section-types/patchsectiontype","metadata":{"seo":{"title":"Partially updates a section type with the specified ID.","description":"This method will patch an existing section type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/sectionTypes/{tenantId}/{id}"},{"label":"Updates a section type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/section-types/updatesectiontype","routeSlug":"/apis/membership/membership-v1/section-types/updatesectiontype","metadata":{"seo":{"title":"Updates a section type with the specified ID.","description":"This method will update an existing section type with the specified ID."}},"httpPath":"/sectionTypes/{tenantId}/{id}"}]},{"type":"group","label":"Sections","link":"/apis/membership/membership-v1/sections","routeSlug":"/apis/membership/membership-v1/sections","items":[{"label":"Gets all of the sections in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/sections/listsections","routeSlug":"/apis/membership/membership-v1/sections/listsections","metadata":{"seo":{"title":"Gets all of the sections in the system.","description":"This method will scan all sections and and return them to the caller."}},"httpPath":"/sections/{tenantId}"},{"label":"Creates a new section record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/sections/createsection","routeSlug":"/apis/membership/membership-v1/sections/createsection","metadata":{"seo":{"title":"Creates a new section record that does not already exist.","description":"This method will auto-generate an ID and create a new section. If an ID is specified for the section, an error will be thrown."}},"httpPath":"/sections/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/sections/executebatchoperations","routeSlug":"/apis/membership/membership-v1/sections/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/sections/{tenantId}/batch"},{"label":"Returns a list of sections for a given membership package","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/sections/describesectionsformembershippackage","routeSlug":"/apis/membership/membership-v1/sections/describesectionsformembershippackage","metadata":{"seo":{"title":"Returns a list of sections for a given membership package","description":"Returns a list of sections for a given membership package"}},"httpPath":"/sections/{tenantId}/portal/describeSections/{membershipPackageId}"},{"label":"Returns a list of sections for a given membership package","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/sections/describesectionsformembershippackageandmember","routeSlug":"/apis/membership/membership-v1/sections/describesectionsformembershippackageandmember","metadata":{"seo":{"title":"Returns a list of sections for a given membership package","description":"Returns a list of sections for a given membership package"}},"httpPath":"/sections/{tenantId}/portal/describeSections/{membershipPackageId}/{memberType}/{contactOrOrganizationId}"},{"label":"Searches for sections using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/sections/searchforsections","routeSlug":"/apis/membership/membership-v1/sections/searchforsections","metadata":{"seo":{"title":"Searches for sections using predefined parameters","description":"Searches for sections using predefined parameters"}},"httpPath":"/sections/{tenantId}/search"},{"label":"Returns a section from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/sections/deletesection","routeSlug":"/apis/membership/membership-v1/sections/deletesection","metadata":{"seo":{"title":"Returns a section from the system by its ID.","description":"This method will delete a section with the specified ID."}},"httpPath":"/sections/{tenantId}/{id}"},{"label":"Returns a section from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/sections/getsection","routeSlug":"/apis/membership/membership-v1/sections/getsection","metadata":{"seo":{"title":"Returns a section from the system by its ID.","description":"This method will look up a section by the specified ID and return it back."}},"httpPath":"/sections/{tenantId}/{id}"},{"label":"Partially updates a section with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/sections/patchsection","routeSlug":"/apis/membership/membership-v1/sections/patchsection","metadata":{"seo":{"title":"Partially updates a section with the specified ID.","description":"This method will patch an existing section with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/sections/{tenantId}/{id}"},{"label":"Updates a section with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/sections/updatesection","routeSlug":"/apis/membership/membership-v1/sections/updatesection","metadata":{"seo":{"title":"Updates a section with the specified ID.","description":"This method will update an existing section with the specified ID."}},"httpPath":"/sections/{tenantId}/{id}"}]},{"type":"group","label":"Settings","link":"/apis/membership/membership-v1/settings","routeSlug":"/apis/membership/membership-v1/settings","items":[{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/settings/deletesetting","routeSlug":"/apis/membership/membership-v1/settings/deletesetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will delete a setting with the specified ID."}},"httpPath":"/settings/{tenantId}"},{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/settings/getsetting","routeSlug":"/apis/membership/membership-v1/settings/getsetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will look up a setting by the specified ID and return it back."}},"httpPath":"/settings/{tenantId}"},{"label":"Partially updates a setting with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/settings/patchsetting","routeSlug":"/apis/membership/membership-v1/settings/patchsetting","metadata":{"seo":{"title":"Partially updates a setting with the specified ID.","description":"This method will patch an existing setting with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/settings/{tenantId}"},{"label":"Creates a new setting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/settings/createsetting","routeSlug":"/apis/membership/membership-v1/settings/createsetting","metadata":{"seo":{"title":"Creates a new setting record that does not already exist.","description":"This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, an error will be thrown."}},"httpPath":"/settings/{tenantId}"},{"label":"Updates a setting with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/settings/updatesetting","routeSlug":"/apis/membership/membership-v1/settings/updatesetting","metadata":{"seo":{"title":"Updates a setting with the specified ID.","description":"This method will update an existing setting with the specified ID."}},"httpPath":"/settings/{tenantId}"}]},{"type":"group","label":"Statistics","link":"/apis/membership/membership-v1/statistics","routeSlug":"/apis/membership/membership-v1/statistics","items":[{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/statistics/executebatchoperations","routeSlug":"/apis/membership/membership-v1/statistics/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/statistics/{tenantId}/batch"},{"label":"Returns a statistic from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/statistics/getstatistic","routeSlug":"/apis/membership/membership-v1/statistics/getstatistic","metadata":{"seo":{"title":"Returns a statistic from the system by its ID.","description":"This method will look up a statistic by the specified ID and return it back."}},"httpPath":"/statistics/{tenantId}/{id}"}]},{"type":"group","label":"Status Reasons","link":"/apis/membership/membership-v1/status-reasons","routeSlug":"/apis/membership/membership-v1/status-reasons","items":[{"label":"Gets all of the status reasons in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/status-reasons/liststatusreasons","routeSlug":"/apis/membership/membership-v1/status-reasons/liststatusreasons","metadata":{"seo":{"title":"Gets all of the status reasons in the system.","description":"This method will scan all status reasons and and return them to the caller."}},"httpPath":"/statusReasons/{tenantId}"},{"label":"Creates a new status reason record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/status-reasons/createstatusreason","routeSlug":"/apis/membership/membership-v1/status-reasons/createstatusreason","metadata":{"seo":{"title":"Creates a new status reason record that does not already exist.","description":"This method will auto-generate an ID and create a new status reason. If an ID is specified for the status reason, an error will be thrown."}},"httpPath":"/statusReasons/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/status-reasons/executebatchoperations","routeSlug":"/apis/membership/membership-v1/status-reasons/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/statusReasons/{tenantId}/batch"},{"label":"Returns a status reason from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/status-reasons/deletestatusreason","routeSlug":"/apis/membership/membership-v1/status-reasons/deletestatusreason","metadata":{"seo":{"title":"Returns a status reason from the system by its ID.","description":"This method will delete a status reason with the specified ID."}},"httpPath":"/statusReasons/{tenantId}/{id}"},{"label":"Returns a status reason from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/status-reasons/getstatusreason","routeSlug":"/apis/membership/membership-v1/status-reasons/getstatusreason","metadata":{"seo":{"title":"Returns a status reason from the system by its ID.","description":"This method will look up a status reason by the specified ID and return it back."}},"httpPath":"/statusReasons/{tenantId}/{id}"},{"label":"Partially updates a status reason with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/status-reasons/patchstatusreason","routeSlug":"/apis/membership/membership-v1/status-reasons/patchstatusreason","metadata":{"seo":{"title":"Partially updates a status reason with the specified ID.","description":"This method will patch an existing status reason with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/statusReasons/{tenantId}/{id}"},{"label":"Updates a status reason with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/status-reasons/updatestatusreason","routeSlug":"/apis/membership/membership-v1/status-reasons/updatestatusreason","metadata":{"seo":{"title":"Updates a status reason with the specified ID.","description":"This method will update an existing status reason with the specified ID."}},"httpPath":"/statusReasons/{tenantId}/{id}"}]},{"type":"group","label":"Types","link":"/apis/membership/membership-v1/types","routeSlug":"/apis/membership/membership-v1/types","items":[{"label":"Gets all of the types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/types/listtypes","routeSlug":"/apis/membership/membership-v1/types/listtypes","metadata":{"seo":{"title":"Gets all of the types in the system.","description":"This method will scan all types and and return them to the caller."}},"httpPath":"/types/{tenantId}"},{"label":"Creates a new type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/types/createtype","routeSlug":"/apis/membership/membership-v1/types/createtype","metadata":{"seo":{"title":"Creates a new type record that does not already exist.","description":"This method will auto-generate an ID and create a new type. If an ID is specified for the type, an error will be thrown."}},"httpPath":"/types/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/types/executebatchoperations","routeSlug":"/apis/membership/membership-v1/types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/types/{tenantId}/batch"},{"label":"Returns a type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/types/deletetype","routeSlug":"/apis/membership/membership-v1/types/deletetype","metadata":{"seo":{"title":"Returns a type from the system by its ID.","description":"This method will delete a type with the specified ID."}},"httpPath":"/types/{tenantId}/{id}"},{"label":"Returns a type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/types/gettype","routeSlug":"/apis/membership/membership-v1/types/gettype","metadata":{"seo":{"title":"Returns a type from the system by its ID.","description":"This method will look up a type by the specified ID and return it back."}},"httpPath":"/types/{tenantId}/{id}"},{"label":"Partially updates a type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/types/patchtype","routeSlug":"/apis/membership/membership-v1/types/patchtype","metadata":{"seo":{"title":"Partially updates a type with the specified ID.","description":"This method will patch an existing type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/types/{tenantId}/{id}"},{"label":"Updates a type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/membership/membership-v1/types/updatetype","routeSlug":"/apis/membership/membership-v1/types/updatetype","metadata":{"seo":{"title":"Updates a type with the specified ID.","description":"This method will update an existing type with the specified ID."}},"httpPath":"/types/{tenantId}/{id}"}]}]},{"type":"group","label":"Platform","items":[{"type":"link","label":"Platform","link":"/apis/platform/platform-v1","routeSlug":"/apis/platform/platform-v1"},{"type":"group","label":"360 Screens","link":"/apis/platform/platform-v1/360-screens","routeSlug":"/apis/platform/platform-v1/360-screens","items":[{"label":"Gets all of the 360 screens in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/360-screens/list360screens","routeSlug":"/apis/platform/platform-v1/360-screens/list360screens","metadata":{"seo":{"title":"Gets all of the 360 screens in the system.","description":"This method will scan all 360 screens and and return them to the caller."}},"httpPath":"/360Screens/{tenantId}"},{"label":"Creates a new 360 screen record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/360-screens/create360screen","routeSlug":"/apis/platform/platform-v1/360-screens/create360screen","metadata":{"seo":{"title":"Creates a new 360 screen record that does not already exist.","description":"This method will auto-generate an ID and create a new 360 screen. If an ID is specified for the 360 screen, an error will be thrown."}},"httpPath":"/360Screens/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/360-screens/executebatchoperations","routeSlug":"/apis/platform/platform-v1/360-screens/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/360Screens/{tenantId}/batch"},{"label":"Returns a list of records with the specified service","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/360-screens/listscreensbyservice","routeSlug":"/apis/platform/platform-v1/360-screens/listscreensbyservice","metadata":{"seo":{"title":"Returns a list of records with the specified service","description":"Returns a list of records with the specified service"}},"httpPath":"/360Screens/{tenantId}/service/{service}"},{"label":"Returns a 360 screen from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/360-screens/delete360screen","routeSlug":"/apis/platform/platform-v1/360-screens/delete360screen","metadata":{"seo":{"title":"Returns a 360 screen from the system by its ID.","description":"This method will delete a 360 screen with the specified ID."}},"httpPath":"/360Screens/{tenantId}/{id}"},{"label":"Returns a 360 screen from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/360-screens/get360screen","routeSlug":"/apis/platform/platform-v1/360-screens/get360screen","metadata":{"seo":{"title":"Returns a 360 screen from the system by its ID.","description":"This method will look up a 360 screen by the specified ID and return it back."}},"httpPath":"/360Screens/{tenantId}/{id}"},{"label":"Partially updates a 360 screen with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/360-screens/patch360screen","routeSlug":"/apis/platform/platform-v1/360-screens/patch360screen","metadata":{"seo":{"title":"Partially updates a 360 screen with the specified ID.","description":"This method will patch an existing 360 screen with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/360Screens/{tenantId}/{id}"},{"label":"Updates a 360 screen with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/360-screens/update360screen","routeSlug":"/apis/platform/platform-v1/360-screens/update360screen","metadata":{"seo":{"title":"Updates a 360 screen with the specified ID.","description":"This method will update an existing 360 screen with the specified ID."}},"httpPath":"/360Screens/{tenantId}/{id}"}]},{"type":"group","label":"Custom Fields","link":"/apis/platform/platform-v1/custom-fields","routeSlug":"/apis/platform/platform-v1/custom-fields","items":[{"label":"Gets all of the custom fields in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-fields/listcustomfields","routeSlug":"/apis/platform/platform-v1/custom-fields/listcustomfields","metadata":{"seo":{"title":"Gets all of the custom fields in the system.","description":"This method will scan all custom fields and and return them to the caller."}},"httpPath":"/customFields/{tenantId}"},{"label":"Creates a new custom field record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-fields/createcustomfield","routeSlug":"/apis/platform/platform-v1/custom-fields/createcustomfield","metadata":{"seo":{"title":"Creates a new custom field record that does not already exist.","description":"This method will auto-generate an ID and create a new custom field. If an ID is specified for the custom field, an error will be thrown."}},"httpPath":"/customFields/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-fields/executebatchoperations","routeSlug":"/apis/platform/platform-v1/custom-fields/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/customFields/{tenantId}/batch"},{"label":"Returns a list of records with the specified service","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-fields/listfieldsbyservice","routeSlug":"/apis/platform/platform-v1/custom-fields/listfieldsbyservice","metadata":{"seo":{"title":"Returns a list of records with the specified service","description":"Returns a list of records with the specified service"}},"httpPath":"/customFields/{tenantId}/service/{service}"},{"label":"Returns a custom field from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-fields/deletecustomfield","routeSlug":"/apis/platform/platform-v1/custom-fields/deletecustomfield","metadata":{"seo":{"title":"Returns a custom field from the system by its ID.","description":"This method will delete a custom field with the specified ID."}},"httpPath":"/customFields/{tenantId}/{id}"},{"label":"Returns a custom field from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-fields/getcustomfield","routeSlug":"/apis/platform/platform-v1/custom-fields/getcustomfield","metadata":{"seo":{"title":"Returns a custom field from the system by its ID.","description":"This method will look up a custom field by the specified ID and return it back."}},"httpPath":"/customFields/{tenantId}/{id}"},{"label":"Partially updates a custom field with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-fields/patchcustomfield","routeSlug":"/apis/platform/platform-v1/custom-fields/patchcustomfield","metadata":{"seo":{"title":"Partially updates a custom field with the specified ID.","description":"This method will patch an existing custom field with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/customFields/{tenantId}/{id}"},{"label":"Updates a custom field with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-fields/updatecustomfield","routeSlug":"/apis/platform/platform-v1/custom-fields/updatecustomfield","metadata":{"seo":{"title":"Updates a custom field with the specified ID.","description":"This method will update an existing custom field with the specified ID."}},"httpPath":"/customFields/{tenantId}/{id}"}]},{"type":"group","label":"Custom Objects","link":"/apis/platform/platform-v1/custom-objects","routeSlug":"/apis/platform/platform-v1/custom-objects","items":[{"label":"Gets all of the custom objects in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-objects/listcustomobjects","routeSlug":"/apis/platform/platform-v1/custom-objects/listcustomobjects","metadata":{"seo":{"title":"Gets all of the custom objects in the system.","description":"This method will scan all custom objects and and return them to the caller."}},"httpPath":"/customObjects/{tenantId}"},{"label":"Creates a new custom object record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-objects/createcustomobject","routeSlug":"/apis/platform/platform-v1/custom-objects/createcustomobject","metadata":{"seo":{"title":"Creates a new custom object record that does not already exist.","description":"This method will auto-generate an ID and create a new custom object. If an ID is specified for the custom object, an error will be thrown."}},"httpPath":"/customObjects/{tenantId}"},{"label":"Returns a custom object from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-objects/deletecustomobject","routeSlug":"/apis/platform/platform-v1/custom-objects/deletecustomobject","metadata":{"seo":{"title":"Returns a custom object from the system by its ID.","description":"This method will delete a custom object with the specified ID."}},"httpPath":"/customObjects/{tenantId}/{id}"},{"label":"Returns a custom object from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-objects/getcustomobject","routeSlug":"/apis/platform/platform-v1/custom-objects/getcustomobject","metadata":{"seo":{"title":"Returns a custom object from the system by its ID.","description":"This method will look up a custom object by the specified ID and return it back."}},"httpPath":"/customObjects/{tenantId}/{id}"},{"label":"Partially updates a custom object with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-objects/patchcustomobject","routeSlug":"/apis/platform/platform-v1/custom-objects/patchcustomobject","metadata":{"seo":{"title":"Partially updates a custom object with the specified ID.","description":"This method will patch an existing custom object with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/customObjects/{tenantId}/{id}"},{"label":"Updates a custom object with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-objects/updatecustomobject","routeSlug":"/apis/platform/platform-v1/custom-objects/updatecustomobject","metadata":{"seo":{"title":"Updates a custom object with the specified ID.","description":"This method will update an existing custom object with the specified ID."}},"httpPath":"/customObjects/{tenantId}/{id}"}]},{"type":"group","label":"Custom Query Definitions","link":"/apis/platform/platform-v1/custom-query-definitions","routeSlug":"/apis/platform/platform-v1/custom-query-definitions","items":[{"label":"Gets all of the custom query definitions in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-query-definitions/listcustomquerydefinitions","routeSlug":"/apis/platform/platform-v1/custom-query-definitions/listcustomquerydefinitions","metadata":{"seo":{"title":"Gets all of the custom query definitions in the system.","description":"This method will scan all custom query definitions and and return them to the caller."}},"httpPath":"/customQueryDefinitions/{tenantId}"},{"label":"Creates a new custom query definition record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-query-definitions/createcustomquerydefinition","routeSlug":"/apis/platform/platform-v1/custom-query-definitions/createcustomquerydefinition","metadata":{"seo":{"title":"Creates a new custom query definition record that does not already exist.","description":"This method will auto-generate an ID and create a new custom query definition. If an ID is specified for the custom query definition, an error will be thrown."}},"httpPath":"/customQueryDefinitions/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-query-definitions/executebatchoperations","routeSlug":"/apis/platform/platform-v1/custom-query-definitions/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/customQueryDefinitions/{tenantId}/batch"},{"label":"Returns a custom query definition from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-query-definitions/deletecustomquerydefinition","routeSlug":"/apis/platform/platform-v1/custom-query-definitions/deletecustomquerydefinition","metadata":{"seo":{"title":"Returns a custom query definition from the system by its ID.","description":"This method will delete a custom query definition with the specified ID."}},"httpPath":"/customQueryDefinitions/{tenantId}/{id}"},{"label":"Returns a custom query definition from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-query-definitions/getcustomquerydefinition","routeSlug":"/apis/platform/platform-v1/custom-query-definitions/getcustomquerydefinition","metadata":{"seo":{"title":"Returns a custom query definition from the system by its ID.","description":"This method will look up a custom query definition by the specified ID and return it back."}},"httpPath":"/customQueryDefinitions/{tenantId}/{id}"},{"label":"Partially updates a custom query definition with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-query-definitions/patchcustomquerydefinition","routeSlug":"/apis/platform/platform-v1/custom-query-definitions/patchcustomquerydefinition","metadata":{"seo":{"title":"Partially updates a custom query definition with the specified ID.","description":"This method will patch an existing custom query definition with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/customQueryDefinitions/{tenantId}/{id}"},{"label":"Updates a custom query definition with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-query-definitions/updatecustomquerydefinition","routeSlug":"/apis/platform/platform-v1/custom-query-definitions/updatecustomquerydefinition","metadata":{"seo":{"title":"Updates a custom query definition with the specified ID.","description":"This method will update an existing custom query definition with the specified ID."}},"httpPath":"/customQueryDefinitions/{tenantId}/{id}"}]},{"type":"group","label":"Custom Record Actions","link":"/apis/platform/platform-v1/custom-record-actions","routeSlug":"/apis/platform/platform-v1/custom-record-actions","items":[{"label":"Gets all of the custom record actions in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-record-actions/listcustomrecordactions","routeSlug":"/apis/platform/platform-v1/custom-record-actions/listcustomrecordactions","metadata":{"seo":{"title":"Gets all of the custom record actions in the system.","description":"This method will scan all custom record actions and and return them to the caller."}},"httpPath":"/customRecordActions/{tenantId}"},{"label":"Creates a new custom record action record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-record-actions/createcustomrecordaction","routeSlug":"/apis/platform/platform-v1/custom-record-actions/createcustomrecordaction","metadata":{"seo":{"title":"Creates a new custom record action record that does not already exist.","description":"This method will auto-generate an ID and create a new custom record action. If an ID is specified for the custom record action, an error will be thrown."}},"httpPath":"/customRecordActions/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-record-actions/executebatchoperations","routeSlug":"/apis/platform/platform-v1/custom-record-actions/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/customRecordActions/{tenantId}/batch"},{"label":"Execute Custom Action for a given Record","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-record-actions/executecustomaction","routeSlug":"/apis/platform/platform-v1/custom-record-actions/executecustomaction","metadata":{"seo":{"title":"Execute Custom Action for a given Record","description":"Execute Custom Action for a given Record"}},"httpPath":"/customRecordActions/{tenantId}/execute/{id}/{service}/{record_id}"},{"label":"Returns a custom record action from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-record-actions/deletecustomrecordaction","routeSlug":"/apis/platform/platform-v1/custom-record-actions/deletecustomrecordaction","metadata":{"seo":{"title":"Returns a custom record action from the system by its ID.","description":"This method will delete a custom record action with the specified ID."}},"httpPath":"/customRecordActions/{tenantId}/{id}"},{"label":"Returns a custom record action from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-record-actions/getcustomrecordaction","routeSlug":"/apis/platform/platform-v1/custom-record-actions/getcustomrecordaction","metadata":{"seo":{"title":"Returns a custom record action from the system by its ID.","description":"This method will look up a custom record action by the specified ID and return it back."}},"httpPath":"/customRecordActions/{tenantId}/{id}"},{"label":"Partially updates a custom record action with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-record-actions/patchcustomrecordaction","routeSlug":"/apis/platform/platform-v1/custom-record-actions/patchcustomrecordaction","metadata":{"seo":{"title":"Partially updates a custom record action with the specified ID.","description":"This method will patch an existing custom record action with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/customRecordActions/{tenantId}/{id}"},{"label":"Updates a custom record action with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/custom-record-actions/updatecustomrecordaction","routeSlug":"/apis/platform/platform-v1/custom-record-actions/updatecustomrecordaction","metadata":{"seo":{"title":"Updates a custom record action with the specified ID.","description":"This method will update an existing custom record action with the specified ID."}},"httpPath":"/customRecordActions/{tenantId}/{id}"}]},{"type":"group","label":"Customization Config Settings","link":"/apis/platform/platform-v1/customization-config-settings","routeSlug":"/apis/platform/platform-v1/customization-config-settings","items":[{"label":"Gets all of the customization config settings in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/customization-config-settings/listcustomizationconfigsettings","routeSlug":"/apis/platform/platform-v1/customization-config-settings/listcustomizationconfigsettings","metadata":{"seo":{"title":"Gets all of the customization config settings in the system.","description":"This method will scan all customization config settings and and return them to the caller."}},"httpPath":"/customizationConfigSettings/{tenantId}"},{"label":"Creates a new customization config setting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/customization-config-settings/createcustomizationconfigsetting","routeSlug":"/apis/platform/platform-v1/customization-config-settings/createcustomizationconfigsetting","metadata":{"seo":{"title":"Creates a new customization config setting record that does not already exist.","description":"This method will auto-generate an ID and create a new customization config setting. If an ID is specified for the customization config setting, an error will be thrown."}},"httpPath":"/customizationConfigSettings/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/customization-config-settings/executebatchoperations","routeSlug":"/apis/platform/platform-v1/customization-config-settings/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/customizationConfigSettings/{tenantId}/batch"},{"label":"Returns a customization config setting from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/customization-config-settings/deletecustomizationconfigsetting","routeSlug":"/apis/platform/platform-v1/customization-config-settings/deletecustomizationconfigsetting","metadata":{"seo":{"title":"Returns a customization config setting from the system by its ID.","description":"This method will delete a customization config setting with the specified ID."}},"httpPath":"/customizationConfigSettings/{tenantId}/{id}"},{"label":"Returns a customization config setting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/customization-config-settings/getcustomizationconfigsetting","routeSlug":"/apis/platform/platform-v1/customization-config-settings/getcustomizationconfigsetting","metadata":{"seo":{"title":"Returns a customization config setting from the system by its ID.","description":"This method will look up a customization config setting by the specified ID and return it back."}},"httpPath":"/customizationConfigSettings/{tenantId}/{id}"},{"label":"Partially updates a customization config setting with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/customization-config-settings/patchcustomizationconfigsetting","routeSlug":"/apis/platform/platform-v1/customization-config-settings/patchcustomizationconfigsetting","metadata":{"seo":{"title":"Partially updates a customization config setting with the specified ID.","description":"This method will patch an existing customization config setting with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/customizationConfigSettings/{tenantId}/{id}"},{"label":"Updates a customization config setting with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/customization-config-settings/updatecustomizationconfigsetting","routeSlug":"/apis/platform/platform-v1/customization-config-settings/updatecustomizationconfigsetting","metadata":{"seo":{"title":"Updates a customization config setting with the specified ID.","description":"This method will update an existing customization config setting with the specified ID."}},"httpPath":"/customizationConfigSettings/{tenantId}/{id}"}]},{"type":"group","label":"Directory Entry Comments","link":"/apis/platform/platform-v1/directory-entry-comments","routeSlug":"/apis/platform/platform-v1/directory-entry-comments","items":[{"label":"Returns a list of records with the specified entry_id (public)","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/directory-entry-comments/listcommentsbyentryidpublic","routeSlug":"/apis/platform/platform-v1/directory-entry-comments/listcommentsbyentryidpublic","metadata":{"seo":{"title":"Returns a list of records with the specified entry_id (public)","description":"Returns a list of records with the specified entry_id"}},"httpPath":"/directoryEntryComments/public/{tenantId}/entry/{directory_service}/{directory_id}/{entry_id}"},{"label":"Creates a new directory entry comment record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/directory-entry-comments/createdirectoryentrycomment","routeSlug":"/apis/platform/platform-v1/directory-entry-comments/createdirectoryentrycomment","metadata":{"seo":{"title":"Creates a new directory entry comment record that does not already exist.","description":"This method will auto-generate an ID and create a new directory entry comment. If an ID is specified for the directory entry comment, an error will be thrown."}},"httpPath":"/directoryEntryComments/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/directory-entry-comments/executebatchoperations","routeSlug":"/apis/platform/platform-v1/directory-entry-comments/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/directoryEntryComments/{tenantId}/batch"},{"label":"Returns a list of records with the specified directory_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/directory-entry-comments/listcommentsbydirectoryid","routeSlug":"/apis/platform/platform-v1/directory-entry-comments/listcommentsbydirectoryid","metadata":{"seo":{"title":"Returns a list of records with the specified directory_id","description":"Returns a list of records with the specified directory_id"}},"httpPath":"/directoryEntryComments/{tenantId}/directory/{directory_service}/{directory_id}"},{"label":"Returns a list of records with the specified entry_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/directory-entry-comments/listcommentsbyentryid","routeSlug":"/apis/platform/platform-v1/directory-entry-comments/listcommentsbyentryid","metadata":{"seo":{"title":"Returns a list of records with the specified entry_id","description":"Returns a list of records with the specified entry_id"}},"httpPath":"/directoryEntryComments/{tenantId}/entry/{directory_service}/{directory_id}/{entry_id}"},{"label":"Returns a list of records with the specified submitter_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/directory-entry-comments/listcommentsbysubmitterid","routeSlug":"/apis/platform/platform-v1/directory-entry-comments/listcommentsbysubmitterid","metadata":{"seo":{"title":"Returns a list of records with the specified submitter_id","description":"Returns a list of records with the specified submitter_id"}},"httpPath":"/directoryEntryComments/{tenantId}/submitter/{submitter_id}"},{"label":"Returns a directory entry comment from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/directory-entry-comments/deletedirectoryentrycomment","routeSlug":"/apis/platform/platform-v1/directory-entry-comments/deletedirectoryentrycomment","metadata":{"seo":{"title":"Returns a directory entry comment from the system by its ID.","description":"This method will delete a directory entry comment with the specified ID."}},"httpPath":"/directoryEntryComments/{tenantId}/{id}"},{"label":"Returns a directory entry comment from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/directory-entry-comments/getdirectoryentrycomment","routeSlug":"/apis/platform/platform-v1/directory-entry-comments/getdirectoryentrycomment","metadata":{"seo":{"title":"Returns a directory entry comment from the system by its ID.","description":"This method will look up a directory entry comment by the specified ID and return it back."}},"httpPath":"/directoryEntryComments/{tenantId}/{id}"},{"label":"Partially updates a directory entry comment with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/directory-entry-comments/patchdirectoryentrycomment","routeSlug":"/apis/platform/platform-v1/directory-entry-comments/patchdirectoryentrycomment","metadata":{"seo":{"title":"Partially updates a directory entry comment with the specified ID.","description":"This method will patch an existing directory entry comment with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/directoryEntryComments/{tenantId}/{id}"},{"label":"Updates a directory entry comment with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/directory-entry-comments/updatedirectoryentrycomment","routeSlug":"/apis/platform/platform-v1/directory-entry-comments/updatedirectoryentrycomment","metadata":{"seo":{"title":"Updates a directory entry comment with the specified ID.","description":"This method will update an existing directory entry comment with the specified ID."}},"httpPath":"/directoryEntryComments/{tenantId}/{id}"}]},{"type":"group","label":"Email Activities","link":"/apis/platform/platform-v1/email-activities","routeSlug":"/apis/platform/platform-v1/email-activities","items":[{"label":"Returns a list of email activity by contact id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/email-activities/getemailactivitybycontactid","routeSlug":"/apis/platform/platform-v1/email-activities/getemailactivitybycontactid","metadata":{"seo":{"title":"Returns a list of email activity by contact id","description":"Returns a list of email activity by contact id"}},"httpPath":"/emailActivities/{tenantId}/{contactId}"}]},{"type":"group","label":"Email Integrations","link":"/apis/platform/platform-v1/email-integrations","routeSlug":"/apis/platform/platform-v1/email-integrations","items":[{"label":"Creates a new email integration record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/email-integrations/createemailintegration","routeSlug":"/apis/platform/platform-v1/email-integrations/createemailintegration","metadata":{"seo":{"title":"Creates a new email integration record that does not already exist.","description":"This method will auto-generate an ID and create a new email integration. If an ID is specified for the email integration, an error will be thrown."}},"httpPath":"/emailIntegrations/{tenantId}"},{"label":"Returns a list of email accounts that are available for integration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/email-integrations/listemailintegrationaccounts","routeSlug":"/apis/platform/platform-v1/email-integrations/listemailintegrationaccounts","metadata":{"seo":{"title":"Returns a list of email accounts that are available for integration","description":"Returns a list of email accounts that are available for integration"}},"httpPath":"/emailIntegrations/{tenantId}/accounts"},{"label":"Returns a list of email integrated queries by app","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/email-integrations/listemailintegrationsbyapp","routeSlug":"/apis/platform/platform-v1/email-integrations/listemailintegrationsbyapp","metadata":{"seo":{"title":"Returns a list of email integrated queries by app","description":"Returns a list of email integrated queries by app"}},"httpPath":"/emailIntegrations/{tenantId}/app/{app}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/email-integrations/executebatchoperations","routeSlug":"/apis/platform/platform-v1/email-integrations/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/emailIntegrations/{tenantId}/batch"},{"label":"Returns a list of email integrated queries by query","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/email-integrations/listemailintegrationsbyquery","routeSlug":"/apis/platform/platform-v1/email-integrations/listemailintegrationsbyquery","metadata":{"seo":{"title":"Returns a list of email integrated queries by query","description":"Returns a list of email integrated queries by query"}},"httpPath":"/emailIntegrations/{tenantId}/query/{query_id}"},{"label":"Returns a email integration from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/email-integrations/deleteemailintegration","routeSlug":"/apis/platform/platform-v1/email-integrations/deleteemailintegration","metadata":{"seo":{"title":"Returns a email integration from the system by its ID.","description":"This method will delete a email integration with the specified ID."}},"httpPath":"/emailIntegrations/{tenantId}/{id}"},{"label":"Returns a email integration from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/email-integrations/getemailintegration","routeSlug":"/apis/platform/platform-v1/email-integrations/getemailintegration","metadata":{"seo":{"title":"Returns a email integration from the system by its ID.","description":"This method will look up a email integration by the specified ID and return it back."}},"httpPath":"/emailIntegrations/{tenantId}/{id}"},{"label":"Partially updates a email integration with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/email-integrations/patchemailintegration","routeSlug":"/apis/platform/platform-v1/email-integrations/patchemailintegration","metadata":{"seo":{"title":"Partially updates a email integration with the specified ID.","description":"This method will patch an existing email integration with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/emailIntegrations/{tenantId}/{id}"},{"label":"Updates a email integration with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/email-integrations/updateemailintegration","routeSlug":"/apis/platform/platform-v1/email-integrations/updateemailintegration","metadata":{"seo":{"title":"Updates a email integration with the specified ID.","description":"This method will update an existing email integration with the specified ID."}},"httpPath":"/emailIntegrations/{tenantId}/{id}"}]},{"type":"group","label":"File Uploads","link":"/apis/platform/platform-v1/file-uploads","routeSlug":"/apis/platform/platform-v1/file-uploads","items":[{"label":"Uploads a file to a temporary staging location","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/file-uploads/createtemporaryfile","routeSlug":"/apis/platform/platform-v1/file-uploads/createtemporaryfile","metadata":{"seo":{"title":"Uploads a file to a temporary staging location","description":"This method uploads a file to a temporary staging location"}},"httpPath":"/fileUploads/staging/{tenantId}/{service}/{filename}"},{"label":"Retrieves a previously uploaded file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/file-uploads/getpublicimage","routeSlug":"/apis/platform/platform-v1/file-uploads/getpublicimage","metadata":{"seo":{"title":"Retrieves a previously uploaded file","description":"This method retrieves a file that was previously uploaded"}},"httpPath":"/fileUploads/{tenantId}/public/{service}/{id}/{fileid}/image"},{"label":"Gets a presigned URL to update for uploading a public image","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/file-uploads/getsignedurltouploadpublicimage","routeSlug":"/apis/platform/platform-v1/file-uploads/getsignedurltouploadpublicimage","metadata":{"seo":{"title":"Gets a presigned URL to update for uploading a public image","description":"This method retrieves a file that was previously uploaded"}},"httpPath":"/fileUploads/{tenantId}/public/{service}/{id}/{fileid}/presignedUrlForUpload"},{"label":"Returns an AWS S3 pre-signed URL for use in downloading a file from a web application","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/file-uploads/getsignedurlforfile","routeSlug":"/apis/platform/platform-v1/file-uploads/getsignedurlforfile","metadata":{"seo":{"title":"Returns an AWS S3 pre-signed URL for use in downloading a file from a web application","description":"This method contacts S3 and generates a \"presigned URL.\" This URL can be used to post a file. The return value is the URL to post."}},"httpPath":"/fileUploads/{tenantId}/signedUrl/{service}/{id}/{fileid}"},{"label":"Returns an AWS S3 pre-signed URL for use in uploading a file from a web application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/file-uploads/gettemporaryfileuploadurl","routeSlug":"/apis/platform/platform-v1/file-uploads/gettemporaryfileuploadurl","metadata":{"seo":{"title":"Returns an AWS S3 pre-signed URL for use in uploading a file from a web application","description":"This method contacts S3 and generates a \"presigned URL.\" This URL can be used to post a file. The return value is the URL to post."}},"httpPath":"/fileUploads/{tenantId}/signedUrlRequest/{service}/{filename}"},{"label":"Retrieves a previously uploaded file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/file-uploads/getfile","routeSlug":"/apis/platform/platform-v1/file-uploads/getfile","metadata":{"seo":{"title":"Retrieves a previously uploaded file","description":"This method retrieves a file that was previously uploaded"}},"httpPath":"/fileUploads/{tenantId}/{service}/{id}/{fileid}"},{"label":"Retrieves a previously uploaded file","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/file-uploads/getimage","routeSlug":"/apis/platform/platform-v1/file-uploads/getimage","metadata":{"seo":{"title":"Retrieves a previously uploaded file","description":"This method retrieves a file that was previously uploaded"}},"httpPath":"/fileUploads/{tenantId}/{service}/{id}/{fileid}/image"}]},{"type":"group","label":"Page Layouts","link":"/apis/platform/platform-v1/page-layouts","routeSlug":"/apis/platform/platform-v1/page-layouts","items":[{"label":"Gets all of the page layouts in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/page-layouts/listpagelayouts","routeSlug":"/apis/platform/platform-v1/page-layouts/listpagelayouts","metadata":{"seo":{"title":"Gets all of the page layouts in the system.","description":"This method will scan all page layouts and and return them to the caller."}},"httpPath":"/pageLayouts/{tenantId}"},{"label":"Creates a new page layout record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/page-layouts/createpagelayout","routeSlug":"/apis/platform/platform-v1/page-layouts/createpagelayout","metadata":{"seo":{"title":"Creates a new page layout record that does not already exist.","description":"This method will auto-generate an ID and create a new page layout. If an ID is specified for the page layout, an error will be thrown."}},"httpPath":"/pageLayouts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/page-layouts/executebatchoperations","routeSlug":"/apis/platform/platform-v1/page-layouts/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/pageLayouts/{tenantId}/batch"},{"label":"Gets all of the page layouts for a particular service","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/page-layouts/listpagelayoutsbyservice","routeSlug":"/apis/platform/platform-v1/page-layouts/listpagelayoutsbyservice","metadata":{"seo":{"title":"Gets all of the page layouts for a particular service","description":"This method will scan all page layouts for a service and return them to the caller"}},"httpPath":"/pageLayouts/{tenantId}/service/{serviceName}"},{"label":"Returns a page layout from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/page-layouts/deletepagelayout","routeSlug":"/apis/platform/platform-v1/page-layouts/deletepagelayout","metadata":{"seo":{"title":"Returns a page layout from the system by its ID.","description":"This method will delete a page layout with the specified ID."}},"httpPath":"/pageLayouts/{tenantId}/{id}"},{"label":"Returns a page layout from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/page-layouts/getpagelayout","routeSlug":"/apis/platform/platform-v1/page-layouts/getpagelayout","metadata":{"seo":{"title":"Returns a page layout from the system by its ID.","description":"This method will look up a page layout by the specified ID and return it back."}},"httpPath":"/pageLayouts/{tenantId}/{id}"},{"label":"Partially updates a page layout with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/page-layouts/patchpagelayout","routeSlug":"/apis/platform/platform-v1/page-layouts/patchpagelayout","metadata":{"seo":{"title":"Partially updates a page layout with the specified ID.","description":"This method will patch an existing page layout with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/pageLayouts/{tenantId}/{id}"},{"label":"Updates a page layout with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/page-layouts/updatepagelayout","routeSlug":"/apis/platform/platform-v1/page-layouts/updatepagelayout","metadata":{"seo":{"title":"Updates a page layout with the specified ID.","description":"This method will update an existing page layout with the specified ID."}},"httpPath":"/pageLayouts/{tenantId}/{id}"}]},{"type":"group","label":"Query Delivery Schedules","link":"/apis/platform/platform-v1/query-delivery-schedules","routeSlug":"/apis/platform/platform-v1/query-delivery-schedules","items":[{"label":"Creates a new query delivery schedule record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/query-delivery-schedules/createquerydeliveryschedule","routeSlug":"/apis/platform/platform-v1/query-delivery-schedules/createquerydeliveryschedule","metadata":{"seo":{"title":"Creates a new query delivery schedule record that does not already exist.","description":"This method will auto-generate an ID and create a new query delivery schedule. If an ID is specified for the query delivery schedule, an error will be thrown."}},"httpPath":"/queryDeliverySchedules/{tenantId}"},{"label":"Returns a list of records with the specified application_context_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/query-delivery-schedules/listschedulesbyapplicationcontextid","routeSlug":"/apis/platform/platform-v1/query-delivery-schedules/listschedulesbyapplicationcontextid","metadata":{"seo":{"title":"Returns a list of records with the specified application_context_id","description":"Returns a list of records with the specified application_context_id"}},"httpPath":"/queryDeliverySchedules/{tenantId}/applicationContext/{application}/{contextId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/query-delivery-schedules/executebatchoperations","routeSlug":"/apis/platform/platform-v1/query-delivery-schedules/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/queryDeliverySchedules/{tenantId}/batch"},{"label":"Immediately processes a delivery schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/query-delivery-schedules/processscheduleimmediately","routeSlug":"/apis/platform/platform-v1/query-delivery-schedules/processscheduleimmediately","metadata":{"seo":{"title":"Immediately processes a delivery schedule","description":"Immediately processes a delivery schedule"}},"httpPath":"/queryDeliverySchedules/{tenantId}/process/{scheduleId}"},{"label":"Immediately processes a delivery schedule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/query-delivery-schedules/processscheduleimmediatelywithstepfunction","routeSlug":"/apis/platform/platform-v1/query-delivery-schedules/processscheduleimmediatelywithstepfunction","metadata":{"seo":{"title":"Immediately processes a delivery schedule","description":"Immediately processes a delivery schedule"}},"httpPath":"/queryDeliverySchedules/{tenantId}/processWithStepFunction/{scheduleId}"},{"label":"Returns a query delivery schedule from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/query-delivery-schedules/deletequerydeliveryschedule","routeSlug":"/apis/platform/platform-v1/query-delivery-schedules/deletequerydeliveryschedule","metadata":{"seo":{"title":"Returns a query delivery schedule from the system by its ID.","description":"This method will delete a query delivery schedule with the specified ID."}},"httpPath":"/queryDeliverySchedules/{tenantId}/{id}"},{"label":"Returns a query delivery schedule from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/query-delivery-schedules/getquerydeliveryschedule","routeSlug":"/apis/platform/platform-v1/query-delivery-schedules/getquerydeliveryschedule","metadata":{"seo":{"title":"Returns a query delivery schedule from the system by its ID.","description":"This method will look up a query delivery schedule by the specified ID and return it back."}},"httpPath":"/queryDeliverySchedules/{tenantId}/{id}"},{"label":"Partially updates a query delivery schedule with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/query-delivery-schedules/patchquerydeliveryschedule","routeSlug":"/apis/platform/platform-v1/query-delivery-schedules/patchquerydeliveryschedule","metadata":{"seo":{"title":"Partially updates a query delivery schedule with the specified ID.","description":"This method will patch an existing query delivery schedule with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/queryDeliverySchedules/{tenantId}/{id}"},{"label":"Updates a query delivery schedule with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/query-delivery-schedules/updatequerydeliveryschedule","routeSlug":"/apis/platform/platform-v1/query-delivery-schedules/updatequerydeliveryschedule","metadata":{"seo":{"title":"Updates a query delivery schedule with the specified ID.","description":"This method will update an existing query delivery schedule with the specified ID."}},"httpPath":"/queryDeliverySchedules/{tenantId}/{id}"}]},{"type":"group","label":"Query User Profiles","link":"/apis/platform/platform-v1/query-user-profiles","routeSlug":"/apis/platform/platform-v1/query-user-profiles","items":[{"label":"Creates a new query user profile record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/query-user-profiles/createqueryuserprofile","routeSlug":"/apis/platform/platform-v1/query-user-profiles/createqueryuserprofile","metadata":{"seo":{"title":"Creates a new query user profile record that does not already exist.","description":"This method will auto-generate an ID and create a new query user profile. If an ID is specified for the query user profile, an error will be thrown."}},"httpPath":"/queryUserProfiles/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/query-user-profiles/executebatchoperations","routeSlug":"/apis/platform/platform-v1/query-user-profiles/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/queryUserProfiles/{tenantId}/batch"},{"label":"Returns a query user profile from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/query-user-profiles/deletequeryuserprofile","routeSlug":"/apis/platform/platform-v1/query-user-profiles/deletequeryuserprofile","metadata":{"seo":{"title":"Returns a query user profile from the system by its ID.","description":"This method will delete a query user profile with the specified ID."}},"httpPath":"/queryUserProfiles/{tenantId}/{id}"},{"label":"Returns a query user profile from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/query-user-profiles/getqueryuserprofile","routeSlug":"/apis/platform/platform-v1/query-user-profiles/getqueryuserprofile","metadata":{"seo":{"title":"Returns a query user profile from the system by its ID.","description":"This method will look up a query user profile by the specified ID and return it back."}},"httpPath":"/queryUserProfiles/{tenantId}/{id}"},{"label":"Partially updates a query user profile with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/query-user-profiles/patchqueryuserprofile","routeSlug":"/apis/platform/platform-v1/query-user-profiles/patchqueryuserprofile","metadata":{"seo":{"title":"Partially updates a query user profile with the specified ID.","description":"This method will patch an existing query user profile with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/queryUserProfiles/{tenantId}/{id}"},{"label":"Updates a query user profile with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/query-user-profiles/updatequeryuserprofile","routeSlug":"/apis/platform/platform-v1/query-user-profiles/updatequeryuserprofile","metadata":{"seo":{"title":"Updates a query user profile with the specified ID.","description":"This method will update an existing query user profile with the specified ID."}},"httpPath":"/queryUserProfiles/{tenantId}/{id}"}]},{"type":"group","label":"Record Alert Rule Sets","link":"/apis/platform/platform-v1/record-alert-rule-sets","routeSlug":"/apis/platform/platform-v1/record-alert-rule-sets","items":[{"label":"Gets all of the record alert rule sets in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/record-alert-rule-sets/listrecordalertrulesets","routeSlug":"/apis/platform/platform-v1/record-alert-rule-sets/listrecordalertrulesets","metadata":{"seo":{"title":"Gets all of the record alert rule sets in the system.","description":"This method will scan all record alert rule sets and and return them to the caller."}},"httpPath":"/recordAlertRuleSets/{tenantId}"},{"label":"Creates a new record alert rule set record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/record-alert-rule-sets/createrecordalertruleset","routeSlug":"/apis/platform/platform-v1/record-alert-rule-sets/createrecordalertruleset","metadata":{"seo":{"title":"Creates a new record alert rule set record that does not already exist.","description":"This method will auto-generate an ID and create a new record alert rule set. If an ID is specified for the record alert rule set, an error will be thrown."}},"httpPath":"/recordAlertRuleSets/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/record-alert-rule-sets/executebatchoperations","routeSlug":"/apis/platform/platform-v1/record-alert-rule-sets/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/recordAlertRuleSets/{tenantId}/batch"},{"label":"Returns a record alert rule set from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/record-alert-rule-sets/deleterecordalertruleset","routeSlug":"/apis/platform/platform-v1/record-alert-rule-sets/deleterecordalertruleset","metadata":{"seo":{"title":"Returns a record alert rule set from the system by its ID.","description":"This method will delete a record alert rule set with the specified ID."}},"httpPath":"/recordAlertRuleSets/{tenantId}/{id}"},{"label":"Returns a record alert rule set from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/record-alert-rule-sets/getrecordalertruleset","routeSlug":"/apis/platform/platform-v1/record-alert-rule-sets/getrecordalertruleset","metadata":{"seo":{"title":"Returns a record alert rule set from the system by its ID.","description":"This method will look up a record alert rule set by the specified ID and return it back."}},"httpPath":"/recordAlertRuleSets/{tenantId}/{id}"},{"label":"Partially updates a record alert rule set with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/record-alert-rule-sets/patchrecordalertruleset","routeSlug":"/apis/platform/platform-v1/record-alert-rule-sets/patchrecordalertruleset","metadata":{"seo":{"title":"Partially updates a record alert rule set with the specified ID.","description":"This method will patch an existing record alert rule set with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/recordAlertRuleSets/{tenantId}/{id}"},{"label":"Updates a record alert rule set with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/record-alert-rule-sets/updaterecordalertruleset","routeSlug":"/apis/platform/platform-v1/record-alert-rule-sets/updaterecordalertruleset","metadata":{"seo":{"title":"Updates a record alert rule set with the specified ID.","description":"This method will update an existing record alert rule set with the specified ID."}},"httpPath":"/recordAlertRuleSets/{tenantId}/{id}"}]},{"type":"group","label":"Record Alerts","link":"/apis/platform/platform-v1/record-alerts","routeSlug":"/apis/platform/platform-v1/record-alerts","items":[{"label":"Gets all of the record alerts in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/record-alerts/listrecordalerts","routeSlug":"/apis/platform/platform-v1/record-alerts/listrecordalerts","metadata":{"seo":{"title":"Gets all of the record alerts in the system.","description":"This method will scan all record alerts and and return them to the caller."}},"httpPath":"/recordAlerts/{tenantId}"},{"label":"Creates a new record alert record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/record-alerts/createrecordalert","routeSlug":"/apis/platform/platform-v1/record-alerts/createrecordalert","metadata":{"seo":{"title":"Creates a new record alert record that does not already exist.","description":"This method will auto-generate an ID and create a new record alert. If an ID is specified for the record alert, an error will be thrown."}},"httpPath":"/recordAlerts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/record-alerts/executebatchoperations","routeSlug":"/apis/platform/platform-v1/record-alerts/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/recordAlerts/{tenantId}/batch"},{"label":"Returns a record alert from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/record-alerts/deleterecordalert","routeSlug":"/apis/platform/platform-v1/record-alerts/deleterecordalert","metadata":{"seo":{"title":"Returns a record alert from the system by its ID.","description":"This method will delete a record alert with the specified ID."}},"httpPath":"/recordAlerts/{tenantId}/{id}"},{"label":"Returns a record alert from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/record-alerts/getrecordalert","routeSlug":"/apis/platform/platform-v1/record-alerts/getrecordalert","metadata":{"seo":{"title":"Returns a record alert from the system by its ID.","description":"This method will look up a record alert by the specified ID and return it back."}},"httpPath":"/recordAlerts/{tenantId}/{id}"},{"label":"Partially updates a record alert with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/record-alerts/patchrecordalert","routeSlug":"/apis/platform/platform-v1/record-alerts/patchrecordalert","metadata":{"seo":{"title":"Partially updates a record alert with the specified ID.","description":"This method will patch an existing record alert with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/recordAlerts/{tenantId}/{id}"},{"label":"Updates a record alert with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/record-alerts/updaterecordalert","routeSlug":"/apis/platform/platform-v1/record-alerts/updaterecordalert","metadata":{"seo":{"title":"Updates a record alert with the specified ID.","description":"This method will update an existing record alert with the specified ID."}},"httpPath":"/recordAlerts/{tenantId}/{id}"}]},{"type":"group","label":"Saved Queries","link":"/apis/platform/platform-v1/saved-queries","routeSlug":"/apis/platform/platform-v1/saved-queries","items":[{"label":"Creates a new saved query record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/saved-queries/createsavedquery","routeSlug":"/apis/platform/platform-v1/saved-queries/createsavedquery","metadata":{"seo":{"title":"Creates a new saved query record that does not already exist.","description":"This method will auto-generate an ID and create a new saved query. If an ID is specified for the saved query, an error will be thrown."}},"httpPath":"/savedQueries/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/saved-queries/executebatchoperations","routeSlug":"/apis/platform/platform-v1/saved-queries/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/savedQueries/{tenantId}/batch"},{"label":"Returns a list of records with the specified file_cabinet_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/saved-queries/listqueriesbyfilecabinetid","routeSlug":"/apis/platform/platform-v1/saved-queries/listqueriesbyfilecabinetid","metadata":{"seo":{"title":"Returns a list of records with the specified file_cabinet_id","description":"Returns a list of records with the specified file_cabinet_id"}},"httpPath":"/savedQueries/{tenantId}/fileCabinet/{file_cabinet_id}"},{"label":"Returns a saved query from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/saved-queries/deletesavedquery","routeSlug":"/apis/platform/platform-v1/saved-queries/deletesavedquery","metadata":{"seo":{"title":"Returns a saved query from the system by its ID.","description":"This method will delete a saved query with the specified ID."}},"httpPath":"/savedQueries/{tenantId}/{id}"},{"label":"Returns a saved query from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/saved-queries/getsavedquery","routeSlug":"/apis/platform/platform-v1/saved-queries/getsavedquery","metadata":{"seo":{"title":"Returns a saved query from the system by its ID.","description":"This method will look up a saved query by the specified ID and return it back."}},"httpPath":"/savedQueries/{tenantId}/{id}"},{"label":"Partially updates a saved query with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/saved-queries/patchsavedquery","routeSlug":"/apis/platform/platform-v1/saved-queries/patchsavedquery","metadata":{"seo":{"title":"Partially updates a saved query with the specified ID.","description":"This method will patch an existing saved query with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/savedQueries/{tenantId}/{id}"},{"label":"Updates a saved query with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/saved-queries/updatesavedquery","routeSlug":"/apis/platform/platform-v1/saved-queries/updatesavedquery","metadata":{"seo":{"title":"Updates a saved query with the specified ID.","description":"This method will update an existing saved query with the specified ID."}},"httpPath":"/savedQueries/{tenantId}/{id}"}]},{"type":"group","label":"Saved Reports","link":"/apis/platform/platform-v1/saved-reports","routeSlug":"/apis/platform/platform-v1/saved-reports","items":[{"label":"Creates a new saved report record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/saved-reports/createsavedreport","routeSlug":"/apis/platform/platform-v1/saved-reports/createsavedreport","metadata":{"seo":{"title":"Creates a new saved report record that does not already exist.","description":"This method will auto-generate an ID and create a new saved report. If an ID is specified for the saved report, an error will be thrown."}},"httpPath":"/savedReports/{tenantId}"},{"label":"Returns a list of records with the specified app","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/saved-reports/listreportsbyapp","routeSlug":"/apis/platform/platform-v1/saved-reports/listreportsbyapp","metadata":{"seo":{"title":"Returns a list of records with the specified app","description":"Returns a list of records with the specified app"}},"httpPath":"/savedReports/{tenantId}/app/{app}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/saved-reports/executebatchoperations","routeSlug":"/apis/platform/platform-v1/saved-reports/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/savedReports/{tenantId}/batch"},{"label":"Returns a list of records with the specified report_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/saved-reports/listreportsbyreportid","routeSlug":"/apis/platform/platform-v1/saved-reports/listreportsbyreportid","metadata":{"seo":{"title":"Returns a list of records with the specified report_id","description":"Returns a list of records with the specified report_id"}},"httpPath":"/savedReports/{tenantId}/report/{report_id}"},{"label":"Returns a saved report from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/saved-reports/deletesavedreport","routeSlug":"/apis/platform/platform-v1/saved-reports/deletesavedreport","metadata":{"seo":{"title":"Returns a saved report from the system by its ID.","description":"This method will delete a saved report with the specified ID."}},"httpPath":"/savedReports/{tenantId}/{id}"},{"label":"Returns a saved report from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/saved-reports/getsavedreport","routeSlug":"/apis/platform/platform-v1/saved-reports/getsavedreport","metadata":{"seo":{"title":"Returns a saved report from the system by its ID.","description":"This method will look up a saved report by the specified ID and return it back."}},"httpPath":"/savedReports/{tenantId}/{id}"},{"label":"Partially updates a saved report with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/saved-reports/patchsavedreport","routeSlug":"/apis/platform/platform-v1/saved-reports/patchsavedreport","metadata":{"seo":{"title":"Partially updates a saved report with the specified ID.","description":"This method will patch an existing saved report with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/savedReports/{tenantId}/{id}"},{"label":"Updates a saved report with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/saved-reports/updatesavedreport","routeSlug":"/apis/platform/platform-v1/saved-reports/updatesavedreport","metadata":{"seo":{"title":"Updates a saved report with the specified ID.","description":"This method will update an existing saved report with the specified ID."}},"httpPath":"/savedReports/{tenantId}/{id}"}]},{"type":"group","label":"Saved Searches","link":"/apis/platform/platform-v1/saved-searches","routeSlug":"/apis/platform/platform-v1/saved-searches","items":[{"label":"Creates a new saved search record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/saved-searches/createsavedsearch","routeSlug":"/apis/platform/platform-v1/saved-searches/createsavedsearch","metadata":{"seo":{"title":"Creates a new saved search record that does not already exist.","description":"This method will auto-generate an ID and create a new saved search. If an ID is specified for the saved search, an error will be thrown."}},"httpPath":"/savedSearches/{tenantId}"},{"label":"Returns a list of records with the specified service_access_group","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/saved-searches/listallavailablesearchesforuser","routeSlug":"/apis/platform/platform-v1/saved-searches/listallavailablesearchesforuser","metadata":{"seo":{"title":"Returns a list of records with the specified service_access_group","description":"Returns a list of records with the specified service_access_group"}},"httpPath":"/savedSearches/{tenantId}/available/{service}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/saved-searches/executebatchoperations","routeSlug":"/apis/platform/platform-v1/saved-searches/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/savedSearches/{tenantId}/batch"},{"label":"Returns a saved search from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/saved-searches/deletesavedsearch","routeSlug":"/apis/platform/platform-v1/saved-searches/deletesavedsearch","metadata":{"seo":{"title":"Returns a saved search from the system by its ID.","description":"This method will delete a saved search with the specified ID."}},"httpPath":"/savedSearches/{tenantId}/{id}"},{"label":"Returns a saved search from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/saved-searches/getsavedsearch","routeSlug":"/apis/platform/platform-v1/saved-searches/getsavedsearch","metadata":{"seo":{"title":"Returns a saved search from the system by its ID.","description":"This method will look up a saved search by the specified ID and return it back."}},"httpPath":"/savedSearches/{tenantId}/{id}"},{"label":"Partially updates a saved search with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/saved-searches/patchsavedsearch","routeSlug":"/apis/platform/platform-v1/saved-searches/patchsavedsearch","metadata":{"seo":{"title":"Partially updates a saved search with the specified ID.","description":"This method will patch an existing saved search with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/savedSearches/{tenantId}/{id}"},{"label":"Updates a saved search with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/saved-searches/updatesavedsearch","routeSlug":"/apis/platform/platform-v1/saved-searches/updatesavedsearch","metadata":{"seo":{"title":"Updates a saved search with the specified ID.","description":"This method will update an existing saved search with the specified ID."}},"httpPath":"/savedSearches/{tenantId}/{id}"}]},{"type":"group","label":"Service Configurations","link":"/apis/platform/platform-v1/service-configurations","routeSlug":"/apis/platform/platform-v1/service-configurations","items":[{"label":"Gets all of the service configurations in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/service-configurations/listserviceconfigurations","routeSlug":"/apis/platform/platform-v1/service-configurations/listserviceconfigurations","metadata":{"seo":{"title":"Gets all of the service configurations in the system.","description":"This method will scan all service configurations and and return them to the caller."}},"httpPath":"/serviceConfigurations/{tenantId}"},{"label":"Creates a new service configuration record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/service-configurations/createserviceconfiguration","routeSlug":"/apis/platform/platform-v1/service-configurations/createserviceconfiguration","metadata":{"seo":{"title":"Creates a new service configuration record that does not already exist.","description":"This method will auto-generate an ID and create a new service configuration. If an ID is specified for the service configuration, an error will be thrown."}},"httpPath":"/serviceConfigurations/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/service-configurations/executebatchoperations","routeSlug":"/apis/platform/platform-v1/service-configurations/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/serviceConfigurations/{tenantId}/batch"},{"label":"Gets service metadata","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/service-configurations/getmicroservicemetadata","routeSlug":"/apis/platform/platform-v1/service-configurations/getmicroservicemetadata","metadata":{"seo":{"title":"Gets service metadata","description":"Returns information about fields for a service"}},"httpPath":"/serviceConfigurations/{tenantId}/metadata/{microservice}"},{"label":"Returns a service configuration from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/service-configurations/deleteserviceconfiguration","routeSlug":"/apis/platform/platform-v1/service-configurations/deleteserviceconfiguration","metadata":{"seo":{"title":"Returns a service configuration from the system by its ID.","description":"This method will delete a service configuration with the specified ID."}},"httpPath":"/serviceConfigurations/{tenantId}/{id}"},{"label":"Returns a service configuration from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/service-configurations/getserviceconfiguration","routeSlug":"/apis/platform/platform-v1/service-configurations/getserviceconfiguration","metadata":{"seo":{"title":"Returns a service configuration from the system by its ID.","description":"This method will look up a service configuration by the specified ID and return it back."}},"httpPath":"/serviceConfigurations/{tenantId}/{id}"},{"label":"Partially updates a service configuration with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/service-configurations/patchserviceconfiguration","routeSlug":"/apis/platform/platform-v1/service-configurations/patchserviceconfiguration","metadata":{"seo":{"title":"Partially updates a service configuration with the specified ID.","description":"This method will patch an existing service configuration with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/serviceConfigurations/{tenantId}/{id}"},{"label":"Updates a service configuration with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/service-configurations/updateserviceconfiguration","routeSlug":"/apis/platform/platform-v1/service-configurations/updateserviceconfiguration","metadata":{"seo":{"title":"Updates a service configuration with the specified ID.","description":"This method will update an existing service configuration with the specified ID."}},"httpPath":"/serviceConfigurations/{tenantId}/{id}"}]},{"type":"group","label":"Service Metadata","link":"/apis/platform/platform-v1/service-metadata","routeSlug":"/apis/platform/platform-v1/service-metadata","items":[{"label":"Gets all of the service metadata in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/service-metadata/listservicemetadata","routeSlug":"/apis/platform/platform-v1/service-metadata/listservicemetadata","metadata":{"seo":{"title":"Gets all of the service metadata in the system.","description":"This method will scan all service metadata and and return them to the caller."}},"httpPath":"/serviceMetadata/{tenantId}"},{"label":"Creates a new service metadatum record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/service-metadata/createservicemetadatum","routeSlug":"/apis/platform/platform-v1/service-metadata/createservicemetadatum","metadata":{"seo":{"title":"Creates a new service metadatum record that does not already exist.","description":"This method will auto-generate an ID and create a new service metadatum. If an ID is specified for the service metadatum, an error will be thrown."}},"httpPath":"/serviceMetadata/{tenantId}"},{"label":"Returns a service metadatum from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/service-metadata/deleteservicemetadatum","routeSlug":"/apis/platform/platform-v1/service-metadata/deleteservicemetadatum","metadata":{"seo":{"title":"Returns a service metadatum from the system by its ID.","description":"This method will delete a service metadatum with the specified ID."}},"httpPath":"/serviceMetadata/{tenantId}/{id}"},{"label":"Returns a service metadatum from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/service-metadata/getservicemetadatum","routeSlug":"/apis/platform/platform-v1/service-metadata/getservicemetadatum","metadata":{"seo":{"title":"Returns a service metadatum from the system by its ID.","description":"This method will look up a service metadatum by the specified ID and return it back."}},"httpPath":"/serviceMetadata/{tenantId}/{id}"},{"label":"Partially updates a service metadatum with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/service-metadata/patchservicemetadatum","routeSlug":"/apis/platform/platform-v1/service-metadata/patchservicemetadatum","metadata":{"seo":{"title":"Partially updates a service metadatum with the specified ID.","description":"This method will patch an existing service metadatum with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/serviceMetadata/{tenantId}/{id}"},{"label":"Updates a service metadatum with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/service-metadata/updateservicemetadatum","routeSlug":"/apis/platform/platform-v1/service-metadata/updateservicemetadatum","metadata":{"seo":{"title":"Updates a service metadatum with the specified ID.","description":"This method will update an existing service metadatum with the specified ID."}},"httpPath":"/serviceMetadata/{tenantId}/{id}"}]},{"type":"group","label":"Task Assignment Roles","link":"/apis/platform/platform-v1/task-assignment-roles","routeSlug":"/apis/platform/platform-v1/task-assignment-roles","items":[{"label":"Gets all of the task assignment roles in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/task-assignment-roles/listtaskassignmentroles","routeSlug":"/apis/platform/platform-v1/task-assignment-roles/listtaskassignmentroles","metadata":{"seo":{"title":"Gets all of the task assignment roles in the system.","description":"This method will scan all task assignment roles and and return them to the caller."}},"httpPath":"/taskAssignmentRoles/{tenantId}"},{"label":"Creates a new task assignment role record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/task-assignment-roles/createtaskassignmentrole","routeSlug":"/apis/platform/platform-v1/task-assignment-roles/createtaskassignmentrole","metadata":{"seo":{"title":"Creates a new task assignment role record that does not already exist.","description":"This method will auto-generate an ID and create a new task assignment role. If an ID is specified for the task assignment role, an error will be thrown."}},"httpPath":"/taskAssignmentRoles/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/task-assignment-roles/executebatchoperations","routeSlug":"/apis/platform/platform-v1/task-assignment-roles/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/taskAssignmentRoles/{tenantId}/batch"},{"label":"Returns a task assignment role from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/task-assignment-roles/deletetaskassignmentrole","routeSlug":"/apis/platform/platform-v1/task-assignment-roles/deletetaskassignmentrole","metadata":{"seo":{"title":"Returns a task assignment role from the system by its ID.","description":"This method will delete a task assignment role with the specified ID."}},"httpPath":"/taskAssignmentRoles/{tenantId}/{id}"},{"label":"Returns a task assignment role from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/task-assignment-roles/gettaskassignmentrole","routeSlug":"/apis/platform/platform-v1/task-assignment-roles/gettaskassignmentrole","metadata":{"seo":{"title":"Returns a task assignment role from the system by its ID.","description":"This method will look up a task assignment role by the specified ID and return it back."}},"httpPath":"/taskAssignmentRoles/{tenantId}/{id}"},{"label":"Partially updates a task assignment role with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/task-assignment-roles/patchtaskassignmentrole","routeSlug":"/apis/platform/platform-v1/task-assignment-roles/patchtaskassignmentrole","metadata":{"seo":{"title":"Partially updates a task assignment role with the specified ID.","description":"This method will patch an existing task assignment role with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/taskAssignmentRoles/{tenantId}/{id}"},{"label":"Updates a task assignment role with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/task-assignment-roles/updatetaskassignmentrole","routeSlug":"/apis/platform/platform-v1/task-assignment-roles/updatetaskassignmentrole","metadata":{"seo":{"title":"Updates a task assignment role with the specified ID.","description":"This method will update an existing task assignment role with the specified ID."}},"httpPath":"/taskAssignmentRoles/{tenantId}/{id}"}]},{"type":"group","label":"Task Queues","link":"/apis/platform/platform-v1/task-queues","routeSlug":"/apis/platform/platform-v1/task-queues","items":[{"label":"Gets all of the task queues in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/task-queues/listtaskqueues","routeSlug":"/apis/platform/platform-v1/task-queues/listtaskqueues","metadata":{"seo":{"title":"Gets all of the task queues in the system.","description":"This method will scan all task queues and and return them to the caller."}},"httpPath":"/taskQueues/{tenantId}"},{"label":"Creates a new task queue record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/task-queues/createtaskqueue","routeSlug":"/apis/platform/platform-v1/task-queues/createtaskqueue","metadata":{"seo":{"title":"Creates a new task queue record that does not already exist.","description":"This method will auto-generate an ID and create a new task queue. If an ID is specified for the task queue, an error will be thrown."}},"httpPath":"/taskQueues/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/task-queues/executebatchoperations","routeSlug":"/apis/platform/platform-v1/task-queues/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/taskQueues/{tenantId}/batch"},{"label":"Returns a task queue from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/task-queues/deletetaskqueue","routeSlug":"/apis/platform/platform-v1/task-queues/deletetaskqueue","metadata":{"seo":{"title":"Returns a task queue from the system by its ID.","description":"This method will delete a task queue with the specified ID."}},"httpPath":"/taskQueues/{tenantId}/{id}"},{"label":"Returns a task queue from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/task-queues/gettaskqueue","routeSlug":"/apis/platform/platform-v1/task-queues/gettaskqueue","metadata":{"seo":{"title":"Returns a task queue from the system by its ID.","description":"This method will look up a task queue by the specified ID and return it back."}},"httpPath":"/taskQueues/{tenantId}/{id}"},{"label":"Partially updates a task queue with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/task-queues/patchtaskqueue","routeSlug":"/apis/platform/platform-v1/task-queues/patchtaskqueue","metadata":{"seo":{"title":"Partially updates a task queue with the specified ID.","description":"This method will patch an existing task queue with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/taskQueues/{tenantId}/{id}"},{"label":"Updates a task queue with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/task-queues/updatetaskqueue","routeSlug":"/apis/platform/platform-v1/task-queues/updatetaskqueue","metadata":{"seo":{"title":"Updates a task queue with the specified ID.","description":"This method will update an existing task queue with the specified ID."}},"httpPath":"/taskQueues/{tenantId}/{id}"}]},{"type":"group","label":"Task Types","link":"/apis/platform/platform-v1/task-types","routeSlug":"/apis/platform/platform-v1/task-types","items":[{"label":"Gets all of the task types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/task-types/listtasktypes","routeSlug":"/apis/platform/platform-v1/task-types/listtasktypes","metadata":{"seo":{"title":"Gets all of the task types in the system.","description":"This method will scan all task types and and return them to the caller."}},"httpPath":"/taskTypes/{tenantId}"},{"label":"Creates a new task type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/task-types/createtasktype","routeSlug":"/apis/platform/platform-v1/task-types/createtasktype","metadata":{"seo":{"title":"Creates a new task type record that does not already exist.","description":"This method will auto-generate an ID and create a new task type. If an ID is specified for the task type, an error will be thrown."}},"httpPath":"/taskTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/task-types/executebatchoperations","routeSlug":"/apis/platform/platform-v1/task-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/taskTypes/{tenantId}/batch"},{"label":"Returns a task type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/task-types/deletetasktype","routeSlug":"/apis/platform/platform-v1/task-types/deletetasktype","metadata":{"seo":{"title":"Returns a task type from the system by its ID.","description":"This method will delete a task type with the specified ID."}},"httpPath":"/taskTypes/{tenantId}/{id}"},{"label":"Returns a task type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/task-types/gettasktype","routeSlug":"/apis/platform/platform-v1/task-types/gettasktype","metadata":{"seo":{"title":"Returns a task type from the system by its ID.","description":"This method will look up a task type by the specified ID and return it back."}},"httpPath":"/taskTypes/{tenantId}/{id}"},{"label":"Partially updates a task type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/task-types/patchtasktype","routeSlug":"/apis/platform/platform-v1/task-types/patchtasktype","metadata":{"seo":{"title":"Partially updates a task type with the specified ID.","description":"This method will patch an existing task type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/taskTypes/{tenantId}/{id}"},{"label":"Updates a task type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/task-types/updatetasktype","routeSlug":"/apis/platform/platform-v1/task-types/updatetasktype","metadata":{"seo":{"title":"Updates a task type with the specified ID.","description":"This method will update an existing task type with the specified ID."}},"httpPath":"/taskTypes/{tenantId}/{id}"}]},{"type":"group","label":"Tasks","link":"/apis/platform/platform-v1/tasks","routeSlug":"/apis/platform/platform-v1/tasks","items":[{"label":"Creates a new task record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/tasks/createtask","routeSlug":"/apis/platform/platform-v1/tasks/createtask","metadata":{"seo":{"title":"Creates a new task record that does not already exist.","description":"This method will auto-generate an ID and create a new task. If an ID is specified for the task, an error will be thrown."}},"httpPath":"/tasks/{tenantId}"},{"label":"Returns a list of records with the specified assignee_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/tasks/listtasksbyassigneeid","routeSlug":"/apis/platform/platform-v1/tasks/listtasksbyassigneeid","metadata":{"seo":{"title":"Returns a list of records with the specified assignee_id","description":"Returns a list of records with the specified assignee_id"}},"httpPath":"/tasks/{tenantId}/assignee/{assignee_id}"},{"label":"Returns a list of records with the specified associated_contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/tasks/listtasksbyassociatedcontactid","routeSlug":"/apis/platform/platform-v1/tasks/listtasksbyassociatedcontactid","metadata":{"seo":{"title":"Returns a list of records with the specified associated_contact_id","description":"Returns a list of records with the specified associated_contact_id"}},"httpPath":"/tasks/{tenantId}/associatedContact/{associated_contact_id}"},{"label":"Returns a list of records with the specified associated_organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/tasks/listtasksbyassociatedorganizationid","routeSlug":"/apis/platform/platform-v1/tasks/listtasksbyassociatedorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified associated_organization_id","description":"Returns a list of records with the specified associated_organization_id"}},"httpPath":"/tasks/{tenantId}/associatedOrganization/{associated_organization_id}"},{"label":"Returns a list of records with the specified sys_search_associated_record_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/tasks/listtasksbyassociatedrecordid","routeSlug":"/apis/platform/platform-v1/tasks/listtasksbyassociatedrecordid","metadata":{"seo":{"title":"Returns a list of records with the specified sys_search_associated_record_id","description":"Returns a list of records with the specified sys_search_associated_record_id"}},"httpPath":"/tasks/{tenantId}/associatedRecord/{service}/{record_id}"},{"label":"Returns a list of records with the specified owner_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/tasks/listtasksbyownerid","routeSlug":"/apis/platform/platform-v1/tasks/listtasksbyownerid","metadata":{"seo":{"title":"Returns a list of records with the specified owner_id","description":"Returns a list of records with the specified owner_id"}},"httpPath":"/tasks/{tenantId}/owner/{owner_id}"},{"label":"Returns a list of records with the specified queue_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/tasks/listtasksbyqueueid","routeSlug":"/apis/platform/platform-v1/tasks/listtasksbyqueueid","metadata":{"seo":{"title":"Returns a list of records with the specified queue_id","description":"Returns a list of records with the specified queue_id"}},"httpPath":"/tasks/{tenantId}/queue/{queue_id}"},{"label":"Searches for tasks using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/tasks/searchfortasks","routeSlug":"/apis/platform/platform-v1/tasks/searchfortasks","metadata":{"seo":{"title":"Searches for tasks using predefined parameters","description":"Searches for tasks using predefined parameters"}},"httpPath":"/tasks/{tenantId}/search"},{"label":"Returns a list of records with the specified task_group_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/tasks/listtasksbytaskgroupid","routeSlug":"/apis/platform/platform-v1/tasks/listtasksbytaskgroupid","metadata":{"seo":{"title":"Returns a list of records with the specified task_group_id","description":"Returns a list of records with the specified task_group_id"}},"httpPath":"/tasks/{tenantId}/taskGroup/{task_group_id}"},{"label":"Returns a task from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/tasks/deletetask","routeSlug":"/apis/platform/platform-v1/tasks/deletetask","metadata":{"seo":{"title":"Returns a task from the system by its ID.","description":"This method will delete a task with the specified ID."}},"httpPath":"/tasks/{tenantId}/{id}"},{"label":"Returns a task from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/tasks/gettask","routeSlug":"/apis/platform/platform-v1/tasks/gettask","metadata":{"seo":{"title":"Returns a task from the system by its ID.","description":"This method will look up a task by the specified ID and return it back."}},"httpPath":"/tasks/{tenantId}/{id}"},{"label":"Partially updates a task with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/tasks/patchtask","routeSlug":"/apis/platform/platform-v1/tasks/patchtask","metadata":{"seo":{"title":"Partially updates a task with the specified ID.","description":"This method will patch an existing task with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/tasks/{tenantId}/{id}"},{"label":"Updates a task with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/tasks/updatetask","routeSlug":"/apis/platform/platform-v1/tasks/updatetask","metadata":{"seo":{"title":"Updates a task with the specified ID.","description":"This method will update an existing task with the specified ID."}},"httpPath":"/tasks/{tenantId}/{id}"}]},{"type":"group","label":"Web Form Drafts","link":"/apis/platform/platform-v1/web-form-drafts","routeSlug":"/apis/platform/platform-v1/web-form-drafts","items":[{"label":"Creates a new web form draft record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/web-form-drafts/createwebformdraft","routeSlug":"/apis/platform/platform-v1/web-form-drafts/createwebformdraft","metadata":{"seo":{"title":"Creates a new web form draft record that does not already exist.","description":"This method will auto-generate an ID and create a new web form draft. If an ID is specified for the web form draft, an error will be thrown."}},"httpPath":"/webFormDrafts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/web-form-drafts/executebatchoperations","routeSlug":"/apis/platform/platform-v1/web-form-drafts/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/webFormDrafts/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_service_context_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/web-form-drafts/listdraftsbycontactservicecontextid","routeSlug":"/apis/platform/platform-v1/web-form-drafts/listdraftsbycontactservicecontextid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_service_context_id","description":"Returns a list of records with the specified contact_service_context_id"}},"httpPath":"/webFormDrafts/{tenantId}/contactServiceContext/{service}/{contactId}"},{"label":"Returns a web form draft from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/web-form-drafts/deletewebformdraft","routeSlug":"/apis/platform/platform-v1/web-form-drafts/deletewebformdraft","metadata":{"seo":{"title":"Returns a web form draft from the system by its ID.","description":"This method will delete a web form draft with the specified ID."}},"httpPath":"/webFormDrafts/{tenantId}/{id}"},{"label":"Returns a web form draft from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/web-form-drafts/getwebformdraft","routeSlug":"/apis/platform/platform-v1/web-form-drafts/getwebformdraft","metadata":{"seo":{"title":"Returns a web form draft from the system by its ID.","description":"This method will look up a web form draft by the specified ID and return it back."}},"httpPath":"/webFormDrafts/{tenantId}/{id}"},{"label":"Partially updates a web form draft with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/web-form-drafts/patchwebformdraft","routeSlug":"/apis/platform/platform-v1/web-form-drafts/patchwebformdraft","metadata":{"seo":{"title":"Partially updates a web form draft with the specified ID.","description":"This method will patch an existing web form draft with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/webFormDrafts/{tenantId}/{id}"},{"label":"Updates a web form draft with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/web-form-drafts/updatewebformdraft","routeSlug":"/apis/platform/platform-v1/web-form-drafts/updatewebformdraft","metadata":{"seo":{"title":"Updates a web form draft with the specified ID.","description":"This method will update an existing web form draft with the specified ID."}},"httpPath":"/webFormDrafts/{tenantId}/{id}"}]},{"type":"group","label":"Web Forms","link":"/apis/platform/platform-v1/web-forms","routeSlug":"/apis/platform/platform-v1/web-forms","items":[{"label":"Gets all of the web forms in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/web-forms/listwebforms","routeSlug":"/apis/platform/platform-v1/web-forms/listwebforms","metadata":{"seo":{"title":"Gets all of the web forms in the system.","description":"This method will scan all web forms and and return them to the caller."}},"httpPath":"/webForms/{tenantId}"},{"label":"Creates a new web form record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/web-forms/createwebform","routeSlug":"/apis/platform/platform-v1/web-forms/createwebform","metadata":{"seo":{"title":"Creates a new web form record that does not already exist.","description":"This method will auto-generate an ID and create a new web form. If an ID is specified for the web form, an error will be thrown."}},"httpPath":"/webForms/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/web-forms/executebatchoperations","routeSlug":"/apis/platform/platform-v1/web-forms/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/webForms/{tenantId}/batch"},{"label":"Returns a list of records with the specified service","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/web-forms/listformsbyservice","routeSlug":"/apis/platform/platform-v1/web-forms/listformsbyservice","metadata":{"seo":{"title":"Returns a list of records with the specified service","description":"Returns a list of records with the specified service"}},"httpPath":"/webForms/{tenantId}/service/{service}"},{"label":"Returns a web form from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/web-forms/deletewebform","routeSlug":"/apis/platform/platform-v1/web-forms/deletewebform","metadata":{"seo":{"title":"Returns a web form from the system by its ID.","description":"This method will delete a web form with the specified ID."}},"httpPath":"/webForms/{tenantId}/{id}"},{"label":"Returns a web form from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/web-forms/getwebform","routeSlug":"/apis/platform/platform-v1/web-forms/getwebform","metadata":{"seo":{"title":"Returns a web form from the system by its ID.","description":"This method will look up a web form by the specified ID and return it back."}},"httpPath":"/webForms/{tenantId}/{id}"},{"label":"Partially updates a web form with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/web-forms/patchwebform","routeSlug":"/apis/platform/platform-v1/web-forms/patchwebform","metadata":{"seo":{"title":"Partially updates a web form with the specified ID.","description":"This method will patch an existing web form with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/webForms/{tenantId}/{id}"},{"label":"Updates a web form with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/web-forms/updatewebform","routeSlug":"/apis/platform/platform-v1/web-forms/updatewebform","metadata":{"seo":{"title":"Updates a web form with the specified ID.","description":"This method will update an existing web form with the specified ID."}},"httpPath":"/webForms/{tenantId}/{id}"}]},{"type":"group","label":"Workflows","link":"/apis/platform/platform-v1/workflows","routeSlug":"/apis/platform/platform-v1/workflows","items":[{"label":"Creates a new workflow record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/workflows/createworkflow","routeSlug":"/apis/platform/platform-v1/workflows/createworkflow","metadata":{"seo":{"title":"Creates a new workflow record that does not already exist.","description":"This method will auto-generate an ID and create a new workflow. If an ID is specified for the workflow, an error will be thrown."}},"httpPath":"/workflows/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/workflows/executebatchoperations","routeSlug":"/apis/platform/platform-v1/workflows/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/workflows/{tenantId}/batch"},{"label":"Returns a workflow from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/workflows/deleteworkflow","routeSlug":"/apis/platform/platform-v1/workflows/deleteworkflow","metadata":{"seo":{"title":"Returns a workflow from the system by its ID.","description":"This method will delete a workflow with the specified ID."}},"httpPath":"/workflows/{tenantId}/{id}"},{"label":"Returns a workflow from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/workflows/getworkflow","routeSlug":"/apis/platform/platform-v1/workflows/getworkflow","metadata":{"seo":{"title":"Returns a workflow from the system by its ID.","description":"This method will look up a workflow by the specified ID and return it back."}},"httpPath":"/workflows/{tenantId}/{id}"},{"label":"Partially updates a workflow with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/workflows/patchworkflow","routeSlug":"/apis/platform/platform-v1/workflows/patchworkflow","metadata":{"seo":{"title":"Partially updates a workflow with the specified ID.","description":"This method will patch an existing workflow with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/workflows/{tenantId}/{id}"},{"label":"Updates a workflow with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/platform/platform-v1/workflows/updateworkflow","routeSlug":"/apis/platform/platform-v1/workflows/updateworkflow","metadata":{"seo":{"title":"Updates a workflow with the specified ID.","description":"This method will update an existing workflow with the specified ID."}},"httpPath":"/workflows/{tenantId}/{id}"}]}]},{"type":"group","label":"Rolodex","items":[{"type":"link","label":"Rolodex (Contacts & Organizations)","link":"/apis/rolodex/rolodex-v1","routeSlug":"/apis/rolodex/rolodex-v1"},{"type":"group","label":"Account Delegation Processes","link":"/apis/rolodex/rolodex-v1/account-delegation-processes","routeSlug":"/apis/rolodex/rolodex-v1/account-delegation-processes","items":[{"label":"Gets all of the account delegation processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/account-delegation-processes/listaccountdelegationprocesses","routeSlug":"/apis/rolodex/rolodex-v1/account-delegation-processes/listaccountdelegationprocesses","metadata":{"seo":{"title":"Gets all of the account delegation processes in the system.","description":"This method will scan all account delegation processes and and return them to the caller."}},"httpPath":"/accountDelegationProcesses/{tenantId}"},{"label":"Creates a new account delegation process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/account-delegation-processes/createaccountdelegationprocess","routeSlug":"/apis/rolodex/rolodex-v1/account-delegation-processes/createaccountdelegationprocess","metadata":{"seo":{"title":"Creates a new account delegation process record that does not already exist.","description":"This method will auto-generate an ID and create a new account delegation process. If an ID is specified for the account delegation process, an error will be thrown."}},"httpPath":"/accountDelegationProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/account-delegation-processes/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/account-delegation-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/accountDelegationProcesses/{tenantId}/batch"},{"label":"Returns a account delegation process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/account-delegation-processes/deleteaccountdelegationprocess","routeSlug":"/apis/rolodex/rolodex-v1/account-delegation-processes/deleteaccountdelegationprocess","metadata":{"seo":{"title":"Returns a account delegation process from the system by its ID.","description":"This method will delete a account delegation process with the specified ID."}},"httpPath":"/accountDelegationProcesses/{tenantId}/{id}"},{"label":"Returns a account delegation process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/account-delegation-processes/getaccountdelegationprocess","routeSlug":"/apis/rolodex/rolodex-v1/account-delegation-processes/getaccountdelegationprocess","metadata":{"seo":{"title":"Returns a account delegation process from the system by its ID.","description":"This method will look up a account delegation process by the specified ID and return it back."}},"httpPath":"/accountDelegationProcesses/{tenantId}/{id}"},{"label":"Partially updates a account delegation process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/account-delegation-processes/patchaccountdelegationprocess","routeSlug":"/apis/rolodex/rolodex-v1/account-delegation-processes/patchaccountdelegationprocess","metadata":{"seo":{"title":"Partially updates a account delegation process with the specified ID.","description":"This method will patch an existing account delegation process with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/accountDelegationProcesses/{tenantId}/{id}"},{"label":"Updates a account delegation process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/account-delegation-processes/updateaccountdelegationprocess","routeSlug":"/apis/rolodex/rolodex-v1/account-delegation-processes/updateaccountdelegationprocess","metadata":{"seo":{"title":"Updates a account delegation process with the specified ID.","description":"This method will update an existing account delegation process with the specified ID."}},"httpPath":"/accountDelegationProcesses/{tenantId}/{id}"}]},{"type":"group","label":"Address Types","link":"/apis/rolodex/rolodex-v1/address-types","routeSlug":"/apis/rolodex/rolodex-v1/address-types","items":[{"label":"Gets all of the address types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/address-types/listaddresstypes","routeSlug":"/apis/rolodex/rolodex-v1/address-types/listaddresstypes","metadata":{"seo":{"title":"Gets all of the address types in the system.","description":"This method will scan all address types and and return them to the caller."}},"httpPath":"/addressTypes/{tenantId}"},{"label":"Creates a new address type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/address-types/createaddresstype","routeSlug":"/apis/rolodex/rolodex-v1/address-types/createaddresstype","metadata":{"seo":{"title":"Creates a new address type record that does not already exist.","description":"This method will auto-generate an ID and create a new address type. If an ID is specified for the address type, an error will be thrown."}},"httpPath":"/addressTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/address-types/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/address-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/addressTypes/{tenantId}/batch"},{"label":"Returns a address type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/address-types/deleteaddresstype","routeSlug":"/apis/rolodex/rolodex-v1/address-types/deleteaddresstype","metadata":{"seo":{"title":"Returns a address type from the system by its ID.","description":"This method will delete a address type with the specified ID."}},"httpPath":"/addressTypes/{tenantId}/{id}"},{"label":"Returns a address type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/address-types/getaddresstype","routeSlug":"/apis/rolodex/rolodex-v1/address-types/getaddresstype","metadata":{"seo":{"title":"Returns a address type from the system by its ID.","description":"This method will look up a address type by the specified ID and return it back."}},"httpPath":"/addressTypes/{tenantId}/{id}"},{"label":"Partially updates a address type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/address-types/patchaddresstype","routeSlug":"/apis/rolodex/rolodex-v1/address-types/patchaddresstype","metadata":{"seo":{"title":"Partially updates a address type with the specified ID.","description":"This method will patch an existing address type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/addressTypes/{tenantId}/{id}"},{"label":"Updates a address type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/address-types/updateaddresstype","routeSlug":"/apis/rolodex/rolodex-v1/address-types/updateaddresstype","metadata":{"seo":{"title":"Updates a address type with the specified ID.","description":"This method will update an existing address type with the specified ID."}},"httpPath":"/addressTypes/{tenantId}/{id}"}]},{"type":"group","label":"Communication Types","link":"/apis/rolodex/rolodex-v1/communication-types","routeSlug":"/apis/rolodex/rolodex-v1/communication-types","items":[{"label":"Gets all of the communication types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/communication-types/listcommunicationtypes","routeSlug":"/apis/rolodex/rolodex-v1/communication-types/listcommunicationtypes","metadata":{"seo":{"title":"Gets all of the communication types in the system.","description":"This method will scan all communication types and and return them to the caller."}},"httpPath":"/communicationTypes/{tenantId}"},{"label":"Creates a new communication type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/communication-types/createcommunicationtype","routeSlug":"/apis/rolodex/rolodex-v1/communication-types/createcommunicationtype","metadata":{"seo":{"title":"Creates a new communication type record that does not already exist.","description":"This method will auto-generate an ID and create a new communication type. If an ID is specified for the communication type, an error will be thrown."}},"httpPath":"/communicationTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/communication-types/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/communication-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/communicationTypes/{tenantId}/batch"},{"label":"Returns a communication type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/communication-types/deletecommunicationtype","routeSlug":"/apis/rolodex/rolodex-v1/communication-types/deletecommunicationtype","metadata":{"seo":{"title":"Returns a communication type from the system by its ID.","description":"This method will delete a communication type with the specified ID."}},"httpPath":"/communicationTypes/{tenantId}/{id}"},{"label":"Returns a communication type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/communication-types/getcommunicationtype","routeSlug":"/apis/rolodex/rolodex-v1/communication-types/getcommunicationtype","metadata":{"seo":{"title":"Returns a communication type from the system by its ID.","description":"This method will look up a communication type by the specified ID and return it back."}},"httpPath":"/communicationTypes/{tenantId}/{id}"},{"label":"Partially updates a communication type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/communication-types/patchcommunicationtype","routeSlug":"/apis/rolodex/rolodex-v1/communication-types/patchcommunicationtype","metadata":{"seo":{"title":"Partially updates a communication type with the specified ID.","description":"This method will patch an existing communication type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/communicationTypes/{tenantId}/{id}"},{"label":"Updates a communication type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/communication-types/updatecommunicationtype","routeSlug":"/apis/rolodex/rolodex-v1/communication-types/updatecommunicationtype","metadata":{"seo":{"title":"Updates a communication type with the specified ID.","description":"This method will update an existing communication type with the specified ID."}},"httpPath":"/communicationTypes/{tenantId}/{id}"}]},{"type":"group","label":"Contact Directories","link":"/apis/rolodex/rolodex-v1/contact-directories","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories","items":[{"label":"Gets all of the contact directories in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/listcontactdirectories","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/listcontactdirectories","metadata":{"seo":{"title":"Gets all of the contact directories in the system.","description":"This method will scan all contact directories and and return them to the caller."}},"httpPath":"/contactDirectories/{tenantId}"},{"label":"Creates a new contact directory record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/createcontactdirectory","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/createcontactdirectory","metadata":{"seo":{"title":"Creates a new contact directory record that does not already exist.","description":"This method will auto-generate an ID and create a new contact directory. If an ID is specified for the contact directory, an error will be thrown."}},"httpPath":"/contactDirectories/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/contactDirectories/{tenantId}/batch"},{"label":"Gets an entry in the directory","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/getdirectoryentry","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/getdirectoryentry","metadata":{"seo":{"title":"Gets an entry in the directory","description":"Gets an entry in the directory"}},"httpPath":"/contactDirectories/{tenantId}/public/entry/{id}/{entryId}"},{"label":"Searches the directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/searchpublicdirectory","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/searchpublicdirectory","metadata":{"seo":{"title":"Searches the directory","description":"Searches the directory"}},"httpPath":"/contactDirectories/{tenantId}/public/search/{id}"},{"label":"Sends a message to an entry in the directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/senddirectorymessage","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/senddirectorymessage","metadata":{"seo":{"title":"Sends a message to an entry in the directory","description":"Sends a message to an entry in the directory"}},"httpPath":"/contactDirectories/{tenantId}/public/sendMessage/{directoryId}/{entryId}"},{"label":"Returns a contact directory from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/getpublicdirectory","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/getpublicdirectory","metadata":{"seo":{"title":"Returns a contact directory from the system by its ID.","description":"This method will look up a contact directory by the specified ID and return it back."}},"httpPath":"/contactDirectories/{tenantId}/public/{id}"},{"label":"Searches the directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/searchdirectory","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/searchdirectory","metadata":{"seo":{"title":"Searches the directory","description":"Searches the directory"}},"httpPath":"/contactDirectories/{tenantId}/search/{id}"},{"label":"Returns a contact directory from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/deletecontactdirectory","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/deletecontactdirectory","metadata":{"seo":{"title":"Returns a contact directory from the system by its ID.","description":"This method will delete a contact directory with the specified ID."}},"httpPath":"/contactDirectories/{tenantId}/{id}"},{"label":"Returns a contact directory from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/getcontactdirectory","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/getcontactdirectory","metadata":{"seo":{"title":"Returns a contact directory from the system by its ID.","description":"This method will look up a contact directory by the specified ID and return it back."}},"httpPath":"/contactDirectories/{tenantId}/{id}"},{"label":"Partially updates a contact directory with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/patchcontactdirectory","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/patchcontactdirectory","metadata":{"seo":{"title":"Partially updates a contact directory with the specified ID.","description":"This method will patch an existing contact directory with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/contactDirectories/{tenantId}/{id}"},{"label":"Updates a contact directory with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-directories/updatecontactdirectory","routeSlug":"/apis/rolodex/rolodex-v1/contact-directories/updatecontactdirectory","metadata":{"seo":{"title":"Updates a contact directory with the specified ID.","description":"This method will update an existing contact directory with the specified ID."}},"httpPath":"/contactDirectories/{tenantId}/{id}"}]},{"type":"group","label":"Contact Districts","link":"/apis/rolodex/rolodex-v1/contact-districts","routeSlug":"/apis/rolodex/rolodex-v1/contact-districts","items":[{"label":"Creates a new contact district record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-districts/createcontactdistrict","routeSlug":"/apis/rolodex/rolodex-v1/contact-districts/createcontactdistrict","metadata":{"seo":{"title":"Creates a new contact district record that does not already exist.","description":"This method will auto-generate an ID and create a new contact district. If an ID is specified for the contact district, an error will be thrown."}},"httpPath":"/contactDistricts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-districts/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/contact-districts/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/contactDistricts/{tenantId}/batch"},{"label":"Returns a contact district from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-districts/deletecontactdistrict","routeSlug":"/apis/rolodex/rolodex-v1/contact-districts/deletecontactdistrict","metadata":{"seo":{"title":"Returns a contact district from the system by its ID.","description":"This method will delete a contact district with the specified ID."}},"httpPath":"/contactDistricts/{tenantId}/{id}"},{"label":"Returns a contact district from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-districts/getcontactdistrict","routeSlug":"/apis/rolodex/rolodex-v1/contact-districts/getcontactdistrict","metadata":{"seo":{"title":"Returns a contact district from the system by its ID.","description":"This method will look up a contact district by the specified ID and return it back."}},"httpPath":"/contactDistricts/{tenantId}/{id}"},{"label":"Partially updates a contact district with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-districts/patchcontactdistrict","routeSlug":"/apis/rolodex/rolodex-v1/contact-districts/patchcontactdistrict","metadata":{"seo":{"title":"Partially updates a contact district with the specified ID.","description":"This method will patch an existing contact district with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/contactDistricts/{tenantId}/{id}"},{"label":"Updates a contact district with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-districts/updatecontactdistrict","routeSlug":"/apis/rolodex/rolodex-v1/contact-districts/updatecontactdistrict","metadata":{"seo":{"title":"Updates a contact district with the specified ID.","description":"This method will update an existing contact district with the specified ID."}},"httpPath":"/contactDistricts/{tenantId}/{id}"}]},{"type":"group","label":"Contact Duplicates","link":"/apis/rolodex/rolodex-v1/contact-duplicates","routeSlug":"/apis/rolodex/rolodex-v1/contact-duplicates","items":[{"label":"Gets all of the contact duplicates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-duplicates/listcontactduplicates","routeSlug":"/apis/rolodex/rolodex-v1/contact-duplicates/listcontactduplicates","metadata":{"seo":{"title":"Gets all of the contact duplicates in the system.","description":"This method will scan all contact duplicates and and return them to the caller."}},"httpPath":"/contactDuplicates/{tenantId}"},{"label":"Search for potential duplicates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-duplicates/duplicatecheck","routeSlug":"/apis/rolodex/rolodex-v1/contact-duplicates/duplicatecheck","metadata":{"seo":{"title":"Search for potential duplicates","description":"This method searches for potential duplicates"}},"httpPath":"/contactDuplicates/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-duplicates/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/contact-duplicates/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/contactDuplicates/{tenantId}/batch"},{"label":"Search for potential duplicates in the portal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-duplicates/portalduplicatecheck","routeSlug":"/apis/rolodex/rolodex-v1/contact-duplicates/portalduplicatecheck","metadata":{"seo":{"title":"Search for potential duplicates in the portal","description":"This method searches for potential duplicates and returns masked validation options"}},"httpPath":"/contactDuplicates/{tenantId}/portal"},{"label":"Returns a contact duplicate from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-duplicates/getcontactduplicate","routeSlug":"/apis/rolodex/rolodex-v1/contact-duplicates/getcontactduplicate","metadata":{"seo":{"title":"Returns a contact duplicate from the system by its ID.","description":"This method will look up a contact duplicate by the specified ID and return it back."}},"httpPath":"/contactDuplicates/{tenantId}/{id}"},{"label":"Partially updates a contact duplicate with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-duplicates/patchcontactduplicate","routeSlug":"/apis/rolodex/rolodex-v1/contact-duplicates/patchcontactduplicate","metadata":{"seo":{"title":"Partially updates a contact duplicate with the specified ID.","description":"This method will patch an existing contact duplicate with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/contactDuplicates/{tenantId}/{id}"},{"label":"Updates a contact duplicate with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-duplicates/updatecontactduplicate","routeSlug":"/apis/rolodex/rolodex-v1/contact-duplicates/updatecontactduplicate","metadata":{"seo":{"title":"Updates a contact duplicate with the specified ID.","description":"This method will update an existing contact duplicate with the specified ID."}},"httpPath":"/contactDuplicates/{tenantId}/{id}"}]},{"type":"group","label":"Contact Login Profiles","link":"/apis/rolodex/rolodex-v1/contact-login-profiles","routeSlug":"/apis/rolodex/rolodex-v1/contact-login-profiles","items":[{"label":"Creates a new contact login profile record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-login-profiles/createcontactloginprofile","routeSlug":"/apis/rolodex/rolodex-v1/contact-login-profiles/createcontactloginprofile","metadata":{"seo":{"title":"Creates a new contact login profile record that does not already exist.","description":"This method will auto-generate an ID and create a new contact login profile. If an ID is specified for the contact login profile, an error will be thrown."}},"httpPath":"/contactLoginProfiles/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-login-profiles/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/contact-login-profiles/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/contactLoginProfiles/{tenantId}/batch"},{"label":"Returns a contact login profile from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-login-profiles/deletecontactloginprofile","routeSlug":"/apis/rolodex/rolodex-v1/contact-login-profiles/deletecontactloginprofile","metadata":{"seo":{"title":"Returns a contact login profile from the system by its ID.","description":"This method will delete a contact login profile with the specified ID."}},"httpPath":"/contactLoginProfiles/{tenantId}/{id}"},{"label":"Returns a contact login profile from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-login-profiles/getcontactloginprofile","routeSlug":"/apis/rolodex/rolodex-v1/contact-login-profiles/getcontactloginprofile","metadata":{"seo":{"title":"Returns a contact login profile from the system by its ID.","description":"This method will look up a contact login profile by the specified ID and return it back."}},"httpPath":"/contactLoginProfiles/{tenantId}/{id}"},{"label":"Partially updates a contact login profile with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-login-profiles/patchcontactloginprofile","routeSlug":"/apis/rolodex/rolodex-v1/contact-login-profiles/patchcontactloginprofile","metadata":{"seo":{"title":"Partially updates a contact login profile with the specified ID.","description":"This method will patch an existing contact login profile with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/contactLoginProfiles/{tenantId}/{id}"},{"label":"Updates a contact login profile with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-login-profiles/updatecontactloginprofile","routeSlug":"/apis/rolodex/rolodex-v1/contact-login-profiles/updatecontactloginprofile","metadata":{"seo":{"title":"Updates a contact login profile with the specified ID.","description":"This method will update an existing contact login profile with the specified ID."}},"httpPath":"/contactLoginProfiles/{tenantId}/{id}"}]},{"type":"group","label":"Contact Role Rule Sets","link":"/apis/rolodex/rolodex-v1/contact-role-rule-sets","routeSlug":"/apis/rolodex/rolodex-v1/contact-role-rule-sets","items":[{"label":"Gets all of the contact role rule sets in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/listcontactrolerulesets","routeSlug":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/listcontactrolerulesets","metadata":{"seo":{"title":"Gets all of the contact role rule sets in the system.","description":"This method will scan all contact role rule sets and and return them to the caller."}},"httpPath":"/contactRoleRuleSets/{tenantId}"},{"label":"Creates a new contact role rule set record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/createcontactroleruleset","routeSlug":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/createcontactroleruleset","metadata":{"seo":{"title":"Creates a new contact role rule set record that does not already exist.","description":"This method will auto-generate an ID and create a new contact role rule set. If an ID is specified for the contact role rule set, an error will be thrown."}},"httpPath":"/contactRoleRuleSets/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/contactRoleRuleSets/{tenantId}/batch"},{"label":"Returns a contact role rule set from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/deletecontactroleruleset","routeSlug":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/deletecontactroleruleset","metadata":{"seo":{"title":"Returns a contact role rule set from the system by its ID.","description":"This method will delete a contact role rule set with the specified ID."}},"httpPath":"/contactRoleRuleSets/{tenantId}/{id}"},{"label":"Returns a contact role rule set from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/getcontactroleruleset","routeSlug":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/getcontactroleruleset","metadata":{"seo":{"title":"Returns a contact role rule set from the system by its ID.","description":"This method will look up a contact role rule set by the specified ID and return it back."}},"httpPath":"/contactRoleRuleSets/{tenantId}/{id}"},{"label":"Partially updates a contact role rule set with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/patchcontactroleruleset","routeSlug":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/patchcontactroleruleset","metadata":{"seo":{"title":"Partially updates a contact role rule set with the specified ID.","description":"This method will patch an existing contact role rule set with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/contactRoleRuleSets/{tenantId}/{id}"},{"label":"Updates a contact role rule set with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/updatecontactroleruleset","routeSlug":"/apis/rolodex/rolodex-v1/contact-role-rule-sets/updatecontactroleruleset","metadata":{"seo":{"title":"Updates a contact role rule set with the specified ID.","description":"This method will update an existing contact role rule set with the specified ID."}},"httpPath":"/contactRoleRuleSets/{tenantId}/{id}"}]},{"type":"group","label":"Contact Roles","link":"/apis/rolodex/rolodex-v1/contact-roles","routeSlug":"/apis/rolodex/rolodex-v1/contact-roles","items":[{"label":"Gets all of the contact roles in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-roles/listcontactroles","routeSlug":"/apis/rolodex/rolodex-v1/contact-roles/listcontactroles","metadata":{"seo":{"title":"Gets all of the contact roles in the system.","description":"This method will scan all contact roles and and return them to the caller."}},"httpPath":"/contactRoles/{tenantId}"},{"label":"Creates a new contact role record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-roles/createcontactrole","routeSlug":"/apis/rolodex/rolodex-v1/contact-roles/createcontactrole","metadata":{"seo":{"title":"Creates a new contact role record that does not already exist.","description":"This method will auto-generate an ID and create a new contact role. If an ID is specified for the contact role, an error will be thrown."}},"httpPath":"/contactRoles/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-roles/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/contact-roles/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/contactRoles/{tenantId}/batch"},{"label":"Returns a contact role from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-roles/deletecontactrole","routeSlug":"/apis/rolodex/rolodex-v1/contact-roles/deletecontactrole","metadata":{"seo":{"title":"Returns a contact role from the system by its ID.","description":"This method will delete a contact role with the specified ID."}},"httpPath":"/contactRoles/{tenantId}/{id}"},{"label":"Returns a contact role from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-roles/getcontactrole","routeSlug":"/apis/rolodex/rolodex-v1/contact-roles/getcontactrole","metadata":{"seo":{"title":"Returns a contact role from the system by its ID.","description":"This method will look up a contact role by the specified ID and return it back."}},"httpPath":"/contactRoles/{tenantId}/{id}"},{"label":"Partially updates a contact role with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-roles/patchcontactrole","routeSlug":"/apis/rolodex/rolodex-v1/contact-roles/patchcontactrole","metadata":{"seo":{"title":"Partially updates a contact role with the specified ID.","description":"This method will patch an existing contact role with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/contactRoles/{tenantId}/{id}"},{"label":"Updates a contact role with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contact-roles/updatecontactrole","routeSlug":"/apis/rolodex/rolodex-v1/contact-roles/updatecontactrole","metadata":{"seo":{"title":"Updates a contact role with the specified ID.","description":"This method will update an existing contact role with the specified ID."}},"httpPath":"/contactRoles/{tenantId}/{id}"}]},{"type":"group","label":"Contacts","link":"/apis/rolodex/rolodex-v1/contacts","routeSlug":"/apis/rolodex/rolodex-v1/contacts","items":[{"label":"Creates a new contact record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/createcontact","routeSlug":"/apis/rolodex/rolodex-v1/contacts/createcontact","metadata":{"seo":{"title":"Creates a new contact record that does not already exist.","description":"This method will auto-generate an ID and create a new contact. If an ID is specified for the contact, an error will be thrown."}},"httpPath":"/contacts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/contacts/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/contacts/{tenantId}/batch"},{"label":"Checks whether a contact can manage another","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/checkmanageability","routeSlug":"/apis/rolodex/rolodex-v1/contacts/checkmanageability","metadata":{"seo":{"title":"Checks whether a contact can manage another","description":"Checks to see if a contact is clear to manage another contact by email addess"}},"httpPath":"/contacts/{tenantId}/checkManageability/{managerId}"},{"label":"Returns the contact related to the currently logged in user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/getcurrentcontactfromcredentials","routeSlug":"/apis/rolodex/rolodex-v1/contacts/getcurrentcontactfromcredentials","metadata":{"seo":{"title":"Returns the contact related to the currently logged in user","description":"Returns the contact related to the currently logged in user"}},"httpPath":"/contacts/{tenantId}/current"},{"label":"Creates a new contact and links it to the currently logged in user","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/createcontactandlinkuser","routeSlug":"/apis/rolodex/rolodex-v1/contacts/createcontactandlinkuser","metadata":{"seo":{"title":"Creates a new contact and links it to the currently logged in user","description":"Returns the new contact which is linked to the currently logged in user"}},"httpPath":"/contacts/{tenantId}/current"},{"label":"Get contacts (and descendants recursively) for an organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/recursivelylistcontactsfororganizationid","routeSlug":"/apis/rolodex/rolodex-v1/contacts/recursivelylistcontactsfororganizationid","metadata":{"seo":{"title":"Get contacts (and descendants recursively) for an organization","description":"Does a recursive lookup of contacts by organization"}},"httpPath":"/contacts/{tenantId}/descendants/{organization_id}"},{"label":"Returns a list of records with the specified email_address","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/listcontactsbyemailaddress","routeSlug":"/apis/rolodex/rolodex-v1/contacts/listcontactsbyemailaddress","metadata":{"seo":{"title":"Returns a list of records with the specified email_address","description":"Returns a list of records with the specified email_address"}},"httpPath":"/contacts/{tenantId}/emailAddress/{email_address}"},{"label":"Returns a list of records with the specified email_address2","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/listcontactsbyemailaddress2","routeSlug":"/apis/rolodex/rolodex-v1/contacts/listcontactsbyemailaddress2","metadata":{"seo":{"title":"Returns a list of records with the specified email_address2","description":"Returns a list of records with the specified email_address2"}},"httpPath":"/contacts/{tenantId}/emailAddress2/{email_address2}"},{"label":"Returns a list of records with the specified email_address3","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/listcontactsbyemailaddress3","routeSlug":"/apis/rolodex/rolodex-v1/contacts/listcontactsbyemailaddress3","metadata":{"seo":{"title":"Returns a list of records with the specified email_address3","description":"Returns a list of records with the specified email_address3"}},"httpPath":"/contacts/{tenantId}/emailAddress3/{email_address3}"},{"label":"Finds all conflicting fields for contacts","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/generatemergedobject","routeSlug":"/apis/rolodex/rolodex-v1/contacts/generatemergedobject","metadata":{"seo":{"title":"Finds all conflicting fields for contacts","description":"This method will load contacts, compare them, and return all fields that are in conflict"}},"httpPath":"/contacts/{tenantId}/generateMergedObject"},{"label":"Finds all conflicting fields for contacts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/getfieldconflicts","routeSlug":"/apis/rolodex/rolodex-v1/contacts/getfieldconflicts","metadata":{"seo":{"title":"Finds all conflicting fields for contacts","description":"This method will load contacts, compare them, and return all fields that are in conflict"}},"httpPath":"/contacts/{tenantId}/getFieldConflicts/{ids}"},{"label":"Returns a single contact by number","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/readcontactbynumber","routeSlug":"/apis/rolodex/rolodex-v1/contacts/readcontactbynumber","metadata":{"seo":{"title":"Returns a single contact by number","description":"Returns a single contact by number"}},"httpPath":"/contacts/{tenantId}/number/{number}"},{"label":"Finds contacts for an organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/listcontactsbyorganizationid","routeSlug":"/apis/rolodex/rolodex-v1/contacts/listcontactsbyorganizationid","metadata":{"seo":{"title":"Finds contacts for an organization","description":"Returns a list of records with the specified organization_id. If the list is large, a results_uri is returned with a list that can be downloaded."}},"httpPath":"/contacts/{tenantId}/organization/{organization_id}"},{"label":"Returns the contact related to the currently logged in user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/getcontactfromportaluser","routeSlug":"/apis/rolodex/rolodex-v1/contacts/getcontactfromportaluser","metadata":{"seo":{"title":"Returns the contact related to the currently logged in user","description":"Returns the contact related to the currently logged in user"}},"httpPath":"/contacts/{tenantId}/portal"},{"label":"Initiates a workflow to create a new contact and try to link them to an existing organization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/createcontactandlinkportaluser","routeSlug":"/apis/rolodex/rolodex-v1/contacts/createcontactandlinkportaluser","metadata":{"seo":{"title":"Initiates a workflow to create a new contact and try to link them to an existing organization","description":"Returns the new contact which is linked to the currently logged in user"}},"httpPath":"/contacts/{tenantId}/portal"},{"label":"Gets a contact by an email address","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/getcontactbyemailaddress","routeSlug":"/apis/rolodex/rolodex-v1/contacts/getcontactbyemailaddress","metadata":{"seo":{"title":"Gets a contact by an email address","description":"Returns the appropriate contact ID for an email, can be called by the portal and useful in duplicate prevention"}},"httpPath":"/contacts/{tenantId}/portal/emailAddress/{email_address}"},{"label":"Sends an authorization email then links the current user to a contact with a different email address","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/authorizeandlinkalternateemail","routeSlug":"/apis/rolodex/rolodex-v1/contacts/authorizeandlinkalternateemail","metadata":{"seo":{"title":"Sends an authorization email then links the current user to a contact with a different email address","description":"Sends an authorization email then links the current user to a contact with a different email address"}},"httpPath":"/contacts/{tenantId}/portal/{emailAddress}"},{"label":"Returns a list of records with the specified portal_delegate_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/listcontactsbyportaldelegateid","routeSlug":"/apis/rolodex/rolodex-v1/contacts/listcontactsbyportaldelegateid","metadata":{"seo":{"title":"Returns a list of records with the specified portal_delegate_id","description":"Returns a list of records with the specified portal_delegate_id"}},"httpPath":"/contacts/{tenantId}/portalDelegate/{portal_delegate_id}"},{"label":"Searches for contacts using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/searchforcontacts","routeSlug":"/apis/rolodex/rolodex-v1/contacts/searchforcontacts","metadata":{"seo":{"title":"Searches for contacts using predefined parameters","description":"Searches for contacts using predefined parameters"}},"httpPath":"/contacts/{tenantId}/search"},{"label":"Looks up a social profile and returns what is found to the user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/getsocialprofile","routeSlug":"/apis/rolodex/rolodex-v1/contacts/getsocialprofile","metadata":{"seo":{"title":"Looks up a social profile and returns what is found to the user","description":"This method will make a call and parse/return the results"}},"httpPath":"/contacts/{tenantId}/socialProfile/{emailAddress}"},{"label":"Returns a contact from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/deletecontact","routeSlug":"/apis/rolodex/rolodex-v1/contacts/deletecontact","metadata":{"seo":{"title":"Returns a contact from the system by its ID.","description":"This method will delete a contact with the specified ID."}},"httpPath":"/contacts/{tenantId}/{id}"},{"label":"Returns a contact from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/getcontact","routeSlug":"/apis/rolodex/rolodex-v1/contacts/getcontact","metadata":{"seo":{"title":"Returns a contact from the system by its ID.","description":"This method will look up a contact by the specified ID and return it back."}},"httpPath":"/contacts/{tenantId}/{id}"},{"label":"Partially updates a contact with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/patchcontact","routeSlug":"/apis/rolodex/rolodex-v1/contacts/patchcontact","metadata":{"seo":{"title":"Partially updates a contact with the specified ID.","description":"This method will patch an existing contact with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/contacts/{tenantId}/{id}"},{"label":"Updates a contact with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/updatecontact","routeSlug":"/apis/rolodex/rolodex-v1/contacts/updatecontact","metadata":{"seo":{"title":"Updates a contact with the specified ID.","description":"This method will update an existing contact with the specified ID."}},"httpPath":"/contacts/{tenantId}/{id}"},{"label":"Updates a contact with data merged from other contacts then signals other microservices to complete the merge","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/contacts/mergecontacts","routeSlug":"/apis/rolodex/rolodex-v1/contacts/mergecontacts","metadata":{"seo":{"title":"Updates a contact with data merged from other contacts then signals other microservices to complete the merge","description":"Updates a contact with data merged from other contacts then signals other microservices to complete the merge"}},"httpPath":"/contacts/{tenantId}/{id}/merge"}]},{"type":"group","label":"Custom Activities","link":"/apis/rolodex/rolodex-v1/custom-activities","routeSlug":"/apis/rolodex/rolodex-v1/custom-activities","items":[{"label":"Gets all of the custom activities in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activities/listcustomactivities","routeSlug":"/apis/rolodex/rolodex-v1/custom-activities/listcustomactivities","metadata":{"seo":{"title":"Gets all of the custom activities in the system.","description":"This method will scan all custom activities and and return them to the caller."}},"httpPath":"/customActivities/{tenantId}"},{"label":"Creates a new custom activity record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activities/createcustomactivity","routeSlug":"/apis/rolodex/rolodex-v1/custom-activities/createcustomactivity","metadata":{"seo":{"title":"Creates a new custom activity record that does not already exist.","description":"This method will auto-generate an ID and create a new custom activity. If an ID is specified for the custom activity, an error will be thrown."}},"httpPath":"/customActivities/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activities/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/custom-activities/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/customActivities/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activities/listactivitiesbycontactid","routeSlug":"/apis/rolodex/rolodex-v1/custom-activities/listactivitiesbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/customActivities/{tenantId}/contact/{contact_id}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activities/listactivitiesbyorganizationid","routeSlug":"/apis/rolodex/rolodex-v1/custom-activities/listactivitiesbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/customActivities/{tenantId}/organization/{organization_id}"},{"label":"Returns a custom activity from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activities/deletecustomactivity","routeSlug":"/apis/rolodex/rolodex-v1/custom-activities/deletecustomactivity","metadata":{"seo":{"title":"Returns a custom activity from the system by its ID.","description":"This method will delete a custom activity with the specified ID."}},"httpPath":"/customActivities/{tenantId}/{id}"},{"label":"Returns a custom activity from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activities/getcustomactivity","routeSlug":"/apis/rolodex/rolodex-v1/custom-activities/getcustomactivity","metadata":{"seo":{"title":"Returns a custom activity from the system by its ID.","description":"This method will look up a custom activity by the specified ID and return it back."}},"httpPath":"/customActivities/{tenantId}/{id}"},{"label":"Partially updates a custom activity with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activities/patchcustomactivity","routeSlug":"/apis/rolodex/rolodex-v1/custom-activities/patchcustomactivity","metadata":{"seo":{"title":"Partially updates a custom activity with the specified ID.","description":"This method will patch an existing custom activity with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/customActivities/{tenantId}/{id}"},{"label":"Updates a custom activity with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activities/updatecustomactivity","routeSlug":"/apis/rolodex/rolodex-v1/custom-activities/updatecustomactivity","metadata":{"seo":{"title":"Updates a custom activity with the specified ID.","description":"This method will update an existing custom activity with the specified ID."}},"httpPath":"/customActivities/{tenantId}/{id}"}]},{"type":"group","label":"Custom Activity Types","link":"/apis/rolodex/rolodex-v1/custom-activity-types","routeSlug":"/apis/rolodex/rolodex-v1/custom-activity-types","items":[{"label":"Gets all of the custom activity types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activity-types/listcustomactivitytypes","routeSlug":"/apis/rolodex/rolodex-v1/custom-activity-types/listcustomactivitytypes","metadata":{"seo":{"title":"Gets all of the custom activity types in the system.","description":"This method will scan all custom activity types and and return them to the caller."}},"httpPath":"/customActivityTypes/{tenantId}"},{"label":"Creates a new custom activity type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activity-types/createcustomactivitytype","routeSlug":"/apis/rolodex/rolodex-v1/custom-activity-types/createcustomactivitytype","metadata":{"seo":{"title":"Creates a new custom activity type record that does not already exist.","description":"This method will auto-generate an ID and create a new custom activity type. If an ID is specified for the custom activity type, an error will be thrown."}},"httpPath":"/customActivityTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activity-types/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/custom-activity-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/customActivityTypes/{tenantId}/batch"},{"label":"Returns a custom activity type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activity-types/deletecustomactivitytype","routeSlug":"/apis/rolodex/rolodex-v1/custom-activity-types/deletecustomactivitytype","metadata":{"seo":{"title":"Returns a custom activity type from the system by its ID.","description":"This method will delete a custom activity type with the specified ID."}},"httpPath":"/customActivityTypes/{tenantId}/{id}"},{"label":"Returns a custom activity type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activity-types/getcustomactivitytype","routeSlug":"/apis/rolodex/rolodex-v1/custom-activity-types/getcustomactivitytype","metadata":{"seo":{"title":"Returns a custom activity type from the system by its ID.","description":"This method will look up a custom activity type by the specified ID and return it back."}},"httpPath":"/customActivityTypes/{tenantId}/{id}"},{"label":"Partially updates a custom activity type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activity-types/patchcustomactivitytype","routeSlug":"/apis/rolodex/rolodex-v1/custom-activity-types/patchcustomactivitytype","metadata":{"seo":{"title":"Partially updates a custom activity type with the specified ID.","description":"This method will patch an existing custom activity type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/customActivityTypes/{tenantId}/{id}"},{"label":"Updates a custom activity type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-activity-types/updatecustomactivitytype","routeSlug":"/apis/rolodex/rolodex-v1/custom-activity-types/updatecustomactivitytype","metadata":{"seo":{"title":"Updates a custom activity type with the specified ID.","description":"This method will update an existing custom activity type with the specified ID."}},"httpPath":"/customActivityTypes/{tenantId}/{id}"}]},{"type":"group","label":"Custom Engagement Metrics","link":"/apis/rolodex/rolodex-v1/custom-engagement-metrics","routeSlug":"/apis/rolodex/rolodex-v1/custom-engagement-metrics","items":[{"label":"Gets all of the custom engagement metrics in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/listcustomengagementmetrics","routeSlug":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/listcustomengagementmetrics","metadata":{"seo":{"title":"Gets all of the custom engagement metrics in the system.","description":"This method will scan all custom engagement metrics and and return them to the caller."}},"httpPath":"/customEngagementMetrics/{tenantId}"},{"label":"Creates a new custom engagement metric record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/createcustomengagementmetric","routeSlug":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/createcustomengagementmetric","metadata":{"seo":{"title":"Creates a new custom engagement metric record that does not already exist.","description":"This method will auto-generate an ID and create a new custom engagement metric. If an ID is specified for the custom engagement metric, an error will be thrown."}},"httpPath":"/customEngagementMetrics/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/customEngagementMetrics/{tenantId}/batch"},{"label":"Returns a custom engagement metric from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/deletecustomengagementmetric","routeSlug":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/deletecustomengagementmetric","metadata":{"seo":{"title":"Returns a custom engagement metric from the system by its ID.","description":"This method will delete a custom engagement metric with the specified ID."}},"httpPath":"/customEngagementMetrics/{tenantId}/{id}"},{"label":"Returns a custom engagement metric from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/getcustomengagementmetric","routeSlug":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/getcustomengagementmetric","metadata":{"seo":{"title":"Returns a custom engagement metric from the system by its ID.","description":"This method will look up a custom engagement metric by the specified ID and return it back."}},"httpPath":"/customEngagementMetrics/{tenantId}/{id}"},{"label":"Partially updates a custom engagement metric with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/patchcustomengagementmetric","routeSlug":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/patchcustomengagementmetric","metadata":{"seo":{"title":"Partially updates a custom engagement metric with the specified ID.","description":"This method will patch an existing custom engagement metric with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/customEngagementMetrics/{tenantId}/{id}"},{"label":"Updates a custom engagement metric with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/updatecustomengagementmetric","routeSlug":"/apis/rolodex/rolodex-v1/custom-engagement-metrics/updatecustomengagementmetric","metadata":{"seo":{"title":"Updates a custom engagement metric with the specified ID.","description":"This method will update an existing custom engagement metric with the specified ID."}},"httpPath":"/customEngagementMetrics/{tenantId}/{id}"}]},{"type":"group","label":"Engagement Categories","link":"/apis/rolodex/rolodex-v1/engagement-categories","routeSlug":"/apis/rolodex/rolodex-v1/engagement-categories","items":[{"label":"Gets all of the engagement categories in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-categories/listengagementcategories","routeSlug":"/apis/rolodex/rolodex-v1/engagement-categories/listengagementcategories","metadata":{"seo":{"title":"Gets all of the engagement categories in the system.","description":"This method will scan all engagement categories and and return them to the caller."}},"httpPath":"/engagementCategories/{tenantId}"},{"label":"Creates a new engagement category record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-categories/createengagementcategory","routeSlug":"/apis/rolodex/rolodex-v1/engagement-categories/createengagementcategory","metadata":{"seo":{"title":"Creates a new engagement category record that does not already exist.","description":"This method will auto-generate an ID and create a new engagement category. If an ID is specified for the engagement category, an error will be thrown."}},"httpPath":"/engagementCategories/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-categories/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/engagement-categories/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/engagementCategories/{tenantId}/batch"},{"label":"Returns a engagement category from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-categories/deleteengagementcategory","routeSlug":"/apis/rolodex/rolodex-v1/engagement-categories/deleteengagementcategory","metadata":{"seo":{"title":"Returns a engagement category from the system by its ID.","description":"This method will delete a engagement category with the specified ID."}},"httpPath":"/engagementCategories/{tenantId}/{id}"},{"label":"Returns a engagement category from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-categories/getengagementcategory","routeSlug":"/apis/rolodex/rolodex-v1/engagement-categories/getengagementcategory","metadata":{"seo":{"title":"Returns a engagement category from the system by its ID.","description":"This method will look up a engagement category by the specified ID and return it back."}},"httpPath":"/engagementCategories/{tenantId}/{id}"},{"label":"Partially updates a engagement category with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-categories/patchengagementcategory","routeSlug":"/apis/rolodex/rolodex-v1/engagement-categories/patchengagementcategory","metadata":{"seo":{"title":"Partially updates a engagement category with the specified ID.","description":"This method will patch an existing engagement category with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/engagementCategories/{tenantId}/{id}"},{"label":"Updates a engagement category with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-categories/updateengagementcategory","routeSlug":"/apis/rolodex/rolodex-v1/engagement-categories/updateengagementcategory","metadata":{"seo":{"title":"Updates a engagement category with the specified ID.","description":"This method will update an existing engagement category with the specified ID."}},"httpPath":"/engagementCategories/{tenantId}/{id}"}]},{"type":"group","label":"Engagement Models","link":"/apis/rolodex/rolodex-v1/engagement-models","routeSlug":"/apis/rolodex/rolodex-v1/engagement-models","items":[{"label":"Gets all of the engagement models in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-models/listengagementmodels","routeSlug":"/apis/rolodex/rolodex-v1/engagement-models/listengagementmodels","metadata":{"seo":{"title":"Gets all of the engagement models in the system.","description":"This method will scan all engagement models and and return them to the caller."}},"httpPath":"/engagementModels/{tenantId}"},{"label":"Creates a new engagement model record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-models/createengagementmodel","routeSlug":"/apis/rolodex/rolodex-v1/engagement-models/createengagementmodel","metadata":{"seo":{"title":"Creates a new engagement model record that does not already exist.","description":"This method will auto-generate an ID and create a new engagement model. If an ID is specified for the engagement model, an error will be thrown."}},"httpPath":"/engagementModels/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-models/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/engagement-models/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/engagementModels/{tenantId}/batch"},{"label":"Returns a engagement model from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-models/deleteengagementmodel","routeSlug":"/apis/rolodex/rolodex-v1/engagement-models/deleteengagementmodel","metadata":{"seo":{"title":"Returns a engagement model from the system by its ID.","description":"This method will delete a engagement model with the specified ID."}},"httpPath":"/engagementModels/{tenantId}/{id}"},{"label":"Returns a engagement model from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-models/getengagementmodel","routeSlug":"/apis/rolodex/rolodex-v1/engagement-models/getengagementmodel","metadata":{"seo":{"title":"Returns a engagement model from the system by its ID.","description":"This method will look up a engagement model by the specified ID and return it back."}},"httpPath":"/engagementModels/{tenantId}/{id}"},{"label":"Partially updates a engagement model with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-models/patchengagementmodel","routeSlug":"/apis/rolodex/rolodex-v1/engagement-models/patchengagementmodel","metadata":{"seo":{"title":"Partially updates a engagement model with the specified ID.","description":"This method will patch an existing engagement model with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/engagementModels/{tenantId}/{id}"},{"label":"Updates a engagement model with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-models/updateengagementmodel","routeSlug":"/apis/rolodex/rolodex-v1/engagement-models/updateengagementmodel","metadata":{"seo":{"title":"Updates a engagement model with the specified ID.","description":"This method will update an existing engagement model with the specified ID."}},"httpPath":"/engagementModels/{tenantId}/{id}"}]},{"type":"group","label":"Engagement Scores","link":"/apis/rolodex/rolodex-v1/engagement-scores","routeSlug":"/apis/rolodex/rolodex-v1/engagement-scores","items":[{"label":"Returns a list of records with the specified customer_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-scores/listscoresbycustomerid","routeSlug":"/apis/rolodex/rolodex-v1/engagement-scores/listscoresbycustomerid","metadata":{"seo":{"title":"Returns a list of records with the specified customer_id","description":"Returns a list of records with the specified customer_id"}},"httpPath":"/engagementScores/{tenantId}/customer/{customer_type}/{customer_id}"},{"label":"Get Metrics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-scores/getmetrics","routeSlug":"/apis/rolodex/rolodex-v1/engagement-scores/getmetrics","metadata":{"seo":{"title":"Get Metrics","description":"Gets a list of all metrics"}},"httpPath":"/engagementScores/{tenantId}/metrics"},{"label":"Initiate Engagement Metric Lookback","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-scores/performlookback","routeSlug":"/apis/rolodex/rolodex-v1/engagement-scores/performlookback","metadata":{"seo":{"title":"Initiate Engagement Metric Lookback","description":"Initiates a lookback write of engagement-related data"}},"httpPath":"/engagementScores/{tenantId}/performLookback"},{"label":"Get Raw Metric Data for Customer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-scores/getrawmetricdataforcustomer","routeSlug":"/apis/rolodex/rolodex-v1/engagement-scores/getrawmetricdataforcustomer","metadata":{"seo":{"title":"Get Raw Metric Data for Customer","description":"Gets the raw metric data for a customer"}},"httpPath":"/engagementScores/{tenantId}/rawMetricData/{customerType}/{customerId}"},{"label":"Regenerate scores","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-scores/regeneratescores","routeSlug":"/apis/rolodex/rolodex-v1/engagement-scores/regeneratescores","metadata":{"seo":{"title":"Regenerate scores","description":"Regenerates scores when a scoring model has changed"}},"httpPath":"/engagementScores/{tenantId}/regenerateScores"},{"label":"Returns a engagement score from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/engagement-scores/getengagementscore","routeSlug":"/apis/rolodex/rolodex-v1/engagement-scores/getengagementscore","metadata":{"seo":{"title":"Returns a engagement score from the system by its ID.","description":"This method will look up a engagement score by the specified ID and return it back."}},"httpPath":"/engagementScores/{tenantId}/{id}"}]},{"type":"group","label":"Organization Directories","link":"/apis/rolodex/rolodex-v1/organization-directories","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories","items":[{"label":"Gets all of the organization directories in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/listorganizationdirectories","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/listorganizationdirectories","metadata":{"seo":{"title":"Gets all of the organization directories in the system.","description":"This method will scan all organization directories and and return them to the caller."}},"httpPath":"/organizationDirectories/{tenantId}"},{"label":"Creates a new organization directory record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/createorganizationdirectory","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/createorganizationdirectory","metadata":{"seo":{"title":"Creates a new organization directory record that does not already exist.","description":"This method will auto-generate an ID and create a new organization directory. If an ID is specified for the organization directory, an error will be thrown."}},"httpPath":"/organizationDirectories/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/organizationDirectories/{tenantId}/batch"},{"label":"Gets an entry in the directory","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/getdirectoryentry","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/getdirectoryentry","metadata":{"seo":{"title":"Gets an entry in the directory","description":"Gets an entry in the directory"}},"httpPath":"/organizationDirectories/{tenantId}/public/entry/{id}/{entryId}"},{"label":"Searches the directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/searchpublicdirectory","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/searchpublicdirectory","metadata":{"seo":{"title":"Searches the directory","description":"Searches the directory"}},"httpPath":"/organizationDirectories/{tenantId}/public/search/{id}"},{"label":"Sends a message to an entry in the directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/senddirectorymessage","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/senddirectorymessage","metadata":{"seo":{"title":"Sends a message to an entry in the directory","description":"Sends a message to an entry in the directory"}},"httpPath":"/organizationDirectories/{tenantId}/public/sendMessage/{directoryId}/{entryId}"},{"label":"Returns a organization directory from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/getpublicdirectory","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/getpublicdirectory","metadata":{"seo":{"title":"Returns a organization directory from the system by its ID.","description":"This method will look up a organization directory by the specified ID and return it back."}},"httpPath":"/organizationDirectories/{tenantId}/public/{id}"},{"label":"Searches the directory","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/searchdirectory","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/searchdirectory","metadata":{"seo":{"title":"Searches the directory","description":"Searches the directory"}},"httpPath":"/organizationDirectories/{tenantId}/search/{id}"},{"label":"Returns a organization directory from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/deleteorganizationdirectory","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/deleteorganizationdirectory","metadata":{"seo":{"title":"Returns a organization directory from the system by its ID.","description":"This method will delete a organization directory with the specified ID."}},"httpPath":"/organizationDirectories/{tenantId}/{id}"},{"label":"Returns a organization directory from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/getorganizationdirectory","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/getorganizationdirectory","metadata":{"seo":{"title":"Returns a organization directory from the system by its ID.","description":"This method will look up a organization directory by the specified ID and return it back."}},"httpPath":"/organizationDirectories/{tenantId}/{id}"},{"label":"Partially updates a organization directory with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/patchorganizationdirectory","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/patchorganizationdirectory","metadata":{"seo":{"title":"Partially updates a organization directory with the specified ID.","description":"This method will patch an existing organization directory with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/organizationDirectories/{tenantId}/{id}"},{"label":"Updates a organization directory with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-directories/updateorganizationdirectory","routeSlug":"/apis/rolodex/rolodex-v1/organization-directories/updateorganizationdirectory","metadata":{"seo":{"title":"Updates a organization directory with the specified ID.","description":"This method will update an existing organization directory with the specified ID."}},"httpPath":"/organizationDirectories/{tenantId}/{id}"}]},{"type":"group","label":"Organization Duplicates","link":"/apis/rolodex/rolodex-v1/organization-duplicates","routeSlug":"/apis/rolodex/rolodex-v1/organization-duplicates","items":[{"label":"Gets all of the organization duplicates in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-duplicates/listorganizationduplicates","routeSlug":"/apis/rolodex/rolodex-v1/organization-duplicates/listorganizationduplicates","metadata":{"seo":{"title":"Gets all of the organization duplicates in the system.","description":"This method will scan all organization duplicates and and return them to the caller."}},"httpPath":"/organizationDuplicates/{tenantId}"},{"label":"Search for potential duplicates","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-duplicates/duplicatecheck","routeSlug":"/apis/rolodex/rolodex-v1/organization-duplicates/duplicatecheck","metadata":{"seo":{"title":"Search for potential duplicates","description":"This method takes in an order that has not yet been placed, and returns information about order pricing and available options"}},"httpPath":"/organizationDuplicates/{tenantId}"},{"label":"Returns a organization duplicate from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-duplicates/getorganizationduplicate","routeSlug":"/apis/rolodex/rolodex-v1/organization-duplicates/getorganizationduplicate","metadata":{"seo":{"title":"Returns a organization duplicate from the system by its ID.","description":"This method will look up a organization duplicate by the specified ID and return it back."}},"httpPath":"/organizationDuplicates/{tenantId}/{id}"},{"label":"Partially updates a organization duplicate with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-duplicates/patchorganizationduplicate","routeSlug":"/apis/rolodex/rolodex-v1/organization-duplicates/patchorganizationduplicate","metadata":{"seo":{"title":"Partially updates a organization duplicate with the specified ID.","description":"This method will patch an existing organization duplicate with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/organizationDuplicates/{tenantId}/{id}"},{"label":"Updates a organization duplicate with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-duplicates/updateorganizationduplicate","routeSlug":"/apis/rolodex/rolodex-v1/organization-duplicates/updateorganizationduplicate","metadata":{"seo":{"title":"Updates a organization duplicate with the specified ID.","description":"This method will update an existing organization duplicate with the specified ID."}},"httpPath":"/organizationDuplicates/{tenantId}/{id}"}]},{"type":"group","label":"Organization Types","link":"/apis/rolodex/rolodex-v1/organization-types","routeSlug":"/apis/rolodex/rolodex-v1/organization-types","items":[{"label":"Gets all of the organization types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-types/listorganizationtypes","routeSlug":"/apis/rolodex/rolodex-v1/organization-types/listorganizationtypes","metadata":{"seo":{"title":"Gets all of the organization types in the system.","description":"This method will scan all organization types and and return them to the caller."}},"httpPath":"/organizationTypes/{tenantId}"},{"label":"Creates a new organization type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-types/createorganizationtype","routeSlug":"/apis/rolodex/rolodex-v1/organization-types/createorganizationtype","metadata":{"seo":{"title":"Creates a new organization type record that does not already exist.","description":"This method will auto-generate an ID and create a new organization type. If an ID is specified for the organization type, an error will be thrown."}},"httpPath":"/organizationTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-types/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/organization-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/organizationTypes/{tenantId}/batch"},{"label":"Returns a organization type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-types/deleteorganizationtype","routeSlug":"/apis/rolodex/rolodex-v1/organization-types/deleteorganizationtype","metadata":{"seo":{"title":"Returns a organization type from the system by its ID.","description":"This method will delete a organization type with the specified ID."}},"httpPath":"/organizationTypes/{tenantId}/{id}"},{"label":"Returns a organization type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-types/getorganizationtype","routeSlug":"/apis/rolodex/rolodex-v1/organization-types/getorganizationtype","metadata":{"seo":{"title":"Returns a organization type from the system by its ID.","description":"This method will look up a organization type by the specified ID and return it back."}},"httpPath":"/organizationTypes/{tenantId}/{id}"},{"label":"Partially updates a organization type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-types/patchorganizationtype","routeSlug":"/apis/rolodex/rolodex-v1/organization-types/patchorganizationtype","metadata":{"seo":{"title":"Partially updates a organization type with the specified ID.","description":"This method will patch an existing organization type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/organizationTypes/{tenantId}/{id}"},{"label":"Updates a organization type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organization-types/updateorganizationtype","routeSlug":"/apis/rolodex/rolodex-v1/organization-types/updateorganizationtype","metadata":{"seo":{"title":"Updates a organization type with the specified ID.","description":"This method will update an existing organization type with the specified ID."}},"httpPath":"/organizationTypes/{tenantId}/{id}"}]},{"type":"group","label":"Organizations","link":"/apis/rolodex/rolodex-v1/organizations","routeSlug":"/apis/rolodex/rolodex-v1/organizations","items":[{"label":"Creates a new organization record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/createorganization","routeSlug":"/apis/rolodex/rolodex-v1/organizations/createorganization","metadata":{"seo":{"title":"Creates a new organization record that does not already exist.","description":"This method will auto-generate an ID and create a new organization. If an ID is specified for the organization, an error will be thrown."}},"httpPath":"/organizations/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/organizations/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/organizations/{tenantId}/batch"},{"label":"Get all descendent organizations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/getdescendents","routeSlug":"/apis/rolodex/rolodex-v1/organizations/getdescendents","metadata":{"seo":{"title":"Get all descendent organizations","description":"Recursively finds all descendents to an organization"}},"httpPath":"/organizations/{tenantId}/descendents/{id}"},{"label":"Returns the organization matching the specified domain_name","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/getorganizationbydomainname","routeSlug":"/apis/rolodex/rolodex-v1/organizations/getorganizationbydomainname","metadata":{"seo":{"title":"Returns the organization matching the specified domain_name","description":"Returns the organization matching the specified domain_name"}},"httpPath":"/organizations/{tenantId}/domain_name/{domain_name}"},{"label":"Finds all conflicting fields for organizations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/getfieldconflicts","routeSlug":"/apis/rolodex/rolodex-v1/organizations/getfieldconflicts","metadata":{"seo":{"title":"Finds all conflicting fields for organizations","description":"This method will load organizations, compare them, and return all fields that are in conflict"}},"httpPath":"/organizations/{tenantId}/getFieldConflicts/{ids}"},{"label":"Returns a list of records with the specified parent_organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/listorganizationsbyparentorganizationid","routeSlug":"/apis/rolodex/rolodex-v1/organizations/listorganizationsbyparentorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified parent_organization_id","description":"Returns a list of records with the specified parent_organization_id"}},"httpPath":"/organizations/{tenantId}/parentOrganization/{parent_organization_id}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/previewcontactrolecomplianceemail","routeSlug":"/apis/rolodex/rolodex-v1/organizations/previewcontactrolecomplianceemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/organizations/{tenantId}/previewContactRoleComplianceEmail"},{"label":"Get publicly available information for an org","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/publicreadorg","routeSlug":"/apis/rolodex/rolodex-v1/organizations/publicreadorg","metadata":{"seo":{"title":"Get publicly available information for an org","description":"This method will return the publicly accessible information for an org. It is used on the portal to make authenticated requests to users who are not yet tied to the organization"}},"httpPath":"/organizations/{tenantId}/public/{id}"},{"label":"Re-runs compliance for all organizations in the system","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/reprocesscompliance","routeSlug":"/apis/rolodex/rolodex-v1/organizations/reprocesscompliance","metadata":{"seo":{"title":"Re-runs compliance for all organizations in the system","description":"Given a set of expiration options, allows for the calculation of an expiration date"}},"httpPath":"/organizations/{tenantId}/reprocessCompliance"},{"label":"Searches for organizations using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/searchfororganizations","routeSlug":"/apis/rolodex/rolodex-v1/organizations/searchfororganizations","metadata":{"seo":{"title":"Searches for organizations using predefined parameters","description":"Searches for organizations using predefined parameters"}},"httpPath":"/organizations/{tenantId}/search"},{"label":"Looks up a social profile and returns what is found to the user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/getsocialprofile","routeSlug":"/apis/rolodex/rolodex-v1/organizations/getsocialprofile","metadata":{"seo":{"title":"Looks up a social profile and returns what is found to the user","description":"This method will make a call and parse/return the results"}},"httpPath":"/organizations/{tenantId}/socialProfile/{domain}"},{"label":"Returns a organization from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/deleteorganization","routeSlug":"/apis/rolodex/rolodex-v1/organizations/deleteorganization","metadata":{"seo":{"title":"Returns a organization from the system by its ID.","description":"This method will delete a organization with the specified ID."}},"httpPath":"/organizations/{tenantId}/{id}"},{"label":"Returns a organization from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/getorganization","routeSlug":"/apis/rolodex/rolodex-v1/organizations/getorganization","metadata":{"seo":{"title":"Returns a organization from the system by its ID.","description":"This method will look up a organization by the specified ID and return it back."}},"httpPath":"/organizations/{tenantId}/{id}"},{"label":"Partially updates a organization with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/patchorganization","routeSlug":"/apis/rolodex/rolodex-v1/organizations/patchorganization","metadata":{"seo":{"title":"Partially updates a organization with the specified ID.","description":"This method will patch an existing organization with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/organizations/{tenantId}/{id}"},{"label":"Updates a organization with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/updateorganization","routeSlug":"/apis/rolodex/rolodex-v1/organizations/updateorganization","metadata":{"seo":{"title":"Updates a organization with the specified ID.","description":"This method will update an existing organization with the specified ID."}},"httpPath":"/organizations/{tenantId}/{id}"},{"label":"Updates a organization with data merged from other organizations then signals other microservices to complete the merge","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/organizations/mergeorganizations","routeSlug":"/apis/rolodex/rolodex-v1/organizations/mergeorganizations","metadata":{"seo":{"title":"Updates a organization with data merged from other organizations then signals other microservices to complete the merge","description":"Updates a organization with data merged from other organizations then signals other microservices to complete the merge"}},"httpPath":"/organizations/{tenantId}/{id}/merge"}]},{"type":"group","label":"Phone Number Types","link":"/apis/rolodex/rolodex-v1/phone-number-types","routeSlug":"/apis/rolodex/rolodex-v1/phone-number-types","items":[{"label":"Gets all of the phone number types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/phone-number-types/listphonenumbertypes","routeSlug":"/apis/rolodex/rolodex-v1/phone-number-types/listphonenumbertypes","metadata":{"seo":{"title":"Gets all of the phone number types in the system.","description":"This method will scan all phone number types and and return them to the caller."}},"httpPath":"/phoneNumberTypes/{tenantId}"},{"label":"Creates a new phone number type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/phone-number-types/createphonenumbertype","routeSlug":"/apis/rolodex/rolodex-v1/phone-number-types/createphonenumbertype","metadata":{"seo":{"title":"Creates a new phone number type record that does not already exist.","description":"This method will auto-generate an ID and create a new phone number type. If an ID is specified for the phone number type, an error will be thrown."}},"httpPath":"/phoneNumberTypes/{tenantId}"},{"label":"Returns a phone number type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/phone-number-types/deletephonenumbertype","routeSlug":"/apis/rolodex/rolodex-v1/phone-number-types/deletephonenumbertype","metadata":{"seo":{"title":"Returns a phone number type from the system by its ID.","description":"This method will delete a phone number type with the specified ID."}},"httpPath":"/phoneNumberTypes/{tenantId}/{id}"},{"label":"Returns a phone number type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/phone-number-types/getphonenumbertype","routeSlug":"/apis/rolodex/rolodex-v1/phone-number-types/getphonenumbertype","metadata":{"seo":{"title":"Returns a phone number type from the system by its ID.","description":"This method will look up a phone number type by the specified ID and return it back."}},"httpPath":"/phoneNumberTypes/{tenantId}/{id}"},{"label":"Partially updates a phone number type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/phone-number-types/patchphonenumbertype","routeSlug":"/apis/rolodex/rolodex-v1/phone-number-types/patchphonenumbertype","metadata":{"seo":{"title":"Partially updates a phone number type with the specified ID.","description":"This method will patch an existing phone number type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/phoneNumberTypes/{tenantId}/{id}"},{"label":"Updates a phone number type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/phone-number-types/updatephonenumbertype","routeSlug":"/apis/rolodex/rolodex-v1/phone-number-types/updatephonenumbertype","metadata":{"seo":{"title":"Updates a phone number type with the specified ID.","description":"This method will update an existing phone number type with the specified ID."}},"httpPath":"/phoneNumberTypes/{tenantId}/{id}"}]},{"type":"group","label":"Query Definitions","link":"/apis/rolodex/rolodex-v1/query-definitions","routeSlug":"/apis/rolodex/rolodex-v1/query-definitions","items":[{"label":"Returns a list of records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/query-definitions/getquerydefinitions","routeSlug":"/apis/rolodex/rolodex-v1/query-definitions/getquerydefinitions","metadata":{"seo":{"title":"Returns a list of records","description":"Returns a list of records"}},"httpPath":"/queryDefinitions/{tenantId}"}]},{"type":"group","label":"Region Configurations","link":"/apis/rolodex/rolodex-v1/region-configurations","routeSlug":"/apis/rolodex/rolodex-v1/region-configurations","items":[{"label":"Returns a region configuration from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/region-configurations/deleteregionconfiguration","routeSlug":"/apis/rolodex/rolodex-v1/region-configurations/deleteregionconfiguration","metadata":{"seo":{"title":"Returns a region configuration from the system by its ID.","description":"This method will delete a region configuration with the specified ID."}},"httpPath":"/regionConfigurations/{tenantId}"},{"label":"Returns a region configuration from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/region-configurations/getregionconfiguration","routeSlug":"/apis/rolodex/rolodex-v1/region-configurations/getregionconfiguration","metadata":{"seo":{"title":"Returns a region configuration from the system by its ID.","description":"This method will look up a region configuration by the specified ID and return it back."}},"httpPath":"/regionConfigurations/{tenantId}"},{"label":"Partially updates a region configuration with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/region-configurations/patchregionconfiguration","routeSlug":"/apis/rolodex/rolodex-v1/region-configurations/patchregionconfiguration","metadata":{"seo":{"title":"Partially updates a region configuration with the specified ID.","description":"This method will patch an existing region configuration with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/regionConfigurations/{tenantId}"},{"label":"Creates a new region configuration record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/region-configurations/createregionconfiguration","routeSlug":"/apis/rolodex/rolodex-v1/region-configurations/createregionconfiguration","metadata":{"seo":{"title":"Creates a new region configuration record that does not already exist.","description":"This method will auto-generate an ID and create a new region configuration. If an ID is specified for the region configuration, an error will be thrown."}},"httpPath":"/regionConfigurations/{tenantId}"},{"label":"Updates a region configuration with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/region-configurations/updateregionconfiguration","routeSlug":"/apis/rolodex/rolodex-v1/region-configurations/updateregionconfiguration","metadata":{"seo":{"title":"Updates a region configuration with the specified ID.","description":"This method will update an existing region configuration with the specified ID."}},"httpPath":"/regionConfigurations/{tenantId}"}]},{"type":"group","label":"Regions","link":"/apis/rolodex/rolodex-v1/regions","routeSlug":"/apis/rolodex/rolodex-v1/regions","items":[{"label":"Gets all of the regions in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/regions/listregions","routeSlug":"/apis/rolodex/rolodex-v1/regions/listregions","metadata":{"seo":{"title":"Gets all of the regions in the system.","description":"This method will scan all regions and and return them to the caller."}},"httpPath":"/regions/{tenantId}"},{"label":"Creates a new region record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/regions/createregion","routeSlug":"/apis/rolodex/rolodex-v1/regions/createregion","metadata":{"seo":{"title":"Creates a new region record that does not already exist.","description":"This method will auto-generate an ID and create a new region. If an ID is specified for the region, an error will be thrown."}},"httpPath":"/regions/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/regions/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/regions/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/regions/{tenantId}/batch"},{"label":"Recalculate Region Assignments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/regions/recalculateregionassignments","routeSlug":"/apis/rolodex/rolodex-v1/regions/recalculateregionassignments","metadata":{"seo":{"title":"Recalculate Region Assignments","description":"Goes through and recalculates all region assignments"}},"httpPath":"/regions/{tenantId}/recalculate"},{"label":"Returns a region from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/regions/deleteregion","routeSlug":"/apis/rolodex/rolodex-v1/regions/deleteregion","metadata":{"seo":{"title":"Returns a region from the system by its ID.","description":"This method will delete a region with the specified ID."}},"httpPath":"/regions/{tenantId}/{id}"},{"label":"Returns a region from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/regions/getregion","routeSlug":"/apis/rolodex/rolodex-v1/regions/getregion","metadata":{"seo":{"title":"Returns a region from the system by its ID.","description":"This method will look up a region by the specified ID and return it back."}},"httpPath":"/regions/{tenantId}/{id}"},{"label":"Partially updates a region with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/regions/patchregion","routeSlug":"/apis/rolodex/rolodex-v1/regions/patchregion","metadata":{"seo":{"title":"Partially updates a region with the specified ID.","description":"This method will patch an existing region with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/regions/{tenantId}/{id}"},{"label":"Updates a region with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/regions/updateregion","routeSlug":"/apis/rolodex/rolodex-v1/regions/updateregion","metadata":{"seo":{"title":"Updates a region with the specified ID.","description":"This method will update an existing region with the specified ID."}},"httpPath":"/regions/{tenantId}/{id}"}]},{"type":"group","label":"Relationship Types","link":"/apis/rolodex/rolodex-v1/relationship-types","routeSlug":"/apis/rolodex/rolodex-v1/relationship-types","items":[{"label":"Gets all of the relationship types in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationship-types/listrelationshiptypes","routeSlug":"/apis/rolodex/rolodex-v1/relationship-types/listrelationshiptypes","metadata":{"seo":{"title":"Gets all of the relationship types in the system.","description":"This method will scan all relationship types and and return them to the caller."}},"httpPath":"/relationshipTypes/{tenantId}"},{"label":"Creates a new relationship type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationship-types/createrelationshiptype","routeSlug":"/apis/rolodex/rolodex-v1/relationship-types/createrelationshiptype","metadata":{"seo":{"title":"Creates a new relationship type record that does not already exist.","description":"This method will auto-generate an ID and create a new relationship type. If an ID is specified for the relationship type, an error will be thrown."}},"httpPath":"/relationshipTypes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationship-types/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/relationship-types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/relationshipTypes/{tenantId}/batch"},{"label":"Returns a relationship type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationship-types/deleterelationshiptype","routeSlug":"/apis/rolodex/rolodex-v1/relationship-types/deleterelationshiptype","metadata":{"seo":{"title":"Returns a relationship type from the system by its ID.","description":"This method will delete a relationship type with the specified ID."}},"httpPath":"/relationshipTypes/{tenantId}/{id}"},{"label":"Returns a relationship type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationship-types/getrelationshiptype","routeSlug":"/apis/rolodex/rolodex-v1/relationship-types/getrelationshiptype","metadata":{"seo":{"title":"Returns a relationship type from the system by its ID.","description":"This method will look up a relationship type by the specified ID and return it back."}},"httpPath":"/relationshipTypes/{tenantId}/{id}"},{"label":"Partially updates a relationship type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationship-types/patchrelationshiptype","routeSlug":"/apis/rolodex/rolodex-v1/relationship-types/patchrelationshiptype","metadata":{"seo":{"title":"Partially updates a relationship type with the specified ID.","description":"This method will patch an existing relationship type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/relationshipTypes/{tenantId}/{id}"},{"label":"Updates a relationship type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationship-types/updaterelationshiptype","routeSlug":"/apis/rolodex/rolodex-v1/relationship-types/updaterelationshiptype","metadata":{"seo":{"title":"Updates a relationship type with the specified ID.","description":"This method will update an existing relationship type with the specified ID."}},"httpPath":"/relationshipTypes/{tenantId}/{id}"}]},{"type":"group","label":"Relationships","link":"/apis/rolodex/rolodex-v1/relationships","routeSlug":"/apis/rolodex/rolodex-v1/relationships","items":[{"label":"Creates a new relationship record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationships/createrelationship","routeSlug":"/apis/rolodex/rolodex-v1/relationships/createrelationship","metadata":{"seo":{"title":"Creates a new relationship record that does not already exist.","description":"This method will auto-generate an ID and create a new relationship. If an ID is specified for the relationship, an error will be thrown."}},"httpPath":"/relationships/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationships/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/relationships/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/relationships/{tenantId}/batch"},{"label":"Returns a list of records with the specified left_side_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationships/listrelationshipsbyleftsideid","routeSlug":"/apis/rolodex/rolodex-v1/relationships/listrelationshipsbyleftsideid","metadata":{"seo":{"title":"Returns a list of records with the specified left_side_id","description":"Returns a list of records with the specified left_side_id"}},"httpPath":"/relationships/{tenantId}/leftSide/{left_side_type}/{left_side_id}"},{"label":"Returns a list of records with the specified right_side_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationships/listrelationshipsbyrightsideid","routeSlug":"/apis/rolodex/rolodex-v1/relationships/listrelationshipsbyrightsideid","metadata":{"seo":{"title":"Returns a list of records with the specified right_side_id","description":"Returns a list of records with the specified right_side_id"}},"httpPath":"/relationships/{tenantId}/rightSide/{right_side_type}/{right_side_id}"},{"label":"Returns a relationship from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationships/deleterelationship","routeSlug":"/apis/rolodex/rolodex-v1/relationships/deleterelationship","metadata":{"seo":{"title":"Returns a relationship from the system by its ID.","description":"This method will delete a relationship with the specified ID."}},"httpPath":"/relationships/{tenantId}/{id}"},{"label":"Returns a relationship from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationships/getrelationship","routeSlug":"/apis/rolodex/rolodex-v1/relationships/getrelationship","metadata":{"seo":{"title":"Returns a relationship from the system by its ID.","description":"This method will look up a relationship by the specified ID and return it back."}},"httpPath":"/relationships/{tenantId}/{id}"},{"label":"Partially updates a relationship with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationships/patchrelationship","routeSlug":"/apis/rolodex/rolodex-v1/relationships/patchrelationship","metadata":{"seo":{"title":"Partially updates a relationship with the specified ID.","description":"This method will patch an existing relationship with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/relationships/{tenantId}/{id}"},{"label":"Updates a relationship with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/relationships/updaterelationship","routeSlug":"/apis/rolodex/rolodex-v1/relationships/updaterelationship","metadata":{"seo":{"title":"Updates a relationship with the specified ID.","description":"This method will update an existing relationship with the specified ID."}},"httpPath":"/relationships/{tenantId}/{id}"}]},{"type":"group","label":"Settings","link":"/apis/rolodex/rolodex-v1/settings","routeSlug":"/apis/rolodex/rolodex-v1/settings","items":[{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/settings/deletesetting","routeSlug":"/apis/rolodex/rolodex-v1/settings/deletesetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will delete a setting with the specified ID."}},"httpPath":"/settings/{tenantId}"},{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/settings/getsetting","routeSlug":"/apis/rolodex/rolodex-v1/settings/getsetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will look up a setting by the specified ID and return it back."}},"httpPath":"/settings/{tenantId}"},{"label":"Partially updates a setting with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/settings/patchsetting","routeSlug":"/apis/rolodex/rolodex-v1/settings/patchsetting","metadata":{"seo":{"title":"Partially updates a setting with the specified ID.","description":"This method will patch an existing setting with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/settings/{tenantId}"},{"label":"Creates a new setting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/settings/createsetting","routeSlug":"/apis/rolodex/rolodex-v1/settings/createsetting","metadata":{"seo":{"title":"Creates a new setting record that does not already exist.","description":"This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, an error will be thrown."}},"httpPath":"/settings/{tenantId}"},{"label":"Updates a setting with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/settings/updatesetting","routeSlug":"/apis/rolodex/rolodex-v1/settings/updatesetting","metadata":{"seo":{"title":"Updates a setting with the specified ID.","description":"This method will update an existing setting with the specified ID."}},"httpPath":"/settings/{tenantId}"}]},{"type":"group","label":"Statistics","link":"/apis/rolodex/rolodex-v1/statistics","routeSlug":"/apis/rolodex/rolodex-v1/statistics","items":[{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/statistics/executebatchoperations","routeSlug":"/apis/rolodex/rolodex-v1/statistics/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/statistics/{tenantId}/batch"},{"label":"Returns a statistic from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/rolodex/rolodex-v1/statistics/getstatistic","routeSlug":"/apis/rolodex/rolodex-v1/statistics/getstatistic","metadata":{"seo":{"title":"Returns a statistic from the system by its ID.","description":"This method will look up a statistic by the specified ID and return it back."}},"httpPath":"/statistics/{tenantId}/{id}"}]}]},{"type":"group","label":"Sponsorship","items":[{"type":"link","label":"Sponsorship","link":"/apis/sponsorship/sponsorship-v1","routeSlug":"/apis/sponsorship/sponsorship-v1"},{"type":"group","label":"Add On Products","link":"/apis/sponsorship/sponsorship-v1/add-on-products","routeSlug":"/apis/sponsorship/sponsorship-v1/add-on-products","items":[{"label":"Gets all of the add on products in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/add-on-products/listaddonproducts","routeSlug":"/apis/sponsorship/sponsorship-v1/add-on-products/listaddonproducts","metadata":{"seo":{"title":"Gets all of the add on products in the system.","description":"This method will scan all add on products and and return them to the caller."}},"httpPath":"/addOnProducts/{tenantId}"},{"label":"Creates a new add on product record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/add-on-products/createaddonproduct","routeSlug":"/apis/sponsorship/sponsorship-v1/add-on-products/createaddonproduct","metadata":{"seo":{"title":"Creates a new add on product record that does not already exist.","description":"This method will auto-generate an ID and create a new add on product. If an ID is specified for the add on product, an error will be thrown."}},"httpPath":"/addOnProducts/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/add-on-products/executebatchoperations","routeSlug":"/apis/sponsorship/sponsorship-v1/add-on-products/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/addOnProducts/{tenantId}/batch"},{"label":"Returns a add on product from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/add-on-products/deleteaddonproduct","routeSlug":"/apis/sponsorship/sponsorship-v1/add-on-products/deleteaddonproduct","metadata":{"seo":{"title":"Returns a add on product from the system by its ID.","description":"This method will delete a add on product with the specified ID."}},"httpPath":"/addOnProducts/{tenantId}/{id}"},{"label":"Returns a add on product from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/add-on-products/getaddonproduct","routeSlug":"/apis/sponsorship/sponsorship-v1/add-on-products/getaddonproduct","metadata":{"seo":{"title":"Returns a add on product from the system by its ID.","description":"This method will look up a add on product by the specified ID and return it back."}},"httpPath":"/addOnProducts/{tenantId}/{id}"},{"label":"Partially updates a add on product with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/add-on-products/patchaddonproduct","routeSlug":"/apis/sponsorship/sponsorship-v1/add-on-products/patchaddonproduct","metadata":{"seo":{"title":"Partially updates a add on product with the specified ID.","description":"This method will patch an existing add on product with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/addOnProducts/{tenantId}/{id}"},{"label":"Updates a add on product with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/add-on-products/updateaddonproduct","routeSlug":"/apis/sponsorship/sponsorship-v1/add-on-products/updateaddonproduct","metadata":{"seo":{"title":"Updates a add on product with the specified ID.","description":"This method will update an existing add on product with the specified ID."}},"httpPath":"/addOnProducts/{tenantId}/{id}"}]},{"type":"group","label":"Application Processes","link":"/apis/sponsorship/sponsorship-v1/application-processes","routeSlug":"/apis/sponsorship/sponsorship-v1/application-processes","items":[{"label":"Gets all of the application processes in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/application-processes/listapplicationprocesses","routeSlug":"/apis/sponsorship/sponsorship-v1/application-processes/listapplicationprocesses","metadata":{"seo":{"title":"Gets all of the application processes in the system.","description":"This method will scan all application processes and and return them to the caller."}},"httpPath":"/applicationProcesses/{tenantId}"},{"label":"Creates a new application process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/application-processes/createapplicationprocess","routeSlug":"/apis/sponsorship/sponsorship-v1/application-processes/createapplicationprocess","metadata":{"seo":{"title":"Creates a new application process record that does not already exist.","description":"This method will auto-generate an ID and create a new application process. If an ID is specified for the application process, an error will be thrown."}},"httpPath":"/applicationProcesses/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/application-processes/executebatchoperations","routeSlug":"/apis/sponsorship/sponsorship-v1/application-processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/applicationProcesses/{tenantId}/batch"},{"label":"Returns a application process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/application-processes/deleteapplicationprocess","routeSlug":"/apis/sponsorship/sponsorship-v1/application-processes/deleteapplicationprocess","metadata":{"seo":{"title":"Returns a application process from the system by its ID.","description":"This method will delete a application process with the specified ID."}},"httpPath":"/applicationProcesses/{tenantId}/{id}"},{"label":"Returns a application process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/application-processes/getapplicationprocess","routeSlug":"/apis/sponsorship/sponsorship-v1/application-processes/getapplicationprocess","metadata":{"seo":{"title":"Returns a application process from the system by its ID.","description":"This method will look up a application process by the specified ID and return it back."}},"httpPath":"/applicationProcesses/{tenantId}/{id}"},{"label":"Partially updates a application process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/application-processes/patchapplicationprocess","routeSlug":"/apis/sponsorship/sponsorship-v1/application-processes/patchapplicationprocess","metadata":{"seo":{"title":"Partially updates a application process with the specified ID.","description":"This method will patch an existing application process with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/applicationProcesses/{tenantId}/{id}"},{"label":"Updates a application process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/application-processes/updateapplicationprocess","routeSlug":"/apis/sponsorship/sponsorship-v1/application-processes/updateapplicationprocess","metadata":{"seo":{"title":"Updates a application process with the specified ID.","description":"This method will update an existing application process with the specified ID."}},"httpPath":"/applicationProcesses/{tenantId}/{id}"}]},{"type":"group","label":"Application Status Reasons","link":"/apis/sponsorship/sponsorship-v1/application-status-reasons","routeSlug":"/apis/sponsorship/sponsorship-v1/application-status-reasons","items":[{"label":"Gets all of the application status reasons in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/application-status-reasons/listapplicationstatusreasons","routeSlug":"/apis/sponsorship/sponsorship-v1/application-status-reasons/listapplicationstatusreasons","metadata":{"seo":{"title":"Gets all of the application status reasons in the system.","description":"This method will scan all application status reasons and and return them to the caller."}},"httpPath":"/applicationStatusReasons/{tenantId}"},{"label":"Creates a new application status reason record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/application-status-reasons/createapplicationstatusreason","routeSlug":"/apis/sponsorship/sponsorship-v1/application-status-reasons/createapplicationstatusreason","metadata":{"seo":{"title":"Creates a new application status reason record that does not already exist.","description":"This method will auto-generate an ID and create a new application status reason. If an ID is specified for the application status reason, an error will be thrown."}},"httpPath":"/applicationStatusReasons/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/application-status-reasons/executebatchoperations","routeSlug":"/apis/sponsorship/sponsorship-v1/application-status-reasons/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/applicationStatusReasons/{tenantId}/batch"},{"label":"Returns a application status reason from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/application-status-reasons/deleteapplicationstatusreason","routeSlug":"/apis/sponsorship/sponsorship-v1/application-status-reasons/deleteapplicationstatusreason","metadata":{"seo":{"title":"Returns a application status reason from the system by its ID.","description":"This method will delete a application status reason with the specified ID."}},"httpPath":"/applicationStatusReasons/{tenantId}/{id}"},{"label":"Returns a application status reason from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/application-status-reasons/getapplicationstatusreason","routeSlug":"/apis/sponsorship/sponsorship-v1/application-status-reasons/getapplicationstatusreason","metadata":{"seo":{"title":"Returns a application status reason from the system by its ID.","description":"This method will look up a application status reason by the specified ID and return it back."}},"httpPath":"/applicationStatusReasons/{tenantId}/{id}"},{"label":"Partially updates a application status reason with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/application-status-reasons/patchapplicationstatusreason","routeSlug":"/apis/sponsorship/sponsorship-v1/application-status-reasons/patchapplicationstatusreason","metadata":{"seo":{"title":"Partially updates a application status reason with the specified ID.","description":"This method will patch an existing application status reason with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/applicationStatusReasons/{tenantId}/{id}"},{"label":"Updates a application status reason with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/application-status-reasons/updateapplicationstatusreason","routeSlug":"/apis/sponsorship/sponsorship-v1/application-status-reasons/updateapplicationstatusreason","metadata":{"seo":{"title":"Updates a application status reason with the specified ID.","description":"This method will update an existing application status reason with the specified ID."}},"httpPath":"/applicationStatusReasons/{tenantId}/{id}"}]},{"type":"group","label":"Applications","link":"/apis/sponsorship/sponsorship-v1/applications","routeSlug":"/apis/sponsorship/sponsorship-v1/applications","items":[{"label":"Creates a new application record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/applications/createapplication","routeSlug":"/apis/sponsorship/sponsorship-v1/applications/createapplication","metadata":{"seo":{"title":"Creates a new application record that does not already exist.","description":"This method will auto-generate an ID and create a new application. If an ID is specified for the application, an error will be thrown."}},"httpPath":"/applications/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/applications/executebatchoperations","routeSlug":"/apis/sponsorship/sponsorship-v1/applications/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/applications/{tenantId}/batch"},{"label":"Generates an order from a sponsorship application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/applications/generateorder","routeSlug":"/apis/sponsorship/sponsorship-v1/applications/generateorder","metadata":{"seo":{"title":"Generates an order from a sponsorship application","description":"This method will examine a sponsorship and generate an appropriate order"}},"httpPath":"/applications/{tenantId}/generateOrder"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/applications/listapplicationsbyorganizationid","routeSlug":"/apis/sponsorship/sponsorship-v1/applications/listapplicationsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/applications/{tenantId}/organization/{organization_id}"},{"label":"Searches for applications using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/applications/searchforapplications","routeSlug":"/apis/sponsorship/sponsorship-v1/applications/searchforapplications","metadata":{"seo":{"title":"Searches for applications using predefined parameters","description":"Searches for applications using predefined parameters"}},"httpPath":"/applications/{tenantId}/search"},{"label":"Returns a application from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/applications/deleteapplication","routeSlug":"/apis/sponsorship/sponsorship-v1/applications/deleteapplication","metadata":{"seo":{"title":"Returns a application from the system by its ID.","description":"This method will delete a application with the specified ID."}},"httpPath":"/applications/{tenantId}/{id}"},{"label":"Returns a application from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/applications/getapplication","routeSlug":"/apis/sponsorship/sponsorship-v1/applications/getapplication","metadata":{"seo":{"title":"Returns a application from the system by its ID.","description":"This method will look up a application by the specified ID and return it back."}},"httpPath":"/applications/{tenantId}/{id}"},{"label":"Partially updates a application with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/applications/patchapplication","routeSlug":"/apis/sponsorship/sponsorship-v1/applications/patchapplication","metadata":{"seo":{"title":"Partially updates a application with the specified ID.","description":"This method will patch an existing application with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/applications/{tenantId}/{id}"},{"label":"Updates a application with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/applications/updateapplication","routeSlug":"/apis/sponsorship/sponsorship-v1/applications/updateapplication","metadata":{"seo":{"title":"Updates a application with the specified ID.","description":"This method will update an existing application with the specified ID."}},"httpPath":"/applications/{tenantId}/{id}"}]},{"type":"group","label":"Categories","link":"/apis/sponsorship/sponsorship-v1/categories","routeSlug":"/apis/sponsorship/sponsorship-v1/categories","items":[{"label":"Gets all of the categories in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/categories/listcategories","routeSlug":"/apis/sponsorship/sponsorship-v1/categories/listcategories","metadata":{"seo":{"title":"Gets all of the categories in the system.","description":"This method will scan all categories and and return them to the caller."}},"httpPath":"/categories/{tenantId}"},{"label":"Creates a new category record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/categories/createcategory","routeSlug":"/apis/sponsorship/sponsorship-v1/categories/createcategory","metadata":{"seo":{"title":"Creates a new category record that does not already exist.","description":"This method will auto-generate an ID and create a new category. If an ID is specified for the category, an error will be thrown."}},"httpPath":"/categories/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/categories/executebatchoperations","routeSlug":"/apis/sponsorship/sponsorship-v1/categories/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/categories/{tenantId}/batch"},{"label":"Returns a category from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/categories/deletecategory","routeSlug":"/apis/sponsorship/sponsorship-v1/categories/deletecategory","metadata":{"seo":{"title":"Returns a category from the system by its ID.","description":"This method will delete a category with the specified ID."}},"httpPath":"/categories/{tenantId}/{id}"},{"label":"Returns a category from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/categories/getcategory","routeSlug":"/apis/sponsorship/sponsorship-v1/categories/getcategory","metadata":{"seo":{"title":"Returns a category from the system by its ID.","description":"This method will look up a category by the specified ID and return it back."}},"httpPath":"/categories/{tenantId}/{id}"},{"label":"Partially updates a category with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/categories/patchcategory","routeSlug":"/apis/sponsorship/sponsorship-v1/categories/patchcategory","metadata":{"seo":{"title":"Partially updates a category with the specified ID.","description":"This method will patch an existing category with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/categories/{tenantId}/{id}"},{"label":"Updates a category with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/categories/updatecategory","routeSlug":"/apis/sponsorship/sponsorship-v1/categories/updatecategory","metadata":{"seo":{"title":"Updates a category with the specified ID.","description":"This method will update an existing category with the specified ID."}},"httpPath":"/categories/{tenantId}/{id}"}]},{"type":"group","label":"Opportunities","link":"/apis/sponsorship/sponsorship-v1/opportunities","routeSlug":"/apis/sponsorship/sponsorship-v1/opportunities","items":[{"label":"Creates a new opportunity record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/opportunities/createopportunity","routeSlug":"/apis/sponsorship/sponsorship-v1/opportunities/createopportunity","metadata":{"seo":{"title":"Creates a new opportunity record that does not already exist.","description":"This method will auto-generate an ID and create a new opportunity. If an ID is specified for the opportunity, an error will be thrown."}},"httpPath":"/opportunities/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/opportunities/executebatchoperations","routeSlug":"/apis/sponsorship/sponsorship-v1/opportunities/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/opportunities/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/opportunities/listopportunitiesbyeventid","routeSlug":"/apis/sponsorship/sponsorship-v1/opportunities/listopportunitiesbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/opportunities/{tenantId}/event/{event_id}"},{"label":"Gets all of the opportunities in the system for a given contact and organization.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/opportunities/listopportunitiesforportal","routeSlug":"/apis/sponsorship/sponsorship-v1/opportunities/listopportunitiesforportal","metadata":{"seo":{"title":"Gets all of the opportunities in the system for a given contact and organization.","description":"This method will scan all opportunities and and return them to the caller for a given contact and organization."}},"httpPath":"/opportunities/{tenantId}/portal/{contactId}/{organizationId}"},{"label":"Searches for opportunities using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/opportunities/searchforopportunities","routeSlug":"/apis/sponsorship/sponsorship-v1/opportunities/searchforopportunities","metadata":{"seo":{"title":"Searches for opportunities using predefined parameters","description":"Searches for opportunities using predefined parameters"}},"httpPath":"/opportunities/{tenantId}/search"},{"label":"Returns a opportunity from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/opportunities/deleteopportunity","routeSlug":"/apis/sponsorship/sponsorship-v1/opportunities/deleteopportunity","metadata":{"seo":{"title":"Returns a opportunity from the system by its ID.","description":"This method will delete a opportunity with the specified ID."}},"httpPath":"/opportunities/{tenantId}/{id}"},{"label":"Returns a opportunity from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/opportunities/getopportunity","routeSlug":"/apis/sponsorship/sponsorship-v1/opportunities/getopportunity","metadata":{"seo":{"title":"Returns a opportunity from the system by its ID.","description":"This method will look up a opportunity by the specified ID and return it back."}},"httpPath":"/opportunities/{tenantId}/{id}"},{"label":"Partially updates a opportunity with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/opportunities/patchopportunity","routeSlug":"/apis/sponsorship/sponsorship-v1/opportunities/patchopportunity","metadata":{"seo":{"title":"Partially updates a opportunity with the specified ID.","description":"This method will patch an existing opportunity with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/opportunities/{tenantId}/{id}"},{"label":"Updates a opportunity with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/opportunities/updateopportunity","routeSlug":"/apis/sponsorship/sponsorship-v1/opportunities/updateopportunity","metadata":{"seo":{"title":"Updates a opportunity with the specified ID.","description":"This method will update an existing opportunity with the specified ID."}},"httpPath":"/opportunities/{tenantId}/{id}"}]},{"type":"group","label":"Profiles","link":"/apis/sponsorship/sponsorship-v1/profiles","routeSlug":"/apis/sponsorship/sponsorship-v1/profiles","items":[{"label":"Creates a new profile record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/profiles/createprofile","routeSlug":"/apis/sponsorship/sponsorship-v1/profiles/createprofile","metadata":{"seo":{"title":"Creates a new profile record that does not already exist.","description":"This method will auto-generate an ID and create a new profile. If an ID is specified for the profile, an error will be thrown."}},"httpPath":"/profiles/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/profiles/executebatchoperations","routeSlug":"/apis/sponsorship/sponsorship-v1/profiles/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/profiles/{tenantId}/batch"},{"label":"Returns a profile from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/profiles/deleteprofile","routeSlug":"/apis/sponsorship/sponsorship-v1/profiles/deleteprofile","metadata":{"seo":{"title":"Returns a profile from the system by its ID.","description":"This method will delete a profile with the specified ID."}},"httpPath":"/profiles/{tenantId}/{id}"},{"label":"Returns a profile from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/profiles/getprofile","routeSlug":"/apis/sponsorship/sponsorship-v1/profiles/getprofile","metadata":{"seo":{"title":"Returns a profile from the system by its ID.","description":"This method will look up a profile by the specified ID and return it back."}},"httpPath":"/profiles/{tenantId}/{id}"},{"label":"Partially updates a profile with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/profiles/patchprofile","routeSlug":"/apis/sponsorship/sponsorship-v1/profiles/patchprofile","metadata":{"seo":{"title":"Partially updates a profile with the specified ID.","description":"This method will patch an existing profile with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/profiles/{tenantId}/{id}"},{"label":"Updates a profile with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/profiles/updateprofile","routeSlug":"/apis/sponsorship/sponsorship-v1/profiles/updateprofile","metadata":{"seo":{"title":"Updates a profile with the specified ID.","description":"This method will update an existing profile with the specified ID."}},"httpPath":"/profiles/{tenantId}/{id}"}]},{"type":"group","label":"Query Definitions","link":"/apis/sponsorship/sponsorship-v1/query-definitions","routeSlug":"/apis/sponsorship/sponsorship-v1/query-definitions","items":[{"label":"Returns a list of records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/query-definitions/getquerydefinitions","routeSlug":"/apis/sponsorship/sponsorship-v1/query-definitions/getquerydefinitions","metadata":{"seo":{"title":"Returns a list of records","description":"Returns a list of records"}},"httpPath":"/queryDefinitions/{tenantId}"}]},{"type":"group","label":"Settings","link":"/apis/sponsorship/sponsorship-v1/settings","routeSlug":"/apis/sponsorship/sponsorship-v1/settings","items":[{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/settings/deletesetting","routeSlug":"/apis/sponsorship/sponsorship-v1/settings/deletesetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will delete a setting with the specified ID."}},"httpPath":"/settings/{tenantId}"},{"label":"Returns a setting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/settings/getsetting","routeSlug":"/apis/sponsorship/sponsorship-v1/settings/getsetting","metadata":{"seo":{"title":"Returns a setting from the system by its ID.","description":"This method will look up a setting by the specified ID and return it back."}},"httpPath":"/settings/{tenantId}"},{"label":"Partially updates a setting with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/settings/patchsetting","routeSlug":"/apis/sponsorship/sponsorship-v1/settings/patchsetting","metadata":{"seo":{"title":"Partially updates a setting with the specified ID.","description":"This method will patch an existing setting with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/settings/{tenantId}"},{"label":"Creates a new setting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/settings/createsetting","routeSlug":"/apis/sponsorship/sponsorship-v1/settings/createsetting","metadata":{"seo":{"title":"Creates a new setting record that does not already exist.","description":"This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, an error will be thrown."}},"httpPath":"/settings/{tenantId}"},{"label":"Updates a setting with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/settings/updatesetting","routeSlug":"/apis/sponsorship/sponsorship-v1/settings/updatesetting","metadata":{"seo":{"title":"Updates a setting with the specified ID.","description":"This method will update an existing setting with the specified ID."}},"httpPath":"/settings/{tenantId}"}]},{"type":"group","label":"Sponsorships","link":"/apis/sponsorship/sponsorship-v1/sponsorships","routeSlug":"/apis/sponsorship/sponsorship-v1/sponsorships","items":[{"label":"Creates a new sponsorship record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/sponsorships/createsponsorship","routeSlug":"/apis/sponsorship/sponsorship-v1/sponsorships/createsponsorship","metadata":{"seo":{"title":"Creates a new sponsorship record that does not already exist.","description":"This method will auto-generate an ID and create a new sponsorship. If an ID is specified for the sponsorship, an error will be thrown."}},"httpPath":"/sponsorships/{tenantId}"},{"label":"Activates a sposorship for specific application","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/sponsorships/activatesponsorship","routeSlug":"/apis/sponsorship/sponsorship-v1/sponsorships/activatesponsorship","metadata":{"seo":{"title":"Activates a sposorship for specific application","description":"Activates a sposorship for specific application"}},"httpPath":"/sponsorships/{tenantId}/activate/{application_id}/{opportunity_id}"},{"label":"Returns a list of records with the specified application_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/sponsorships/listsponsorshipsbyapplicationid","routeSlug":"/apis/sponsorship/sponsorship-v1/sponsorships/listsponsorshipsbyapplicationid","metadata":{"seo":{"title":"Returns a list of records with the specified application_id","description":"Returns a list of records with the specified application_id"}},"httpPath":"/sponsorships/{tenantId}/application/{application_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/sponsorships/executebatchoperations","routeSlug":"/apis/sponsorship/sponsorship-v1/sponsorships/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/sponsorships/{tenantId}/batch"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/sponsorships/listsponsorshipsbyeventid","routeSlug":"/apis/sponsorship/sponsorship-v1/sponsorships/listsponsorshipsbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/sponsorships/{tenantId}/event/{event_id}"},{"label":"Returns a list of records with the specified event_organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/sponsorships/listsponsorshipsbyeventorganizationid","routeSlug":"/apis/sponsorship/sponsorship-v1/sponsorships/listsponsorshipsbyeventorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified event_organization_id","description":"Returns a list of records with the specified event_organization_id"}},"httpPath":"/sponsorships/{tenantId}/eventOrganization/{event_id}/{organization_id}"},{"label":"Returns a list of records with the specified opportunity_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/sponsorships/listsponsorshipsbyopportunityid","routeSlug":"/apis/sponsorship/sponsorship-v1/sponsorships/listsponsorshipsbyopportunityid","metadata":{"seo":{"title":"Returns a list of records with the specified opportunity_id","description":"Returns a list of records with the specified opportunity_id"}},"httpPath":"/sponsorships/{tenantId}/opportunity/{opportunity_id}"},{"label":"Returns a list of records with the specified order_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/sponsorships/listsponsorshipsbyorderid","routeSlug":"/apis/sponsorship/sponsorship-v1/sponsorships/listsponsorshipsbyorderid","metadata":{"seo":{"title":"Returns a list of records with the specified order_id","description":"Returns a list of records with the specified order_id"}},"httpPath":"/sponsorships/{tenantId}/order/{order_id}"},{"label":"Returns a list of records with the specified organization_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/sponsorships/listsponsorshipsbyorganizationid","routeSlug":"/apis/sponsorship/sponsorship-v1/sponsorships/listsponsorshipsbyorganizationid","metadata":{"seo":{"title":"Returns a list of records with the specified organization_id","description":"Returns a list of records with the specified organization_id"}},"httpPath":"/sponsorships/{tenantId}/organization/{organization_id}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/sponsorships/previewemail","routeSlug":"/apis/sponsorship/sponsorship-v1/sponsorships/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/sponsorships/{tenantId}/previewEmail"},{"label":"Searches for sponsorships using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/sponsorships/searchforsponsorships","routeSlug":"/apis/sponsorship/sponsorship-v1/sponsorships/searchforsponsorships","metadata":{"seo":{"title":"Searches for sponsorships using predefined parameters","description":"Searches for sponsorships using predefined parameters"}},"httpPath":"/sponsorships/{tenantId}/search"},{"label":"Returns a sponsorship from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/sponsorships/deletesponsorship","routeSlug":"/apis/sponsorship/sponsorship-v1/sponsorships/deletesponsorship","metadata":{"seo":{"title":"Returns a sponsorship from the system by its ID.","description":"This method will delete a sponsorship with the specified ID."}},"httpPath":"/sponsorships/{tenantId}/{id}"},{"label":"Returns a sponsorship from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/sponsorships/getsponsorship","routeSlug":"/apis/sponsorship/sponsorship-v1/sponsorships/getsponsorship","metadata":{"seo":{"title":"Returns a sponsorship from the system by its ID.","description":"This method will look up a sponsorship by the specified ID and return it back."}},"httpPath":"/sponsorships/{tenantId}/{id}"},{"label":"Partially updates a sponsorship with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/sponsorships/patchsponsorship","routeSlug":"/apis/sponsorship/sponsorship-v1/sponsorships/patchsponsorship","metadata":{"seo":{"title":"Partially updates a sponsorship with the specified ID.","description":"This method will patch an existing sponsorship with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/sponsorships/{tenantId}/{id}"},{"label":"Updates a sponsorship with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/sponsorships/updatesponsorship","routeSlug":"/apis/sponsorship/sponsorship-v1/sponsorships/updatesponsorship","metadata":{"seo":{"title":"Updates a sponsorship with the specified ID.","description":"This method will update an existing sponsorship with the specified ID."}},"httpPath":"/sponsorships/{tenantId}/{id}"}]},{"type":"group","label":"Statistics","link":"/apis/sponsorship/sponsorship-v1/statistics","routeSlug":"/apis/sponsorship/sponsorship-v1/statistics","items":[{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/statistics/executebatchoperations","routeSlug":"/apis/sponsorship/sponsorship-v1/statistics/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/statistics/{tenantId}/batch"},{"label":"Returns a statistic from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/sponsorship/sponsorship-v1/statistics/getstatistic","routeSlug":"/apis/sponsorship/sponsorship-v1/statistics/getstatistic","metadata":{"seo":{"title":"Returns a statistic from the system by its ID.","description":"This method will look up a statistic by the specified ID and return it back."}},"httpPath":"/statistics/{tenantId}/{id}"}]}]},{"type":"group","label":"Submissions","items":[{"type":"link","label":"Submissions","link":"/apis/submissions/submissions-v1","routeSlug":"/apis/submissions/submissions-v1"},{"type":"group","label":"Processes","link":"/apis/submissions/submissions-v1/processes","routeSlug":"/apis/submissions/submissions-v1/processes","items":[{"label":"Creates a new process record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/processes/createprocess","routeSlug":"/apis/submissions/submissions-v1/processes/createprocess","metadata":{"seo":{"title":"Creates a new process record that does not already exist.","description":"This method will auto-generate an ID and create a new process. If an ID is specified for the process, an error will be thrown."}},"httpPath":"/processes/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/processes/executebatchoperations","routeSlug":"/apis/submissions/submissions-v1/processes/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/processes/{tenantId}/batch"},{"label":"Returns a list of records with the specified space_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/processes/listprocessesbyspaceid","routeSlug":"/apis/submissions/submissions-v1/processes/listprocessesbyspaceid","metadata":{"seo":{"title":"Returns a list of records with the specified space_id","description":"Returns a list of records with the specified space_id"}},"httpPath":"/processes/{tenantId}/space/{space_id}"},{"label":"Returns a process from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/processes/deleteprocess","routeSlug":"/apis/submissions/submissions-v1/processes/deleteprocess","metadata":{"seo":{"title":"Returns a process from the system by its ID.","description":"This method will delete a process with the specified ID."}},"httpPath":"/processes/{tenantId}/{id}"},{"label":"Returns a process from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/processes/getprocess","routeSlug":"/apis/submissions/submissions-v1/processes/getprocess","metadata":{"seo":{"title":"Returns a process from the system by its ID.","description":"This method will look up a process by the specified ID and return it back."}},"httpPath":"/processes/{tenantId}/{id}"},{"label":"Partially updates a process with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/processes/patchprocess","routeSlug":"/apis/submissions/submissions-v1/processes/patchprocess","metadata":{"seo":{"title":"Partially updates a process with the specified ID.","description":"This method will patch an existing process with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/processes/{tenantId}/{id}"},{"label":"Updates a process with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/processes/updateprocess","routeSlug":"/apis/submissions/submissions-v1/processes/updateprocess","metadata":{"seo":{"title":"Updates a process with the specified ID.","description":"This method will update an existing process with the specified ID."}},"httpPath":"/processes/{tenantId}/{id}"}]},{"type":"group","label":"Query Definitions","link":"/apis/submissions/submissions-v1/query-definitions","routeSlug":"/apis/submissions/submissions-v1/query-definitions","items":[{"label":"Returns a list of records","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/query-definitions/getquerydefinitions","routeSlug":"/apis/submissions/submissions-v1/query-definitions/getquerydefinitions","metadata":{"seo":{"title":"Returns a list of records","description":"Returns a list of records"}},"httpPath":"/queryDefinitions/{tenantId}"}]},{"type":"group","label":"Review Buckets","link":"/apis/submissions/submissions-v1/review-buckets","routeSlug":"/apis/submissions/submissions-v1/review-buckets","items":[{"label":"Creates a new review bucket record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-buckets/createreviewbucket","routeSlug":"/apis/submissions/submissions-v1/review-buckets/createreviewbucket","metadata":{"seo":{"title":"Creates a new review bucket record that does not already exist.","description":"This method will auto-generate an ID and create a new review bucket. If an ID is specified for the review bucket, an error will be thrown."}},"httpPath":"/reviewBuckets/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-buckets/executebatchoperations","routeSlug":"/apis/submissions/submissions-v1/review-buckets/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/reviewBuckets/{tenantId}/batch"},{"label":"Returns a list of records with the specified space_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-buckets/listbucketsbyspaceid","routeSlug":"/apis/submissions/submissions-v1/review-buckets/listbucketsbyspaceid","metadata":{"seo":{"title":"Returns a list of records with the specified space_id","description":"Returns a list of records with the specified space_id"}},"httpPath":"/reviewBuckets/{tenantId}/space/{space_id}"},{"label":"Returns a review bucket from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-buckets/deletereviewbucket","routeSlug":"/apis/submissions/submissions-v1/review-buckets/deletereviewbucket","metadata":{"seo":{"title":"Returns a review bucket from the system by its ID.","description":"This method will delete a review bucket with the specified ID."}},"httpPath":"/reviewBuckets/{tenantId}/{id}"},{"label":"Returns a review bucket from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-buckets/getreviewbucket","routeSlug":"/apis/submissions/submissions-v1/review-buckets/getreviewbucket","metadata":{"seo":{"title":"Returns a review bucket from the system by its ID.","description":"This method will look up a review bucket by the specified ID and return it back."}},"httpPath":"/reviewBuckets/{tenantId}/{id}"},{"label":"Partially updates a review bucket with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-buckets/patchreviewbucket","routeSlug":"/apis/submissions/submissions-v1/review-buckets/patchreviewbucket","metadata":{"seo":{"title":"Partially updates a review bucket with the specified ID.","description":"This method will patch an existing review bucket with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/reviewBuckets/{tenantId}/{id}"},{"label":"Updates a review bucket with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-buckets/updatereviewbucket","routeSlug":"/apis/submissions/submissions-v1/review-buckets/updatereviewbucket","metadata":{"seo":{"title":"Updates a review bucket with the specified ID.","description":"This method will update an existing review bucket with the specified ID."}},"httpPath":"/reviewBuckets/{tenantId}/{id}"}]},{"type":"group","label":"Review Rounds","link":"/apis/submissions/submissions-v1/review-rounds","routeSlug":"/apis/submissions/submissions-v1/review-rounds","items":[{"label":"Creates a new review round record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-rounds/createreviewround","routeSlug":"/apis/submissions/submissions-v1/review-rounds/createreviewround","metadata":{"seo":{"title":"Creates a new review round record that does not already exist.","description":"This method will auto-generate an ID and create a new review round. If an ID is specified for the review round, an error will be thrown."}},"httpPath":"/reviewRounds/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-rounds/executebatchoperations","routeSlug":"/apis/submissions/submissions-v1/review-rounds/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/reviewRounds/{tenantId}/batch"},{"label":"Returns a list of records with the specified space_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-rounds/listroundsbyspaceid","routeSlug":"/apis/submissions/submissions-v1/review-rounds/listroundsbyspaceid","metadata":{"seo":{"title":"Returns a list of records with the specified space_id","description":"Returns a list of records with the specified space_id"}},"httpPath":"/reviewRounds/{tenantId}/space/{space_id}"},{"label":"Returns a review round from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-rounds/deletereviewround","routeSlug":"/apis/submissions/submissions-v1/review-rounds/deletereviewround","metadata":{"seo":{"title":"Returns a review round from the system by its ID.","description":"This method will delete a review round with the specified ID."}},"httpPath":"/reviewRounds/{tenantId}/{id}"},{"label":"Returns a review round from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-rounds/getreviewround","routeSlug":"/apis/submissions/submissions-v1/review-rounds/getreviewround","metadata":{"seo":{"title":"Returns a review round from the system by its ID.","description":"This method will look up a review round by the specified ID and return it back."}},"httpPath":"/reviewRounds/{tenantId}/{id}"},{"label":"Partially updates a review round with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-rounds/patchreviewround","routeSlug":"/apis/submissions/submissions-v1/review-rounds/patchreviewround","metadata":{"seo":{"title":"Partially updates a review round with the specified ID.","description":"This method will patch an existing review round with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/reviewRounds/{tenantId}/{id}"},{"label":"Updates a review round with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-rounds/updatereviewround","routeSlug":"/apis/submissions/submissions-v1/review-rounds/updatereviewround","metadata":{"seo":{"title":"Updates a review round with the specified ID.","description":"This method will update an existing review round with the specified ID."}},"httpPath":"/reviewRounds/{tenantId}/{id}"}]},{"type":"group","label":"Review Settings","link":"/apis/submissions/submissions-v1/review-settings","routeSlug":"/apis/submissions/submissions-v1/review-settings","items":[{"label":"Creates a new review setting record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-settings/createreviewsetting","routeSlug":"/apis/submissions/submissions-v1/review-settings/createreviewsetting","metadata":{"seo":{"title":"Creates a new review setting record that does not already exist.","description":"This method will auto-generate an ID and create a new review setting. If an ID is specified for the review setting, an error will be thrown."}},"httpPath":"/reviewSettings/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-settings/executebatchoperations","routeSlug":"/apis/submissions/submissions-v1/review-settings/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/reviewSettings/{tenantId}/batch"},{"label":"Returns a review setting from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-settings/deletereviewsetting","routeSlug":"/apis/submissions/submissions-v1/review-settings/deletereviewsetting","metadata":{"seo":{"title":"Returns a review setting from the system by its ID.","description":"This method will delete a review setting with the specified ID."}},"httpPath":"/reviewSettings/{tenantId}/{id}"},{"label":"Returns a review setting from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-settings/getreviewsetting","routeSlug":"/apis/submissions/submissions-v1/review-settings/getreviewsetting","metadata":{"seo":{"title":"Returns a review setting from the system by its ID.","description":"This method will look up a review setting by the specified ID and return it back."}},"httpPath":"/reviewSettings/{tenantId}/{id}"},{"label":"Partially updates a review setting with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-settings/patchreviewsetting","routeSlug":"/apis/submissions/submissions-v1/review-settings/patchreviewsetting","metadata":{"seo":{"title":"Partially updates a review setting with the specified ID.","description":"This method will patch an existing review setting with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/reviewSettings/{tenantId}/{id}"},{"label":"Updates a review setting with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-settings/updatereviewsetting","routeSlug":"/apis/submissions/submissions-v1/review-settings/updatereviewsetting","metadata":{"seo":{"title":"Updates a review setting with the specified ID.","description":"This method will update an existing review setting with the specified ID."}},"httpPath":"/reviewSettings/{tenantId}/{id}"}]},{"type":"group","label":"Review Teams","link":"/apis/submissions/submissions-v1/review-teams","routeSlug":"/apis/submissions/submissions-v1/review-teams","items":[{"label":"Creates a new review team record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-teams/createreviewteam","routeSlug":"/apis/submissions/submissions-v1/review-teams/createreviewteam","metadata":{"seo":{"title":"Creates a new review team record that does not already exist.","description":"This method will auto-generate an ID and create a new review team. If an ID is specified for the review team, an error will be thrown."}},"httpPath":"/reviewTeams/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-teams/executebatchoperations","routeSlug":"/apis/submissions/submissions-v1/review-teams/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/reviewTeams/{tenantId}/batch"},{"label":"Returns a list of records with the specified space_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-teams/listteamsbyspaceid","routeSlug":"/apis/submissions/submissions-v1/review-teams/listteamsbyspaceid","metadata":{"seo":{"title":"Returns a list of records with the specified space_id","description":"Returns a list of records with the specified space_id"}},"httpPath":"/reviewTeams/{tenantId}/space/{space_id}"},{"label":"Gets access permissions to round/buckets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-teams/getsubmissionaccessforspace","routeSlug":"/apis/submissions/submissions-v1/review-teams/getsubmissionaccessforspace","metadata":{"seo":{"title":"Gets access permissions to round/buckets","description":"Based on a person's team memberships, determines which rounds/buckets they have access to"}},"httpPath":"/reviewTeams/{tenantId}/submissionAccess/{spaceId}/{contactId}"},{"label":"Get Team Memberships","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-teams/listteamsforcontactid","routeSlug":"/apis/submissions/submissions-v1/review-teams/listteamsforcontactid","metadata":{"seo":{"title":"Get Team Memberships","description":"Returns a list of team members for a contact"}},"httpPath":"/reviewTeams/{tenantId}/teamMemberships/{contactId}"},{"label":"Get Team Memberships by Space for a given contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-teams/listteamsforspaceandcontactid","routeSlug":"/apis/submissions/submissions-v1/review-teams/listteamsforspaceandcontactid","metadata":{"seo":{"title":"Get Team Memberships by Space for a given contact","description":"Returns a list of team members for a contact in a given space"}},"httpPath":"/reviewTeams/{tenantId}/teamMembershipsForSpace/{spaceId}/{contactId}"},{"label":"Returns a review team from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-teams/deletereviewteam","routeSlug":"/apis/submissions/submissions-v1/review-teams/deletereviewteam","metadata":{"seo":{"title":"Returns a review team from the system by its ID.","description":"This method will delete a review team with the specified ID."}},"httpPath":"/reviewTeams/{tenantId}/{id}"},{"label":"Returns a review team from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-teams/getreviewteam","routeSlug":"/apis/submissions/submissions-v1/review-teams/getreviewteam","metadata":{"seo":{"title":"Returns a review team from the system by its ID.","description":"This method will look up a review team by the specified ID and return it back."}},"httpPath":"/reviewTeams/{tenantId}/{id}"},{"label":"Partially updates a review team with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-teams/patchreviewteam","routeSlug":"/apis/submissions/submissions-v1/review-teams/patchreviewteam","metadata":{"seo":{"title":"Partially updates a review team with the specified ID.","description":"This method will patch an existing review team with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/reviewTeams/{tenantId}/{id}"},{"label":"Updates a review team with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/review-teams/updatereviewteam","routeSlug":"/apis/submissions/submissions-v1/review-teams/updatereviewteam","metadata":{"seo":{"title":"Updates a review team with the specified ID.","description":"This method will update an existing review team with the specified ID."}},"httpPath":"/reviewTeams/{tenantId}/{id}"}]},{"type":"group","label":"Reviewer Decline Reasons","link":"/apis/submissions/submissions-v1/reviewer-decline-reasons","routeSlug":"/apis/submissions/submissions-v1/reviewer-decline-reasons","items":[{"label":"Gets all of the reviewer decline reasons in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviewer-decline-reasons/listreviewerdeclinereasons","routeSlug":"/apis/submissions/submissions-v1/reviewer-decline-reasons/listreviewerdeclinereasons","metadata":{"seo":{"title":"Gets all of the reviewer decline reasons in the system.","description":"This method will scan all reviewer decline reasons and and return them to the caller."}},"httpPath":"/reviewerDeclineReasons/{tenantId}"},{"label":"Creates a new reviewer decline reason record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviewer-decline-reasons/createreviewerdeclinereason","routeSlug":"/apis/submissions/submissions-v1/reviewer-decline-reasons/createreviewerdeclinereason","metadata":{"seo":{"title":"Creates a new reviewer decline reason record that does not already exist.","description":"This method will auto-generate an ID and create a new reviewer decline reason. If an ID is specified for the reviewer decline reason, an error will be thrown."}},"httpPath":"/reviewerDeclineReasons/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviewer-decline-reasons/executebatchoperations","routeSlug":"/apis/submissions/submissions-v1/reviewer-decline-reasons/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/reviewerDeclineReasons/{tenantId}/batch"},{"label":"Returns a reviewer decline reason from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviewer-decline-reasons/deletereviewerdeclinereason","routeSlug":"/apis/submissions/submissions-v1/reviewer-decline-reasons/deletereviewerdeclinereason","metadata":{"seo":{"title":"Returns a reviewer decline reason from the system by its ID.","description":"This method will delete a reviewer decline reason with the specified ID."}},"httpPath":"/reviewerDeclineReasons/{tenantId}/{id}"},{"label":"Returns a reviewer decline reason from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviewer-decline-reasons/getreviewerdeclinereason","routeSlug":"/apis/submissions/submissions-v1/reviewer-decline-reasons/getreviewerdeclinereason","metadata":{"seo":{"title":"Returns a reviewer decline reason from the system by its ID.","description":"This method will look up a reviewer decline reason by the specified ID and return it back."}},"httpPath":"/reviewerDeclineReasons/{tenantId}/{id}"},{"label":"Partially updates a reviewer decline reason with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviewer-decline-reasons/patchreviewerdeclinereason","routeSlug":"/apis/submissions/submissions-v1/reviewer-decline-reasons/patchreviewerdeclinereason","metadata":{"seo":{"title":"Partially updates a reviewer decline reason with the specified ID.","description":"This method will patch an existing reviewer decline reason with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/reviewerDeclineReasons/{tenantId}/{id}"},{"label":"Updates a reviewer decline reason with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviewer-decline-reasons/updatereviewerdeclinereason","routeSlug":"/apis/submissions/submissions-v1/reviewer-decline-reasons/updatereviewerdeclinereason","metadata":{"seo":{"title":"Updates a reviewer decline reason with the specified ID.","description":"This method will update an existing reviewer decline reason with the specified ID."}},"httpPath":"/reviewerDeclineReasons/{tenantId}/{id}"}]},{"type":"group","label":"Reviewers","link":"/apis/submissions/submissions-v1/reviewers","routeSlug":"/apis/submissions/submissions-v1/reviewers","items":[{"label":"Creates a new reviewer record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviewers/createreviewer","routeSlug":"/apis/submissions/submissions-v1/reviewers/createreviewer","metadata":{"seo":{"title":"Creates a new reviewer record that does not already exist.","description":"This method will auto-generate an ID and create a new reviewer. If an ID is specified for the reviewer, an error will be thrown."}},"httpPath":"/reviewers/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviewers/executebatchoperations","routeSlug":"/apis/submissions/submissions-v1/reviewers/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/reviewers/{tenantId}/batch"},{"label":"Returns a list of records with the specified contact_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviewers/listreviewersbycontactid","routeSlug":"/apis/submissions/submissions-v1/reviewers/listreviewersbycontactid","metadata":{"seo":{"title":"Returns a list of records with the specified contact_id","description":"Returns a list of records with the specified contact_id"}},"httpPath":"/reviewers/{tenantId}/contact/{contact_id}"},{"label":"Returns a list of records with the specified review_team_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviewers/listreviewersbyreviewteamid","routeSlug":"/apis/submissions/submissions-v1/reviewers/listreviewersbyreviewteamid","metadata":{"seo":{"title":"Returns a list of records with the specified review_team_id","description":"Returns a list of records with the specified review_team_id"}},"httpPath":"/reviewers/{tenantId}/reviewTeam/{review_team_id}"},{"label":"Returns a list of records with the specified round & bucket id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviewers/listreviewersbyroundbucketid","routeSlug":"/apis/submissions/submissions-v1/reviewers/listreviewersbyroundbucketid","metadata":{"seo":{"title":"Returns a list of records with the specified round & bucket id","description":"Returns a list of records with the specified round_id & bucket_id"}},"httpPath":"/reviewers/{tenantId}/roundBucket/{round_id}/{bucket_id}"},{"label":"Returns a list of records with the specified space_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviewers/listreviewersbyspaceid","routeSlug":"/apis/submissions/submissions-v1/reviewers/listreviewersbyspaceid","metadata":{"seo":{"title":"Returns a list of records with the specified space_id","description":"Returns a list of records with the specified space_id"}},"httpPath":"/reviewers/{tenantId}/space/{space_id}"},{"label":"Returns a list of records with the specified submission_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviewers/listreviewersbysubmissionid","routeSlug":"/apis/submissions/submissions-v1/reviewers/listreviewersbysubmissionid","metadata":{"seo":{"title":"Returns a list of records with the specified submission_id","description":"Returns a list of records with the specified submission_id"}},"httpPath":"/reviewers/{tenantId}/submission/{submission_id}"},{"label":"Returns a reviewer from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviewers/deletereviewer","routeSlug":"/apis/submissions/submissions-v1/reviewers/deletereviewer","metadata":{"seo":{"title":"Returns a reviewer from the system by its ID.","description":"This method will delete a reviewer with the specified ID."}},"httpPath":"/reviewers/{tenantId}/{id}"},{"label":"Returns a reviewer from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviewers/getreviewer","routeSlug":"/apis/submissions/submissions-v1/reviewers/getreviewer","metadata":{"seo":{"title":"Returns a reviewer from the system by its ID.","description":"This method will look up a reviewer by the specified ID and return it back."}},"httpPath":"/reviewers/{tenantId}/{id}"},{"label":"Partially updates a reviewer with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviewers/patchreviewer","routeSlug":"/apis/submissions/submissions-v1/reviewers/patchreviewer","metadata":{"seo":{"title":"Partially updates a reviewer with the specified ID.","description":"This method will patch an existing reviewer with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/reviewers/{tenantId}/{id}"},{"label":"Updates a reviewer with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviewers/updatereviewer","routeSlug":"/apis/submissions/submissions-v1/reviewers/updatereviewer","metadata":{"seo":{"title":"Updates a reviewer with the specified ID.","description":"This method will update an existing reviewer with the specified ID."}},"httpPath":"/reviewers/{tenantId}/{id}"}]},{"type":"group","label":"Reviews","link":"/apis/submissions/submissions-v1/reviews","routeSlug":"/apis/submissions/submissions-v1/reviews","items":[{"label":"Creates a new review record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviews/createreview","routeSlug":"/apis/submissions/submissions-v1/reviews/createreview","metadata":{"seo":{"title":"Creates a new review record that does not already exist.","description":"This method will auto-generate an ID and create a new review. If an ID is specified for the review, an error will be thrown."}},"httpPath":"/reviews/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviews/executebatchoperations","routeSlug":"/apis/submissions/submissions-v1/reviews/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/reviews/{tenantId}/batch"},{"label":"Returns a list of records with the specified bucket_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviews/listreviewsbybucketid","routeSlug":"/apis/submissions/submissions-v1/reviews/listreviewsbybucketid","metadata":{"seo":{"title":"Returns a list of records with the specified bucket_id","description":"Returns a list of records with the specified bucket_id"}},"httpPath":"/reviews/{tenantId}/bucket/{bucket_id}"},{"label":"Check if Editable","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviews/checkifeditable","routeSlug":"/apis/submissions/submissions-v1/reviews/checkifeditable","metadata":{"seo":{"title":"Check if Editable","description":"Checks to see if a review can be edited by a contact"}},"httpPath":"/reviews/{tenantId}/canEdit/{id}/{contactId}"},{"label":"Downloads all Reviews to CSV","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviews/downloadreviewstocsv","routeSlug":"/apis/submissions/submissions-v1/reviews/downloadreviewstocsv","metadata":{"seo":{"title":"Downloads all Reviews to CSV","description":"Returns a CSV file with all review info + scores"}},"httpPath":"/reviews/{tenantId}/download/{spaceId}"},{"label":"Get review progress info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviews/getreviewprogress","routeSlug":"/apis/submissions/submissions-v1/reviews/getreviewprogress","metadata":{"seo":{"title":"Get review progress info","description":"Get progress info for reviews"}},"httpPath":"/reviews/{tenantId}/progress/{spaceId}"},{"label":"Returns a list of records with the specified review_team_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviews/listreviewsbyreviewteamid","routeSlug":"/apis/submissions/submissions-v1/reviews/listreviewsbyreviewteamid","metadata":{"seo":{"title":"Returns a list of records with the specified review_team_id","description":"Returns a list of records with the specified review_team_id"}},"httpPath":"/reviews/{tenantId}/reviewTeam/{review_team_id}"},{"label":"Returns a list of records with the specified reviewer_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviews/listreviewsbyreviewerid","routeSlug":"/apis/submissions/submissions-v1/reviews/listreviewsbyreviewerid","metadata":{"seo":{"title":"Returns a list of records with the specified reviewer_id","description":"Returns a list of records with the specified reviewer_id"}},"httpPath":"/reviews/{tenantId}/reviewer/{reviewer_id}"},{"label":"Returns a list of records with the specified round_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviews/listreviewsbyroundid","routeSlug":"/apis/submissions/submissions-v1/reviews/listreviewsbyroundid","metadata":{"seo":{"title":"Returns a list of records with the specified round_id","description":"Returns a list of records with the specified round_id"}},"httpPath":"/reviews/{tenantId}/round/{round_id}"},{"label":"Searches for reviews using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviews/searchforreviews","routeSlug":"/apis/submissions/submissions-v1/reviews/searchforreviews","metadata":{"seo":{"title":"Searches for reviews using predefined parameters","description":"Searches for reviews using predefined parameters"}},"httpPath":"/reviews/{tenantId}/search"},{"label":"Get by Space/Reviewer","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviews/listreviewsbyspaceamdreviewerid","routeSlug":"/apis/submissions/submissions-v1/reviews/listreviewsbyspaceamdreviewerid","metadata":{"seo":{"title":"Get by Space/Reviewer","description":"Returns a list of records with the specified space_reviewer_id"}},"httpPath":"/reviews/{tenantId}/spaceReviewer/{spaceId}/{reviewerId}"},{"label":"Returns a list of records with the specified submission_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviews/listreviewsbysubmissionid","routeSlug":"/apis/submissions/submissions-v1/reviews/listreviewsbysubmissionid","metadata":{"seo":{"title":"Returns a list of records with the specified submission_id","description":"Returns a list of records with the specified submission_id"}},"httpPath":"/reviews/{tenantId}/submission/{submission_id}"},{"label":"Get submission reviewers for a particular space","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviews/getsubmissionreviewers","routeSlug":"/apis/submissions/submissions-v1/reviews/getsubmissionreviewers","metadata":{"seo":{"title":"Get submission reviewers for a particular space","description":"Returns a list of everyone slated to review a submission"}},"httpPath":"/reviews/{tenantId}/submissionReviewers/{spaceId}"},{"label":"Submits the review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviews/submitreview","routeSlug":"/apis/submissions/submissions-v1/reviews/submitreview","metadata":{"seo":{"title":"Submits the review","description":"Submits a review"}},"httpPath":"/reviews/{tenantId}/submit"},{"label":"Returns a review from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviews/deletereview","routeSlug":"/apis/submissions/submissions-v1/reviews/deletereview","metadata":{"seo":{"title":"Returns a review from the system by its ID.","description":"This method will delete a review with the specified ID."}},"httpPath":"/reviews/{tenantId}/{id}"},{"label":"Returns a review from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviews/getreview","routeSlug":"/apis/submissions/submissions-v1/reviews/getreview","metadata":{"seo":{"title":"Returns a review from the system by its ID.","description":"This method will look up a review by the specified ID and return it back."}},"httpPath":"/reviews/{tenantId}/{id}"},{"label":"Partially updates a review with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviews/patchreview","routeSlug":"/apis/submissions/submissions-v1/reviews/patchreview","metadata":{"seo":{"title":"Partially updates a review with the specified ID.","description":"This method will patch an existing review with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/reviews/{tenantId}/{id}"},{"label":"Updates a review with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/reviews/updatereview","routeSlug":"/apis/submissions/submissions-v1/reviews/updatereview","metadata":{"seo":{"title":"Updates a review with the specified ID.","description":"This method will update an existing review with the specified ID."}},"httpPath":"/reviews/{tenantId}/{id}"}]},{"type":"group","label":"Spaces","link":"/apis/submissions/submissions-v1/spaces","routeSlug":"/apis/submissions/submissions-v1/spaces","items":[{"label":"Creates a new space record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/spaces/createspace","routeSlug":"/apis/submissions/submissions-v1/spaces/createspace","metadata":{"seo":{"title":"Creates a new space record that does not already exist.","description":"This method will auto-generate an ID and create a new space. If an ID is specified for the space, an error will be thrown."}},"httpPath":"/spaces/{tenantId}"},{"label":"Gets accessible spaces","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/spaces/getaccessiblespaces","routeSlug":"/apis/submissions/submissions-v1/spaces/getaccessiblespaces","metadata":{"seo":{"title":"Gets accessible spaces","description":"Returns all spaces for which a contact is a member of a review team"}},"httpPath":"/spaces/{tenantId}/accessible/{contactId}"},{"label":"Returns a list of records with the specified award_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/spaces/listspacesbyawardid","routeSlug":"/apis/submissions/submissions-v1/spaces/listspacesbyawardid","metadata":{"seo":{"title":"Returns a list of records with the specified award_id","description":"Returns a list of records with the specified award_id"}},"httpPath":"/spaces/{tenantId}/award/{award_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/spaces/executebatchoperations","routeSlug":"/apis/submissions/submissions-v1/spaces/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/spaces/{tenantId}/batch"},{"label":"Clone a submission space","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/spaces/clonespace","routeSlug":"/apis/submissions/submissions-v1/spaces/clonespace","metadata":{"seo":{"title":"Clone a submission space","description":"Makes a copy of a submission space, including buckets, rounds, review teams, and reviewers"}},"httpPath":"/spaces/{tenantId}/clone"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/spaces/listspacesbyeventid","routeSlug":"/apis/submissions/submissions-v1/spaces/listspacesbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/spaces/{tenantId}/event/{event_id}"},{"label":"Returns a list of records with the status of open","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/spaces/listopenspaces","routeSlug":"/apis/submissions/submissions-v1/spaces/listopenspaces","metadata":{"seo":{"title":"Returns a list of records with the status of open","description":"Returns a list of records with the status of open"}},"httpPath":"/spaces/{tenantId}/open"},{"label":"Gets reviewable spaces","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/spaces/getreviewablespaces","routeSlug":"/apis/submissions/submissions-v1/spaces/getreviewablespaces","metadata":{"seo":{"title":"Gets reviewable spaces","description":"Returns all spaces for which a contact is a member of a review team"}},"httpPath":"/spaces/{tenantId}/reviewable/{contactId}"},{"label":"Searches for spaces using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/spaces/searchforspaces","routeSlug":"/apis/submissions/submissions-v1/spaces/searchforspaces","metadata":{"seo":{"title":"Searches for spaces using predefined parameters","description":"Searches for spaces using predefined parameters"}},"httpPath":"/spaces/{tenantId}/search"},{"label":"List spaces by type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/spaces/listbytype","routeSlug":"/apis/submissions/submissions-v1/spaces/listbytype","metadata":{"seo":{"title":"List spaces by type","description":"Returns all spaces for a given type"}},"httpPath":"/spaces/{tenantId}/type/{type}"},{"label":"Returns a space from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/spaces/deletespace","routeSlug":"/apis/submissions/submissions-v1/spaces/deletespace","metadata":{"seo":{"title":"Returns a space from the system by its ID.","description":"This method will delete a space with the specified ID."}},"httpPath":"/spaces/{tenantId}/{id}"},{"label":"Returns a space from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/spaces/getspace","routeSlug":"/apis/submissions/submissions-v1/spaces/getspace","metadata":{"seo":{"title":"Returns a space from the system by its ID.","description":"This method will look up a space by the specified ID and return it back."}},"httpPath":"/spaces/{tenantId}/{id}"},{"label":"Partially updates a space with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/spaces/patchspace","routeSlug":"/apis/submissions/submissions-v1/spaces/patchspace","metadata":{"seo":{"title":"Partially updates a space with the specified ID.","description":"This method will patch an existing space with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/spaces/{tenantId}/{id}"},{"label":"Updates a space with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/spaces/updatespace","routeSlug":"/apis/submissions/submissions-v1/spaces/updatespace","metadata":{"seo":{"title":"Updates a space with the specified ID.","description":"This method will update an existing space with the specified ID."}},"httpPath":"/spaces/{tenantId}/{id}"}]},{"type":"group","label":"Statistics","link":"/apis/submissions/submissions-v1/statistics","routeSlug":"/apis/submissions/submissions-v1/statistics","items":[{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/statistics/executebatchoperations","routeSlug":"/apis/submissions/submissions-v1/statistics/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/statistics/{tenantId}/batch"},{"label":"Returns a statistic from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/statistics/getstatistic","routeSlug":"/apis/submissions/submissions-v1/statistics/getstatistic","metadata":{"seo":{"title":"Returns a statistic from the system by its ID.","description":"This method will look up a statistic by the specified ID and return it back."}},"httpPath":"/statistics/{tenantId}/{id}"}]},{"type":"group","label":"Status Reasons","link":"/apis/submissions/submissions-v1/status-reasons","routeSlug":"/apis/submissions/submissions-v1/status-reasons","items":[{"label":"Gets all of the status reasons in the system.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/status-reasons/liststatusreasons","routeSlug":"/apis/submissions/submissions-v1/status-reasons/liststatusreasons","metadata":{"seo":{"title":"Gets all of the status reasons in the system.","description":"This method will scan all status reasons and and return them to the caller."}},"httpPath":"/statusReasons/{tenantId}"},{"label":"Creates a new status reason record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/status-reasons/createstatusreason","routeSlug":"/apis/submissions/submissions-v1/status-reasons/createstatusreason","metadata":{"seo":{"title":"Creates a new status reason record that does not already exist.","description":"This method will auto-generate an ID and create a new status reason. If an ID is specified for the status reason, an error will be thrown."}},"httpPath":"/statusReasons/{tenantId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/status-reasons/executebatchoperations","routeSlug":"/apis/submissions/submissions-v1/status-reasons/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/statusReasons/{tenantId}/batch"},{"label":"Returns a status reason from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/status-reasons/deletestatusreason","routeSlug":"/apis/submissions/submissions-v1/status-reasons/deletestatusreason","metadata":{"seo":{"title":"Returns a status reason from the system by its ID.","description":"This method will delete a status reason with the specified ID."}},"httpPath":"/statusReasons/{tenantId}/{id}"},{"label":"Returns a status reason from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/status-reasons/getstatusreason","routeSlug":"/apis/submissions/submissions-v1/status-reasons/getstatusreason","metadata":{"seo":{"title":"Returns a status reason from the system by its ID.","description":"This method will look up a status reason by the specified ID and return it back."}},"httpPath":"/statusReasons/{tenantId}/{id}"},{"label":"Partially updates a status reason with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/status-reasons/patchstatusreason","routeSlug":"/apis/submissions/submissions-v1/status-reasons/patchstatusreason","metadata":{"seo":{"title":"Partially updates a status reason with the specified ID.","description":"This method will patch an existing status reason with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/statusReasons/{tenantId}/{id}"},{"label":"Updates a status reason with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/status-reasons/updatestatusreason","routeSlug":"/apis/submissions/submissions-v1/status-reasons/updatestatusreason","metadata":{"seo":{"title":"Updates a status reason with the specified ID.","description":"This method will update an existing status reason with the specified ID."}},"httpPath":"/statusReasons/{tenantId}/{id}"}]},{"type":"group","label":"Submissions","link":"/apis/submissions/submissions-v1/submissions","routeSlug":"/apis/submissions/submissions-v1/submissions","items":[{"label":"Creates a new submission record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/createsubmission","routeSlug":"/apis/submissions/submissions-v1/submissions/createsubmission","metadata":{"seo":{"title":"Creates a new submission record that does not already exist.","description":"This method will auto-generate an ID and create a new submission. If an ID is specified for the submission, an error will be thrown."}},"httpPath":"/submissions/{tenantId}"},{"label":"Returns a list of records with the specified award_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/listsubmissionsbyawardid","routeSlug":"/apis/submissions/submissions-v1/submissions/listsubmissionsbyawardid","metadata":{"seo":{"title":"Returns a list of records with the specified award_id","description":"Returns a list of records with the specified award_id"}},"httpPath":"/submissions/{tenantId}/award/{award_id}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/executebatchoperations","routeSlug":"/apis/submissions/submissions-v1/submissions/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/submissions/{tenantId}/batch"},{"label":"Check if Editable","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/checkifeditable","routeSlug":"/apis/submissions/submissions-v1/submissions/checkifeditable","metadata":{"seo":{"title":"Check if Editable","description":"Checks to see if a submission can be edited by a contact"}},"httpPath":"/submissions/{tenantId}/canEdit/{id}/{contactId}"},{"label":"Returns a list of records with the specified event_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/listsubmissionsbyeventid","routeSlug":"/apis/submissions/submissions-v1/submissions/listsubmissionsbyeventid","metadata":{"seo":{"title":"Returns a list of records with the specified event_id","description":"Returns a list of records with the specified event_id"}},"httpPath":"/submissions/{tenantId}/event/{event_id}"},{"label":"Returns a list of records with the specified origin_record_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/listsubmissionsbyoriginrecordid","routeSlug":"/apis/submissions/submissions-v1/submissions/listsubmissionsbyoriginrecordid","metadata":{"seo":{"title":"Returns a list of records with the specified origin_record_id","description":"Returns a list of records with the specified origin_record_id"}},"httpPath":"/submissions/{tenantId}/originRecord/{originService}/{originRecordId}"},{"label":"Returns a list of records with the specified owner_type","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/listsubmissionsbyownertype","routeSlug":"/apis/submissions/submissions-v1/submissions/listsubmissionsbyownertype","metadata":{"seo":{"title":"Returns a list of records with the specified owner_type","description":"Returns a list of records with the specified owner_type"}},"httpPath":"/submissions/{tenantId}/ownerType/{owner_type}/{id}"},{"label":"Sends out a preview of the CRC notification email","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/previewemail","routeSlug":"/apis/submissions/submissions-v1/submissions/previewemail","metadata":{"seo":{"title":"Sends out a preview of the CRC notification email","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/submissions/{tenantId}/previewEmail"},{"label":"Repopulate Space","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/repopulatespace","routeSlug":"/apis/submissions/submissions-v1/submissions/repopulatespace","metadata":{"seo":{"title":"Repopulate Space","description":"Repopulates all submissions in a space and performs an optional wipe"}},"httpPath":"/submissions/{tenantId}/repopulateSpace/{spaceId}"},{"label":"Reprocess Bucket Assignments","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/reprocessautomaticbucketassignment","routeSlug":"/apis/submissions/submissions-v1/submissions/reprocessautomaticbucketassignment","metadata":{"seo":{"title":"Reprocess Bucket Assignments","description":"Goes through all submissions in a space and reassigns to bucket"}},"httpPath":"/submissions/{tenantId}/reprocessAutomaticBucketAssignment/{space_id}"},{"label":"Returns a list of records with the specified review_bucket_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/listsubmissionsbyreviewbucketid","routeSlug":"/apis/submissions/submissions-v1/submissions/listsubmissionsbyreviewbucketid","metadata":{"seo":{"title":"Returns a list of records with the specified review_bucket_id","description":"Returns a list of records with the specified review_bucket_id"}},"httpPath":"/submissions/{tenantId}/reviewBucket/{review_bucket_id}"},{"label":"Returns a list of records with the specified review_round_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/listsubmissionsbyreviewroundid","routeSlug":"/apis/submissions/submissions-v1/submissions/listsubmissionsbyreviewroundid","metadata":{"seo":{"title":"Returns a list of records with the specified review_round_id","description":"Returns a list of records with the specified review_round_id"}},"httpPath":"/submissions/{tenantId}/reviewRound/{review_round_id}"},{"label":"Returns a list of records that are reviewable","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/getreviewablesubmissions","routeSlug":"/apis/submissions/submissions-v1/submissions/getreviewablesubmissions","metadata":{"seo":{"title":"Returns a list of records that are reviewable","description":"Returns a list of records that are reviewable"}},"httpPath":"/submissions/{tenantId}/reviewable/{spaceId}/{contactId}"},{"label":"Get Submissions for Round/Bucket","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/listsubmissionsbyroundandbucket","routeSlug":"/apis/submissions/submissions-v1/submissions/listsubmissionsbyroundandbucket","metadata":{"seo":{"title":"Get Submissions for Round/Bucket","description":"Returns a list of records with the specified round_id and bucket_id"}},"httpPath":"/submissions/{tenantId}/roundBucket/{roundId}/{bucketId}"},{"label":"Searches for submissions using predefined parameters","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/searchforsubmissions","routeSlug":"/apis/submissions/submissions-v1/submissions/searchforsubmissions","metadata":{"seo":{"title":"Searches for submissions using predefined parameters","description":"Searches for submissions using predefined parameters"}},"httpPath":"/submissions/{tenantId}/search"},{"label":"Gets the source record for a submission","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/getsourcerecordforsubmission","routeSlug":"/apis/submissions/submissions-v1/submissions/getsourcerecordforsubmission","metadata":{"seo":{"title":"Gets the source record for a submission","description":"Gets the underlying record for a submission, depending on the submission origin"}},"httpPath":"/submissions/{tenantId}/sourceRecord/{id}"},{"label":"Returns a list of records with the specified space_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/listsubmissionsbyspaceid","routeSlug":"/apis/submissions/submissions-v1/submissions/listsubmissionsbyspaceid","metadata":{"seo":{"title":"Returns a list of records with the specified space_id","description":"Returns a list of records with the specified space_id"}},"httpPath":"/submissions/{tenantId}/space/{space_id}"},{"label":"Returns a list of records with the specified space_owner_type_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/listspacesubmissionsforcontactororganization","routeSlug":"/apis/submissions/submissions-v1/submissions/listspacesubmissionsforcontactororganization","metadata":{"seo":{"title":"Returns a list of records with the specified space_owner_type_id","description":"Returns a list of records with the specified space_owner_type_id"}},"httpPath":"/submissions/{tenantId}/spaceOwner/{spaceId}/{ownerType}/{ownerId}"},{"label":"Submits the submission","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/submitsubmission","routeSlug":"/apis/submissions/submissions-v1/submissions/submitsubmission","metadata":{"seo":{"title":"Submits the submission","description":"Sends out a preview of the CRC notification email"}},"httpPath":"/submissions/{tenantId}/submit"},{"label":"Returns a submission from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/deletesubmission","routeSlug":"/apis/submissions/submissions-v1/submissions/deletesubmission","metadata":{"seo":{"title":"Returns a submission from the system by its ID.","description":"This method will delete a submission with the specified ID."}},"httpPath":"/submissions/{tenantId}/{id}"},{"label":"Returns a submission from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/getsubmission","routeSlug":"/apis/submissions/submissions-v1/submissions/getsubmission","metadata":{"seo":{"title":"Returns a submission from the system by its ID.","description":"This method will look up a submission by the specified ID and return it back."}},"httpPath":"/submissions/{tenantId}/{id}"},{"label":"Partially updates a submission with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/patchsubmission","routeSlug":"/apis/submissions/submissions-v1/submissions/patchsubmission","metadata":{"seo":{"title":"Partially updates a submission with the specified ID.","description":"This method will patch an existing submission with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/submissions/{tenantId}/{id}"},{"label":"Updates a submission with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/submissions/updatesubmission","routeSlug":"/apis/submissions/submissions-v1/submissions/updatesubmission","metadata":{"seo":{"title":"Updates a submission with the specified ID.","description":"This method will update an existing submission with the specified ID."}},"httpPath":"/submissions/{tenantId}/{id}"}]},{"type":"group","label":"Types","link":"/apis/submissions/submissions-v1/types","routeSlug":"/apis/submissions/submissions-v1/types","items":[{"label":"Creates a new type record that does not already exist.","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/types/createtype","routeSlug":"/apis/submissions/submissions-v1/types/createtype","metadata":{"seo":{"title":"Creates a new type record that does not already exist.","description":"This method will auto-generate an ID and create a new type. If an ID is specified for the type, an error will be thrown."}},"httpPath":"/types/{tenantId}"},{"label":"Get Accessible Types for Contact","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/types/getaccessibletypes","routeSlug":"/apis/submissions/submissions-v1/types/getaccessibletypes","metadata":{"seo":{"title":"Get Accessible Types for Contact","description":"For a given contact, returns the submission types available for a space"}},"httpPath":"/types/{tenantId}/accessible/{spaceId}/{contactId}"},{"label":"Execute Batch Operations","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/types/executebatchoperations","routeSlug":"/apis/submissions/submissions-v1/types/executebatchoperations","metadata":{"seo":{"title":"Execute Batch Operations","description":"TAllows you to perform up to 100 parallel patch/delete operations"}},"httpPath":"/types/{tenantId}/batch"},{"label":"Returns a list of records with the specified space_id","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/types/listtypesbyspaceid","routeSlug":"/apis/submissions/submissions-v1/types/listtypesbyspaceid","metadata":{"seo":{"title":"Returns a list of records with the specified space_id","description":"Returns a list of records with the specified space_id"}},"httpPath":"/types/{tenantId}/space/{space_id}"},{"label":"Returns a type from the system by its ID.","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/types/deletetype","routeSlug":"/apis/submissions/submissions-v1/types/deletetype","metadata":{"seo":{"title":"Returns a type from the system by its ID.","description":"This method will delete a type with the specified ID."}},"httpPath":"/types/{tenantId}/{id}"},{"label":"Returns a type from the system by its ID.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/types/gettype","routeSlug":"/apis/submissions/submissions-v1/types/gettype","metadata":{"seo":{"title":"Returns a type from the system by its ID.","description":"This method will look up a type by the specified ID and return it back."}},"httpPath":"/types/{tenantId}/{id}"},{"label":"Partially updates a type with the specified ID.","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/types/patchtype","routeSlug":"/apis/submissions/submissions-v1/types/patchtype","metadata":{"seo":{"title":"Partially updates a type with the specified ID.","description":"This method will patch an existing type with the specified ID, using the HTTP PATCH specification."}},"httpPath":"/types/{tenantId}/{id}"},{"label":"Updates a type with the specified ID.","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/submissions/submissions-v1/types/updatetype","routeSlug":"/apis/submissions/submissions-v1/types/updatetype","metadata":{"seo":{"title":"Updates a type with the specified ID.","description":"This method will update an existing type with the specified ID."}},"httpPath":"/types/{tenantId}/{id}"}]}]},{"type":"group","label":"System","items":[{"type":"link","label":"System","link":"/apis/system/system-v1","routeSlug":"/apis/system/system-v1"},{"type":"group","label":"Queries","link":"/apis/system/system-v1/queries","routeSlug":"/apis/system/system-v1/queries","items":[{"label":"Gets the current status and results for a query that has previously been started","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/system/system-v1/queries/describequery","routeSlug":"/apis/system/system-v1/queries/describequery","metadata":{"seo":{"title":"Gets the current status and results for a query that has previously been started","description":"Gets the current status and results for a query that has previously been started"}},"httpPath":"/queries/{tenantId}/describe/{id}"},{"label":"Gets the definition for a specific type of query including the available fields","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/system/system-v1/queries/describepublicquerytype","routeSlug":"/apis/system/system-v1/queries/describepublicquerytype","metadata":{"seo":{"title":"Gets the definition for a specific type of query including the available fields","description":"Gets the definition for a specific type of query including the available fields"}},"httpPath":"/queries/{tenantId}/public/description/{queryType}"},{"label":"Starts a new query and returns the query id and info","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/system/system-v1/queries/startquery","routeSlug":"/apis/system/system-v1/queries/startquery","metadata":{"seo":{"title":"Starts a new query and returns the query id and info","description":"Starts a new query and returns the query id and info"}},"httpPath":"/queries/{tenantId}/start/{queryType}/{outputFormat}"}]},{"type":"group","label":"Step Functions","link":"/apis/system/system-v1/step-functions","routeSlug":"/apis/system/system-v1/step-functions","items":[{"label":"Gets the current state of an execution","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/system/system-v1/step-functions/describeexecution","routeSlug":"/apis/system/system-v1/step-functions/describeexecution","metadata":{"seo":{"title":"Gets the current state of an execution","description":"Gets the current state of an execution"}},"httpPath":"/stepFunctions/{tenantId}/describe/{executionArn}"},{"label":"Gets the current state of an execution","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/system/system-v1/step-functions/describeexecutionpublic","routeSlug":"/apis/system/system-v1/step-functions/describeexecutionpublic","metadata":{"seo":{"title":"Gets the current state of an execution","description":"Gets the current state of an execution"}},"httpPath":"/stepFunctions/{tenantId}/public/describe/{executionArn}"},{"label":"This method cancels a state machine execution","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/apis/system/system-v1/step-functions/cancelstatemachineexecution","routeSlug":"/apis/system/system-v1/step-functions/cancelstatemachineexecution","metadata":{"seo":{"title":"This method cancels a state machine execution","description":"This method cancels a state machine execution"}},"httpPath":"/stepFunctions/{tenantId}/{stateMachineName}/{executionId}"}]}]}]}