{"swagger":"2.0","info":{"version":"v1","title":"act.web.api"},"host":"apimta.act.com","basePath":"/act.web.api","schemes":["https"],"paths":{"/api/ActivitySeries/{id}":{"get":{"tags":["ActivitySeries"],"summary":"Get a specific series activity.","operationId":"ActivitySeries_GetDeprecated_1026BB09","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given series activity.","required":true,"type":"string"},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivitySeries"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":true},"put":{"tags":["ActivitySeries"],"summary":"Update an already existing series activity","operationId":"ActivitySeries_PutDeprecated_CDA0E3CC","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given series activity.","required":true,"type":"string"},{"name":"series","in":"body","description":"The series activity definition","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivitySeries"}},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivitySeries"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":true},"delete":{"tags":["ActivitySeries"],"summary":"Delete an existing series activity.","description":"This will not remove activities that were part of the series and were rescheduled.","operationId":"ActivitySeries_DeleteDeprecated_FBE2FFCB","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given series activity.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":true},"patch":{"tags":["ActivitySeries"],"summary":"Partially update an already existing series activity","operationId":"ActivitySeries_PatchDeprecated_70F1EE46","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given series activity.","required":true,"type":"string"},{"name":"series","in":"body","description":"The series activity definition","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivitySeries"}},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivitySeries"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":true}},"/api/ActivitySeries":{"get":{"tags":["ActivitySeries"],"summary":"Get all series activities matching an (optional) OData query.","operationId":"ActivitySeries_GetDeprecated_FE2F02D8","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]},{"name":"filterBy","in":"query","required":false,"type":"string","enum":["InRange","InSeries"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Activities.ActivitySeries"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":true},"post":{"tags":["ActivitySeries"],"summary":"Create a new series activity.","operationId":"ActivitySeries_PostDeprecated_3028AEF2","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"series","in":"body","description":"The series activity definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivitySeries"}},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivitySeries"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":true}},"/api/activities/analytics/task-list":{"get":{"tags":["Analytics"],"summary":"Generates the task list activities for analytics task list widget","operationId":"Analytics_GetLimitedTaskListActivities_65ECB9F3","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"start","in":"query","required":true,"type":"string","format":"date-time"},{"name":"end","in":"query","required":true,"type":"string","format":"date-time"},{"name":"max","in":"query","required":false,"type":"integer","format":"int32"},{"name":"typeIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"priorityIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.TaskListActivity"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/activities/analytics/activity-by-user":{"get":{"tags":["Analytics"],"summary":"Generates activity sales by user data for given users.","operationId":"Analytics_GetActivityByUser_EE78D56B","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"start","in":"query","required":true,"type":"string","format":"date-time"},{"name":"end","in":"query","required":true,"type":"string","format":"date-time"},{"name":"typeIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"userIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.UserActivityCount"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/activities/analytics/activity-by-user-details":{"get":{"tags":["Analytics"],"summary":"Generates activity sales by user detail data for a given user.","operationId":"Analytics_GetActivityByUserDetails_703CA4FB","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"start","in":"query","required":true,"type":"string","format":"date-time"},{"name":"end","in":"query","required":true,"type":"string","format":"date-time"},{"name":"typeIds","in":"query","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"userId","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.UserActivityDetail"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/emarketing/analytics/campaign-leads":{"get":{"tags":["Analytics"],"summary":"Gets contacts leads.","operationId":"Analytics_GetCampaignLeads_417AF467","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.MarketingLead"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/emarketing/analytics/campaign-lead-info":{"get":{"tags":["Analytics"],"summary":"Gets opportunities within a campaign within a specified date range (optional filters on statuses and user ids).","operationId":"Analytics_GetCampaignLeadInfo_E08EC92C","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"start","in":"query","required":true,"type":"string","format":"date-time"},{"name":"end","in":"query","required":true,"type":"string","format":"date-time"},{"name":"statuses","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"userIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"campaignIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.CampaignLeadInfo"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/emarketing/analytics/campaign-sent":{"get":{"tags":["Analytics"],"summary":"Gets campaign sent within a specified date range.","operationId":"Analytics_GetCampaignSent_4B94D20E","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"start","in":"query","required":true,"type":"string","format":"date-time"},{"name":"end","in":"query","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.CampaignInfo"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/emarketing/analytics/campaign-results":{"get":{"tags":["Analytics"],"summary":"Gets campaign result information.","operationId":"Analytics_GetCampaignResults_0F89CFC0","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"start","in":"query","required":true,"type":"string","format":"date-time"},{"name":"end","in":"query","required":true,"type":"string","format":"date-time"},{"name":"campaignIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.CampaignResult"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/{entityname}/analytics/query":{"get":{"tags":["Analytics"],"summary":"Gets a custom analytic query to view specific data.","operationId":"Analytics_GetCustomData_B83CB8C8","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"entityname","in":"path","required":true,"type":"string"},{"name":"field","in":"query","required":true,"type":"string"},{"name":"operation","in":"query","required":true,"type":"string"},{"name":"start","in":"query","required":false,"type":"string","format":"date-time"},{"name":"end","in":"query","required":false,"type":"string","format":"date-time"},{"name":"dateType","in":"query","required":false,"type":"integer","format":"int32"},{"name":"valueType","in":"query","required":false,"type":"integer","format":"int32"},{"name":"probabilityValue","in":"query","required":false,"type":"integer","format":"int32"},{"name":"probabilityOperation","in":"query","required":false,"type":"string"},{"name":"amountValue","in":"query","required":false,"type":"number","format":"double"},{"name":"amountOperation","in":"query","required":false,"type":"string"},{"name":"omitPrivate","in":"query","required":false,"type":"boolean"},{"name":"typeIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"userIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"stageIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"pickListItemIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"statuses","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Analytics.CustomData"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/{entityname}/analytics/query-details":{"get":{"tags":["Analytics"],"summary":"Gets a custom analytic query to view specific data.","operationId":"Analytics_GetCustomDataDetails_AE15B56B","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"entityname","in":"path","required":true,"type":"string"},{"name":"field","in":"query","required":true,"type":"string"},{"name":"fieldValue","in":"query","required":true,"type":"string"},{"name":"start","in":"query","required":false,"type":"string","format":"date-time"},{"name":"end","in":"query","required":false,"type":"string","format":"date-time"},{"name":"dateType","in":"query","required":false,"type":"integer","format":"int32"},{"name":"valueType","in":"query","required":false,"type":"integer","format":"int32"},{"name":"probabilityValue","in":"query","required":false,"type":"integer","format":"int32"},{"name":"probabilityOperation","in":"query","required":false,"type":"string"},{"name":"amountValue","in":"query","required":false,"type":"number","format":"double"},{"name":"amountOperation","in":"query","required":false,"type":"string"},{"name":"omitPrivate","in":"query","required":false,"type":"boolean"},{"name":"typeIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"userIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"stageIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"pickListItemIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"statuses","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Analytics.CustomData"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/emarketing/analytics/history":{"get":{"tags":["Analytics"],"summary":"Gets historical e-marketing information for a given date range.","operationId":"Analytics_GetEmarketingHistory_1FECBF61","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"start","in":"query","required":true,"type":"string","format":"date-time"},{"name":"end","in":"query","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Analytics.EmarketingHistory"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/analytics/kpi":{"get":{"tags":["Analytics"],"summary":"Gets analytic KPI query to view specific data.","operationId":"Analytics_GetKpiData_4DFFF7FB","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"groupName","in":"query","required":true,"type":"string"},{"name":"start","in":"query","required":false,"type":"string","format":"date-time"},{"name":"end","in":"query","required":false,"type":"string","format":"date-time"},{"name":"dateType","in":"query","required":false,"type":"integer","format":"int32"},{"name":"valueType","in":"query","required":false,"type":"integer","format":"int32"},{"name":"probabilityValue","in":"query","required":false,"type":"integer","format":"int32"},{"name":"probabilityOperation","in":"query","required":false,"type":"string"},{"name":"amountValue","in":"query","required":false,"type":"number","format":"double"},{"name":"amountOperation","in":"query","required":false,"type":"string"},{"name":"omitPrivate","in":"query","required":false,"type":"boolean"},{"name":"typeIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"userIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"stageIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"pickListItemIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"statuses","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Analytics.KpiData"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunity/analytics/revenue/actual-predicted":{"get":{"tags":["Analytics"],"summary":"Generates actual vs predicted opportunity revenue.","operationId":"Analytics_GetOpportunityActualVersusPredictedRevenue_3DBFEBCE","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"args.interval","in":"query","description":"An intervening period of time.","required":false,"type":"string","enum":["Daily","Weekly","Monthly","Quarterly","Yearly"]},{"name":"args.start","in":"query","description":"The start date that the period requesting.","required":false,"type":"string","format":"date-time"},{"name":"args.end","in":"query","description":"The end date that the period requesting.","required":false,"type":"string","format":"date-time"},{"name":"args.fiscalYearStart","in":"query","description":"The oppourtunity products that will be evaludated to generate the revenue data.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.PeriodicActualAndPredictedRevenue"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunity/analytics/revenue/forecast-by-product":{"get":{"tags":["Analytics"],"summary":"Generates forecasted opportunity data by given products.","operationId":"Analytics_GetOpportunityForecastByProduct_6A5F800E","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"productIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.ForecastByProduct"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunity/analytics/revenue/forecast-by-product-details":{"get":{"tags":["Analytics"],"summary":"Generates forecasted opportunity data by a given product.","operationId":"Analytics_GetOpportunityForecastByProductDetails_E8BE0DD8","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"productId","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.ForecastByProductDetail"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunity/analytics/revenue/forecast-by-rep":{"get":{"tags":["Analytics"],"summary":"Generates forecasted opportunity data by given users.","operationId":"Analytics_GetOpportunityForecastByRep_F4797D7A","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"userIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.ForecastByRep"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunity/analytics/revenue/forecast-by-rep-details":{"get":{"tags":["Analytics"],"summary":"Generates forecasted opportunity data by a given user.","operationId":"Analytics_GetOpportunityForecastByRepDetails_987464AE","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"userId","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.ForecastByRepDetail"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunities/analytics/pipeline":{"get":{"tags":["Analytics"],"summary":"Gets all opportunity matching the custom filter that are currently being worked.","operationId":"Analytics_GetOpportunityInPipeline_28599DA0","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"start","in":"query","required":false,"type":"string","format":"date-time"},{"name":"end","in":"query","required":false,"type":"string","format":"date-time"},{"name":"dateType","in":"query","required":false,"type":"integer","format":"int32"},{"name":"valueType","in":"query","required":false,"type":"integer","format":"int32"},{"name":"probabilityValue","in":"query","required":false,"type":"integer","format":"int32"},{"name":"probabilityOperation","in":"query","required":false,"type":"string"},{"name":"amountValue","in":"query","required":false,"type":"number","format":"double"},{"name":"amountOperation","in":"query","required":false,"type":"string"},{"name":"omitPrivate","in":"query","required":false,"type":"boolean"},{"name":"typeIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"userIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"stageIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"pickListItemIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"statuses","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.PipelineOpportunity"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunities/analytics/pipelines":{"post":{"tags":["Analytics"],"summary":"Gets all opportunity matching the custom filter that are currently being worked.","operationId":"Analytics_GetOpportunityInPipeline_139FD0C7","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"pipeline","in":"body","required":true,"schema":{"$ref":"#/definitions/act.web.api.Controllers.AnalyticsPipeline"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.PipelineOpportunity"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunities/analytics/top-open":{"get":{"tags":["Analytics"],"summary":"Gets all opportunity matching the custom filter that are currently being worked.","operationId":"Analytics_GetTopOpenOpportunities_19FBF97E","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"start","in":"query","required":false,"type":"string","format":"date-time"},{"name":"end","in":"query","required":false,"type":"string","format":"date-time"},{"name":"dateType","in":"query","required":false,"type":"integer","format":"int32"},{"name":"valueType","in":"query","required":false,"type":"integer","format":"int32"},{"name":"probabilityValue","in":"query","required":false,"type":"integer","format":"int32"},{"name":"probabilityOperation","in":"query","required":false,"type":"string"},{"name":"amountValue","in":"query","required":false,"type":"number","format":"double"},{"name":"amountOperation","in":"query","required":false,"type":"string"},{"name":"omitPrivate","in":"query","required":false,"type":"boolean"},{"name":"max","in":"query","required":false,"type":"integer","format":"int32"},{"name":"typeIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"userIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"stageIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"pickListItemIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"statuses","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.PipelineOpportunity"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunity/analytics/stage-time":{"get":{"tags":["Analytics"],"summary":"Generates opportunity data for the average time in a stage.","operationId":"Analytics_GetOpportunityAverageTimeInStage_DCAE7DC3","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"start","in":"query","required":true,"type":"string","format":"date-time"},{"name":"end","in":"query","required":true,"type":"string","format":"date-time"},{"name":"stageIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.TimeInStage"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunity/analytics/revenue/close-reason":{"get":{"tags":["Analytics"],"summary":"Generates opportunity data to summerizes how many times a reason has been closed.","operationId":"Analytics_GetOpportunityCloseReasonCount_ABE6C32D","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"start","in":"query","required":true,"type":"string","format":"date-time"},{"name":"end","in":"query","required":true,"type":"string","format":"date-time"},{"name":"status","in":"query","required":true,"type":"string","enum":["Open","Won","Lost","Inactive"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.CloseReasonCount"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunity/analytics/revenue/close-reason-details":{"get":{"tags":["Analytics"],"summary":"Generates opportunity data that details the reason for being closed.","operationId":"Analytics_GetOpportunityCloseReasonDetails_6BBA1207","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"start","in":"query","required":true,"type":"string","format":"date-time"},{"name":"end","in":"query","required":true,"type":"string","format":"date-time"},{"name":"status","in":"query","required":true,"type":"string","enum":["Open","Won","Lost","Inactive"]},{"name":"closeReason","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.CloseReasonDetails"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/stages/analytics/opportunity-count":{"get":{"tags":["Analytics"],"summary":"Generates a summary of the total number of opportunities within a stage.","operationId":"Analytics_GetOpportunityCountByStages_CD8840AE","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"start","in":"query","required":false,"type":"string","format":"date-time"},{"name":"end","in":"query","required":false,"type":"string","format":"date-time"},{"name":"dateType","in":"query","required":false,"type":"integer","format":"int32"},{"name":"valueType","in":"query","required":false,"type":"integer","format":"int32"},{"name":"probabilityValue","in":"query","required":false,"type":"integer","format":"int32"},{"name":"probabilityOperation","in":"query","required":false,"type":"string"},{"name":"amountValue","in":"query","required":false,"type":"number","format":"double"},{"name":"amountOperation","in":"query","required":false,"type":"string"},{"name":"omitPrivate","in":"query","required":false,"type":"boolean"},{"name":"typeIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"userIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"stageIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"pickListItemIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"statuses","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.OpportunityStageCount"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunity/analytics/revenue/cost":{"get":{"tags":["Analytics"],"summary":"Generates opportunity periodic revenue versus cost data for given products.","operationId":"Analytics_GetOpportunityRevenueVersusCost_D5AA80A8","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"productIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"args.interval","in":"query","description":"An intervening period of time.","required":false,"type":"string","enum":["Daily","Weekly","Monthly","Quarterly","Yearly"]},{"name":"args.start","in":"query","description":"The start date that the period requesting.","required":false,"type":"string","format":"date-time"},{"name":"args.end","in":"query","description":"The end date that the period requesting.","required":false,"type":"string","format":"date-time"},{"name":"args.fiscalYearStart","in":"query","description":"The oppourtunity products that will be evaludated to generate the revenue data.","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.PeriodicRevenueAndCost"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunity/analytics/revenue/sales-by-product":{"get":{"tags":["Analytics"],"summary":"Generates opportunity sales by product data for given products.","operationId":"Analytics_GetOpportunitySalesByProduct_E254EF71","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"start","in":"query","required":true,"type":"string","format":"date-time"},{"name":"end","in":"query","required":true,"type":"string","format":"date-time"},{"name":"productIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.SalesByProduct"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunity/analytics/revenue/sales-by-product-details":{"get":{"tags":["Analytics"],"summary":"Generates opportunity sales by product detail data for a given product.","operationId":"Analytics_GetOpportunitySalesByProductDetails_89CE77DD","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"start","in":"query","required":true,"type":"string","format":"date-time"},{"name":"end","in":"query","required":true,"type":"string","format":"date-time"},{"name":"productId","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.SalesByProductDetail"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunity/analytics/revenue/sales-by-rep":{"get":{"tags":["Analytics"],"summary":"Generates opportunity sales by user data for given users.","operationId":"Analytics_GetOpportunitySalesByRep_75FC5215","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"start","in":"query","required":true,"type":"string","format":"date-time"},{"name":"end","in":"query","required":true,"type":"string","format":"date-time"},{"name":"userIds","in":"query","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.SalesByRep"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunity/analytics/revenue/sales-by-rep-details":{"get":{"tags":["Analytics"],"summary":"Generates opportunity sales by user data for a given user.","operationId":"Analytics_GetOpportunitySalesByRepDetails_4BE7FF32","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"start","in":"query","required":true,"type":"string","format":"date-time"},{"name":"end","in":"query","required":true,"type":"string","format":"date-time"},{"name":"userId","in":"query","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.SalesByRepDetail"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunity/analytics/revenue/won-lost":{"get":{"tags":["Analytics"],"summary":"Generates opportunty win versus loss data.","operationId":"Analytics_GetOpportunityWonVersusLost_797C4A7F","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"start","in":"query","required":true,"type":"string","format":"date-time"},{"name":"end","in":"query","required":true,"type":"string","format":"date-time"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.WonLostMetrics"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/calendar":{"get":{"tags":["Calendar"],"summary":"Get calendar schedule for the current user matching an (optional) OData query.","operationId":"Calendar_Get_4342D274","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Calendar.Schedule"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/calendar/preferences":{"get":{"tags":["Calendar"],"summary":"Get user's calendar preferences.","operationId":"Calendar_GetPreferences_AD38D5BE","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Calendar.CalendarPreferences"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Calendar"],"summary":"Update the user's calendar preferences.","operationId":"Calendar_PutPreference_DE71004C","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"settings","in":"body","description":"The calendar preferences definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Calendar.CalendarPreferences"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Calendar.CalendarPreferences"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["Calendar"],"summary":"Create the user's calendar preferences.","operationId":"Calendar_PostPreference_4E44150A","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"settings","in":"body","description":"The calendar preferences definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Calendar.CalendarPreferences"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Calendar.CalendarPreferences"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/{contactId}/associated-companies":{"get":{"tags":["Companies"],"summary":"List of companies from a specific contact and matching an (optional) OData query.","operationId":"Companies_GetAssociatedCompaniesByContact_87388C7A","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Companies.Company"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Companies"],"summary":"Associate a list of companies to a specific contact.","operationId":"Companies_PutAssociatedCompaniesToContact_B13F22EF","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"},{"name":"companyList","in":"body","description":"A list of company identifiers.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Companies.CompanyListRequest"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Companies"],"summary":"Dissociate a list of companies from a specific contact.","operationId":"Companies_DeleteAssociatedCompaniesFromContact_E46F5427","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"},{"name":"companyList","in":"body","description":"A list of companies identifiers.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Companies.CompanyListRequest"}}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/{contactId}/associated-companies/{companyId}":{"put":{"tags":["Companies"],"summary":"Associate a company to a specific contact.","operationId":"Companies_PutAssociatedCompaniesToContact_49B35DB0","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"},{"name":"companyId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Companies"],"summary":"Dissociate a company from a specific contact.","operationId":"Companies_DeleteAssociatedCompaniesFromContact_F2BAEC23","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"},{"name":"companyId","in":"path","description":"The unique identifier (id) for a given company.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunities/{opportunityId}/associated-companies":{"get":{"tags":["Companies"],"summary":"List of companies from a specific opportunity and matching an (optional) OData query.","operationId":"Companies_GetAssociatedCompaniesFromOpportunity_2E5B3F85","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Companies.Company"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Companies"],"summary":"Associate a list of companies to a specific opportunity.","operationId":"Companies_PutAssociatedCompaniesToOpportunity_D1EDA1D2","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"},{"name":"companyList","in":"body","description":"A list of company identifiers.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Companies.CompanyListRequest"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Companies"],"summary":"Dissociate a list of companies from a specific opportunity.","operationId":"Companies_DeleteAssociatedCompaniesFromOpportunity_C7536000","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"},{"name":"companyList","in":"body","description":"List of companies identifiers.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Companies.CompanyListRequest"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunities/{opportunityId}/associated-companies/{companyId}":{"put":{"tags":["Companies"],"summary":"Associate a company to a specific opportunity.","operationId":"Companies_PutAssociatedCompaniesToOpportunity_D9F284C2","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"},{"name":"companyId","in":"path","description":"The unique identifier (id) for a given company.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Companies"],"summary":"Dissociate a company from a specific opportunity.","operationId":"Companies_DeleteAssociatedCompaniesFromOpportunity_5A36C037","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"},{"name":"companyId","in":"path","description":"The unique identifier (id) for a given company.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/companies/{companyId}":{"get":{"tags":["Companies"],"summary":"Get a specific company.","operationId":"Companies_GetCompany_AC884DF5","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"companyId","in":"path","description":"The unique identifier (id) for a given company.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Companies.Company"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Companies"],"summary":"Update an already existing company.","operationId":"Companies_PutCompany_A1350C65","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"companyId","in":"path","description":"The unique identifier (id) for a given company.","required":true,"type":"string"},{"name":"company","in":"body","description":"The company definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Companies.Company"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Companies.Company"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Companies"],"summary":"Delete an existing company.","operationId":"Companies_DeleteCompany_B5D7C6B0","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"companyId","in":"path","description":"The unique identifier (id) for a given company.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"patch":{"tags":["Companies"],"summary":"Update (partially) an already existing company.","operationId":"Companies_PatchCompany_316D8304","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"companyId","in":"path","description":"The unique identifier (id) for a given company.","required":true,"type":"string"},{"name":"company","in":"body","description":"The company definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Companies.Company"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Companies.Company"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/companies":{"get":{"tags":["Companies"],"summary":"Get all companies matching an (optional) OData query.","operationId":"Companies_GetCompanies_BF3259E6","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Companies.Company"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["Companies"],"summary":"Create a new company.","operationId":"Companies_PostCompany_6941ACD1","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"company","in":"body","description":"The company definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Companies.Company"}}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.Companies.Company"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/activities/{activityId}/associated-companies":{"get":{"tags":["Companies"],"summary":"List of companies from a specific activity and matching an (optional) OData query.","operationId":"Companies_GetAssociatedCompaniesFromActivity_67CDAE40","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"activityId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Companies.Company"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/{entityName}/{id}/associated-companies":{"get":{"tags":["Companies"],"summary":"List of companies from a specific custom entity and matching an (optional) OData query.","operationId":"Companies_GetAssociatedCompaniesFromCustomEntity_86BB9475","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"entityName","in":"path","description":"The name of the custom entity.","required":true,"type":"string"},{"name":"id","in":"path","description":"The unique identifier (id) for a given entity row","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Companies.Company"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/companies/{companyId}/access":{"get":{"tags":["Companies"],"summary":"Get a company access levels.","operationId":"Companies_GetCompanyAccessLevel_BBD21BBE","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"companyId","in":"path","description":"The unique identifier for the company.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Contacts.AccessLevel"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Companies"],"summary":"Update an already existing company access levels accessors.","operationId":"Companies_PutCompanyAccessors_F48F95CA","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"companyId","in":"path","description":"The unique identifier (id) for a given company.","required":true,"type":"string"},{"name":"accessLevel","in":"body","description":"The unique identifier (id) for a given accessor.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Contacts.AccessLevel"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Contacts.AccessLevel"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/companies/{companyId}/divisions":{"get":{"tags":["Companies"],"summary":"","operationId":"Companies_GetCompanyDivisions_E369E41D","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"companyId","in":"path","description":"The unique identifier (id) for the company.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Companies.SubCompany"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/companies/webinfo":{"get":{"tags":["Companies"],"summary":"Get company web information hyperlinks matching an (optional) OData query.","operationId":"Companies_GetCompanyWebInfo_45513234","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Users.WebInfo"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/companies/webinfo/{id}/HyperLink/{linkId}":{"put":{"tags":["Companies"],"summary":"","operationId":"Companies_PutCompanyWebInfo_3631ACF6","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given WebInfo Group.","required":true,"type":"string"},{"name":"linkId","in":"path","description":"The unique identifier (id) for a WebInfo Group HyperLink.","required":true,"type":"string"},{"name":"hyperLink","in":"body","description":"The HyperLink.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Users.HyperLinks"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Contacts.AccessLevel"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/analytics/definitions/insight-views":{"get":{"tags":["Configurations"],"summary":"Get current user's insight analytic view definition data","operationId":"Configurations_GetAnalyticConfigurationInsightViewDefinitions_393BFEDD","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Configuration.ConfigurationDefinition"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Configurations"],"summary":"Create/Update current user's insight analytic view definition data.","operationId":"Configurations_PutAnalyticConfigurationInsightViewDefinitions_D6450485","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"definition","in":"body","description":"The user's profile.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Configuration.ConfigurationDefinition"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Configurations"],"summary":"Delete current user's insight's analytic view definition data.","operationId":"Configurations_DeleteAnalyticConfigurationInsightViewDefinitions_49FEF34F","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/analytics/definitions/myact-views":{"get":{"tags":["Configurations"],"summary":"Get current user's insight analytic view definition data","operationId":"Configurations_GetAnalyticConfigurationMyActViewDefinitions_64469CB9","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Configuration.ConfigurationDefinition"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Configurations"],"summary":"Create/Update current user's 'MyAct' analytic view definition data.","operationId":"Configurations_PutAnalyticConfigurationMyActViewDefinitions_63CD19DC","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"definition","in":"body","description":"The user's profile.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Configuration.ConfigurationDefinition"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Configurations"],"summary":"Delete current user's insight's analytic view definition data.","operationId":"Configurations_DeleteAnalyticConfigurationMyActViewDefinitions_09B0834E","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/analytics/definitions/kpi-views/{name}":{"get":{"tags":["Configurations"],"summary":"Get current user's KPI analytic view definition data","operationId":"Configurations_GetAnalyticConfigurationKpiViewDefinitions_8C0032C7","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"name","in":"path","description":"The kpi view container name.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Configuration.ConfigurationDefinition"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Configurations"],"summary":"Create/Update current user's KPI analytic view definition data.","operationId":"Configurations_PutAnalyticConfigurationKpiViewDefinitions_7F2F92D8","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"name","in":"path","description":"The kpi container name","required":true,"type":"string"},{"name":"container","in":"body","description":"The group definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Configuration.ConfigurationDefinition"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/analytics/settings/opportunity-pipeline":{"get":{"tags":["Configurations"],"summary":"Get current user's opportunity pipeline analytic view settings data.","operationId":"Configurations_GetAnalyticConfigurationOpportunityPipelineViewSettings_6AEEAAA0","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Users.OpportunityPipelineViewSettings"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Configurations"],"summary":"Create/Update current user's opportunity pipeline analytic view settings data.","operationId":"Configurations_PutAnalyticConfigurationOpportunityPipelineViewSettings_6B0FE79A","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"settings","in":"body","description":"The user's pipeline settings.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Configuration.ConfigurationSettings"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/companies/{companyId}/associated-contacts/{contactId}":{"put":{"tags":["Contacts"],"summary":"Associate a contact to a specific company.","operationId":"Contacts_PutAssociatedContactsToCompany_621AF2E3","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"companyId","in":"path","description":"The unique identifier (id) for a given company.","required":true,"type":"string"},{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Contacts"],"summary":"Dissociate a list of contact from a specific company.","operationId":"Contacts_DeleteAssociatedContactsFromCompany_BF82BC0F","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"companyId","in":"path","description":"The unique identifier (id) for a given company.","required":true,"type":"string"},{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/companies/{companyId}/associated-contacts":{"get":{"tags":["Contacts"],"summary":"List of contacts from a specific company and matching an (optional) OData query.","operationId":"Contacts_GetAssociatedContactsFromCompany_34A1C438","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"companyId","in":"path","description":"The unique identifier (id) for a given company.","required":true,"type":"string"},{"name":"phoneFormat","in":"query","description":"","required":false,"type":"string","enum":["None","E164"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Contacts"],"summary":"Associate a list of contact to a specific company.","operationId":"Contacts_PutAssociatedContactsToCompany_AFF2F533","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"companyId","in":"path","description":"The unique identifier (id) for a given company.","required":true,"type":"string"},{"name":"request","in":"body","description":"Contacts assign model.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Contacts.ContactListRequest"}},{"name":"phoneFormat","in":"query","description":"","required":false,"type":"string","enum":["None","E164"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Contacts"],"summary":"Dissociate a list of contact from a specific company.","operationId":"Contacts_DeleteAssociatedContactsFromCompany_01636144","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"companyId","in":"path","description":"The unique identifier (id) for a given company.","required":true,"type":"string"},{"name":"contactList","in":"body","description":"A list of contact identifiers.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Contacts.ContactListRequest"}}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/groups/{groupId}/associated-contacts":{"get":{"tags":["Contacts"],"summary":"List of contacts from a specific group and matching an (optional) OData query.","operationId":"Contacts_GetAssociatedContactsFromGroup_8FB71684","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"path","description":"The unique identifier (id) for a given group.","required":true,"type":"string"},{"name":"phoneFormat","in":"query","description":"","required":false,"type":"string","enum":["None","E164"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Contacts"],"summary":"Assign the list of contacts to selected group.","operationId":"Contacts_PutAssociatedContactsToGroup_4264268C","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"path","description":"The unique identifier (id) for a given group.","required":true,"type":"string"},{"name":"request","in":"body","description":"Contacts assign model.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Contacts.ContactListRequest"}},{"name":"phoneFormat","in":"query","description":"","required":false,"type":"string","enum":["None","E164"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Contacts"],"summary":"Dissociate a list of contact from a specific group.","operationId":"Contacts_DeleteAssociatedContactsFromGroup_ACB6D180","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"path","description":"The unique identifier (id) for a given group.","required":true,"type":"string"},{"name":"contactList","in":"body","description":"A list of contact identifiers.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Contacts.ContactListRequest"}}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/groups/{groupId}/associated-contacts/{contactId}":{"put":{"tags":["Contacts"],"summary":"Assign a contacts to selected group.","operationId":"Contacts_PutAssociatedContactsToGroup_F1CA97F7","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"path","description":"The unique identifier (id) for a given group.","required":true,"type":"string"},{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Contacts"],"summary":"Dissociate a contact from a specific group.","operationId":"Contacts_DeleteAssociatedContactsFromGroup_62F8F0FA","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"path","description":"The unique identifier (id) for a given group.","required":true,"type":"string"},{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunities/{opportunityId}/associated-contacts":{"get":{"tags":["Contacts"],"summary":"List of contacts from a specific opportunity and matching an (optional) OData query.","operationId":"Contacts_GetAssociatedContactsFromOpportunity_25342CA2","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"},{"name":"phoneFormat","in":"query","description":"","required":false,"type":"string","enum":["None","E164"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Contacts"],"summary":"Associate a list of contacts to a specific opportunity.","operationId":"Contacts_PutAssociatedContactsToOpportunity_C1B26508","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"},{"name":"request","in":"body","description":"List of unique identifiers (id) for a given contacts that aren't associated with a opportunity.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Contacts.ContactListRequest"}}],"responses":{"200":{"description":"OK indicates that the request has been successfully processed and that the response contain list of assigned contacts.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Contacts"],"summary":"Dissociate a list of contacts from a specific opportunity.","operationId":"Contacts_DeleteAssociatedContactsFromOpportunity_1D52AFD2","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"},{"name":"contactList","in":"body","description":"List of contact identifiers.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Contacts.ContactListRequest"}}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunities/{opportunityId}/associated-contacts/{contactId}":{"put":{"tags":["Contacts"],"summary":"Associate a list of contacts to a specific opportunity.","operationId":"Contacts_PutAssociatedContactsToOpportunity_098F6405","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"},{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request has been successfully processed and that the response contain list of assigned contacts.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Contacts"],"summary":"Dissociate a contact from a specific opportunity.","operationId":"Contacts_DeleteAssociatedContactsFromOpportunity_474A1A27","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"},{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/{contactId}":{"get":{"tags":["Contacts"],"summary":"Get a specific contact.","operationId":"Contacts_GetContact_E09EB702","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"},{"name":"phoneFormat","in":"query","description":"","required":false,"type":"string","enum":["None","E164"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Contacts"],"summary":"Update an already existing contact.","operationId":"Contacts_PutContact_9B5285C5","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"},{"name":"contact","in":"body","description":"The contact definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}},{"name":"phoneFormat","in":"query","description":"","required":false,"type":"string","enum":["None","E164"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Contacts"],"summary":"Delete a specific contact.","operationId":"Contacts_DeleteContact_59870332","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"patch":{"tags":["Contacts"],"summary":"Update (partially) an already existing contact.","operationId":"Contacts_PatchContact_7296FF7D","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"},{"name":"contact","in":"body","description":"The contact definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}},{"name":"phoneFormat","in":"query","description":"","required":false,"type":"string","enum":["None","E164"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/{entityName}/{id}/associated-contacts":{"get":{"tags":["Contacts"],"summary":"List of contacts from a specific custom entity and matching an (optional) OData query.","operationId":"Contacts_GetAssociatedContactsFromCustomEntity_6197F6E7","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"entityName","in":"path","description":"The name of the custom entity.","required":true,"type":"string"},{"name":"id","in":"path","description":"The unique identifier (id) for a given entity row","required":true,"type":"string"},{"name":"phoneFormat","in":"query","description":"","required":false,"type":"string","enum":["None","E164"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/by-ids":{"get":{"tags":["Contacts"],"summary":"Get a specific contact.","operationId":"Contacts_GetContactsByIds_55F074BD","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"ids","in":"query","description":"A list of unique identifier (id) for a given contact.","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"phoneFormat","in":"query","description":"","required":false,"type":"string","enum":["None","E164"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/{contactId}/access":{"get":{"tags":["Contacts"],"summary":"Get all contact access levels matching an (optional) OData query.","operationId":"Contacts_GetContactAccessLevel_1FD81CBE","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier for the contact.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Contacts.AccessLevel"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Contacts"],"summary":"Update an already existing contact access level accessors.","operationId":"Contacts_PutContactAccessors_626023E8","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"},{"name":"accessLevel","in":"body","description":"The unique identifier (id) for a given accessor.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Contacts.AccessLevel"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Contacts.AccessLevel"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts":{"get":{"tags":["Contacts"],"summary":"Get all contacts matching an (optional) OData query.","operationId":"Contacts_GetContacts_70C5959A","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"phoneFormat","in":"query","description":"","required":false,"type":"string","enum":["None","E164"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["Contacts"],"summary":"Create a new Contact.","operationId":"Contacts_PostContact_03914590","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contact","in":"body","description":"The contact definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}},{"name":"phoneFormat","in":"query","description":"","required":false,"type":"string","enum":["None","E164"]}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/group-contacts":{"get":{"tags":["Contacts"],"summary":"Get a distinct list of contact(s) within a comma-delimited group array matching an (optional) OData query.","operationId":"Contacts_GetContactsByGroupArray_1477F23B","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"ids","in":"query","description":"An comma-delimited string array of unique identifier (id) for a given group.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"phoneFormat","in":"query","description":"","required":false,"type":"string","enum":["None","E164"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/nearby":{"get":{"tags":["Contacts"],"summary":"Get all contact(s) that are nearby a given latitude and longitude and matching an (optional) OData query.","operationId":"Contacts_GetContactsNearby_79C9A6E2","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"latitude","in":"query","description":"The angular distance of a place north or south of the earth's equator, or of a celestial object north or south of the celestial equator, usually expressed in degrees and minutes.","required":true,"type":"number","format":"double"},{"name":"longitude","in":"query","description":"The angular distance of a place east or west of the meridian at Greenwich, England, or west of the standard meridian of a celestial object, usually expressed in degrees and minutes.","required":true,"type":"number","format":"double"},{"name":"radius","in":"query","description":"The circumference distance in kilometers from the given latitude and longitude.","required":true,"type":"integer","format":"int32"},{"name":"phoneFormat","in":"query","description":"","required":false,"type":"string","enum":["None","E164"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/webinfo":{"get":{"tags":["Contacts"],"summary":"Get contact webinfo hyperlinks matching an (optional) OData query.","operationId":"Contacts_GetContactWebInfo_52862AA8","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Users.WebInfo"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/myrecord":{"get":{"tags":["Contacts"],"summary":"Get the current users contact.","operationId":"Contacts_GetMyRecord_A9BCA3EB","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"phoneFormat","in":"query","required":false,"type":"string","enum":["None","E164"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/duplicate":{"put":{"tags":["Contacts"],"summary":"Duplicate an array of contacts.","operationId":"Contacts_PutDuplicateContacts_5BFA5E9A","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contacts","in":"body","description":"Contacts assign model.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Contacts.ContactListRequest"}},{"name":"primaryFields","in":"query","description":"Duplicate contact will only primary fields: {Primary Fields: True | All Fields: false","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/{contactId}/duplicate":{"put":{"tags":["Contacts"],"summary":"Duplicate a given contacts.","operationId":"Contacts_PutDuplicateContacts_A9B3D92A","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"},{"name":"primaryFields","in":"query","description":"Duplicate contact will only primary fields: {Primary Fields: True | All Fields: false","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/{contactId}/hotlead-subscription":{"put":{"tags":["Contacts"],"summary":"Update an already existing contact.","operationId":"Contacts_PutHotLeadSubscription_2249F5F4","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"},{"name":"active","in":"query","description":"If the contact will be subscribed to hot leads.","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/webinfo/{id}/HyperLink/{linkId}":{"put":{"tags":["Contacts"],"summary":"","operationId":"Contacts_PutWebInfo_802BA403","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given WebInfo Group.","required":true,"type":"string"},{"name":"linkId","in":"path","description":"The unique identifier (id) for a WebInfo Group HyperLink.","required":true,"type":"string"},{"name":"hyperLink","in":"body","description":"The HyperLink.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Users.HyperLinks"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Contacts.AccessLevel"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/Cors":{"get":{"tags":["Cors"],"summary":"","operationId":"Cors_GetAllowedCors_656A6DCA","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"string"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/Cors/{id}":{"get":{"tags":["Cors"],"summary":"","operationId":"Cors_GetAllowedCors_949584D1","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"string"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Cors"],"summary":"Add a cors entry to the cors customer config (web.customer.config)","operationId":"Cors_PutAllowedCorsOrigin_FD355C2F","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The cors domain entry. sample( http://mydomain:8080)","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"string"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Cors"],"summary":"Remove a cors entry from the cors customer config (web.customer.config).","operationId":"Cors_DeleteAllowedCorsOrigin_C0A842D5","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The cors domain entry. sample( http://mydomain:8080)","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/custom/entities/{entityName}/{id}":{"get":{"tags":["CustomEntities"],"summary":"Get a specific custom entity.","operationId":"CustomEntities_Get_E50407CC","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"entityName","in":"path","description":"The name of the custom entity.","required":true,"type":"string"},{"name":"id","in":"path","description":"The unique identifier (id) for a given custom entity.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.CustomEntity"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["CustomEntities"],"summary":"Create a new custom entity.","operationId":"CustomEntities_Put_E2EE1D22","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"entityName","in":"path","description":"The name of the custom entity.","required":true,"type":"string"},{"name":"id","in":"path","description":"The unique identifier (id) for a given custom entity.","required":true,"type":"string"},{"name":"customEntity","in":"body","description":"The company definition.","required":true,"schema":{"type":"object","additionalProperties":{"$ref":"#/definitions/System.Object"}}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.CustomEntity"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["CustomEntities"],"summary":"Delete an existing custom entity.","operationId":"CustomEntities_Delete_B426AB4B","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"entityName","in":"path","description":"The name of the custom entity.","required":true,"type":"string"},{"name":"id","in":"path","description":"The unique identifier (id) for a given custom entity.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/custom/entities/{entityName}":{"get":{"tags":["CustomEntities"],"summary":"Get all custom entity data matching an (optional) OData query","operationId":"CustomEntities_Get_534E3316","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"entityName","in":"path","description":"The name of the custom entity.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.CustomEntity"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["CustomEntities"],"summary":"Create a new custom entity.","operationId":"CustomEntities_Post_4BE499F1","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"entityName","in":"path","description":"The name of the custom entity.","required":true,"type":"string"},{"name":"customEntity","in":"body","description":"The company definition.","required":true,"schema":{"type":"object","additionalProperties":{"$ref":"#/definitions/System.Object"}}}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.CustomEntity"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/database/backups/{filename}":{"get":{"tags":["Database"],"summary":"Get a specific database backup file.","operationId":"Database_GetDatabaseBackup_A1F60887","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"filename","in":"path","description":"The unique identifier (filename) for a given database backupUser file.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Database.DatabaseBackupInfo"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Database"],"summary":"Delete an existing database backup file.","operationId":"Database_DeleteDatabaseBackup_13928FFB","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"filename","in":"path","description":"The unique identifier (filename) for a given database backupUser file.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/database/demo-data":{"post":{"tags":["Database"],"summary":"Create demo data.","operationId":"Database_PostDemoData_8BC3A811","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Database"],"summary":"Delete demo data.","operationId":"Database_DeleteDemoData_E0546CC6","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/database/demo-data-status":{"get":{"tags":["Database"],"operationId":"Database_GetDemoDataStatus_D1CD9D1F","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/System.Object"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/database/backups":{"get":{"tags":["Database"],"summary":"Get all database backup file.","operationId":"Database_GetDatabaseBackups_202FE0BB","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Database.DatabaseBackupInfo"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Database"],"summary":"Upload a database backup file.","operationId":"Database_PutDatabaseBackup_7E76A423","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"202":{"description":"Accepted indicates that the request is accepted for processing, but the processing has not been completed.","schema":{"$ref":"#/definitions/act.web.api.models.Database.DatabaseBackupUser"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["Database"],"summary":"Create a new database backup file.","operationId":"Database_PostDatabaseBackup_C5EC02BE","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"user","in":"body","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Database.DatabaseBackupUser"}}],"responses":{"202":{"description":"Accepted indicates that the request is accepted for processing, but the processing has not been completed.","schema":{"$ref":"#/definitions/act.web.api.models.Database.DatabaseBackupUser"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/database/maintenance/lock":{"get":{"tags":["Database"],"summary":"Get the database's lock state.","operationId":"Database_GetLock_1B68F9F3","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/System.Object"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["Database"],"summary":"Lock or apply pending lock to the database.","operationId":"Database_PostLock_59B1C239","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json"],"parameters":[{"name":"content","in":"body","description":"Defines the type of lock.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Database.LockRequest"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Database.LockResult"}},"202":{"description":"Accepted indicates that the request was successfully received and is being processed.","schema":{"$ref":"#/definitions/act.web.api.models.Database.LockResult"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/database":{"post":{"tags":["Database"],"summary":"Create a new database.","operationId":"Database_PostDatabase_2EBCD826","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"database","in":"body","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Database.NewDatabaseRequest"}}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank."},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/database/maintenance/unlock":{"post":{"tags":["Database"],"summary":"Unlock the database.","operationId":"Database_PostUnlock_2CD3DC88","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/System.Object"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opened/sessions":{"get":{"tags":["Database"],"summary":"Get all open connections to the database.","operationId":"Database_GetOpenSessions_E10D6976","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/System.Object"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/companies/{id}/documents":{"get":{"tags":["Documents"],"summary":"Get all history documents for a given company matching an (optional) OData query.","operationId":"Documents_GetByCompany_C720909D","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given company.","required":true,"type":"string"},{"name":"showFor","in":"query","description":"Filtering based on associations: 0 = All associations, 1 = Company associations, 2 = Company contact associations.","required":false,"type":"string","enum":["All","Company","CompanyContact"]},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Histories.History"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/{id}/documents":{"get":{"tags":["Documents"],"summary":"Get all history documents for a given contact matching an (optional) OData query.","operationId":"Documents_GetByContact_82B4A666","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Histories.History"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/groups/{id}/documents":{"get":{"tags":["Documents"],"summary":"Get all history documents for a given group matching an (optional) OData query.","operationId":"Documents_GetByGroup_EE07FD6E","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given group.","required":true,"type":"string"},{"name":"showFor","in":"query","description":"Filtering based on associations: 0 = All associations, 1 = Company associations, 2 = Company contact associations.","required":false,"type":"string","enum":["All","Group","GroupContact"]},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Histories.History"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunities/{id}/documents":{"get":{"tags":["Documents"],"summary":"Get all history documents for a given opportunity matching an (optional) OData query.","operationId":"Documents_GetByOpportunity_FCF404D8","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Histories.History"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/Documents/{id}":{"get":{"tags":["Documents"],"summary":"Get a specific history document.","operationId":"Documents_Get_7BF30D0C","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given history document.","required":true,"type":"string"},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Histories.History"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Documents"],"summary":"Update an already existing history","operationId":"Documents_Put_33A1CD5B","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given history item.","required":true,"type":"string"},{"name":"history","in":"body","description":"The history definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Histories.History"}},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Histories.History"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Documents"],"summary":"Delete an existing history document.","operationId":"Documents_Delete_279427F5","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given history document.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"423":{"description":"Locked indicates that an attachment upload is currently in progress for this document."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/Documents":{"get":{"tags":["Documents"],"summary":"Get all history documents matching an (optional) OData query.","operationId":"Documents_Get_B0F423DF","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Histories.History"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["Documents"],"summary":"Create a new history document.","operationId":"Documents_Post_EFF22DA1","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"history","in":"body","description":"The history definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Histories.History"}},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.Histories.History"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/documents/history-types":{"get":{"tags":["DocumentTypes"],"summary":"Gets all document history types.","operationId":"DocumentTypes_GetHistoryTypesByDocumentTypes_9824C3CA","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.MetaData.TypeCodes.HistoryType"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/documents/historytypes":{"get":{"tags":["DocumentTypes"],"summary":"Deprecated (Please use '/api/documents/history-types' instead).","operationId":"DocumentTypes_GetLibraryDocumentHistoryTypes_51035BB4","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.MetaData.TypeCodes.HistoryType"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":true}},"/api/documents/history-types/{name}":{"get":{"tags":["DocumentTypes"],"summary":"Get a specific history document type by name.","operationId":"DocumentTypes_GetHistoryTypesByDocumentType_82E4F41A","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"name","in":"path","description":"The name of the history document type.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.MetaData.TypeCodes.HistoryType"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/documents/historytypes/{name}":{"get":{"tags":["DocumentTypes"],"summary":"Deprecated (Please use '/api/documents/history-types/{name}' instead).","operationId":"DocumentTypes_GetLibraryDocumentHistoryTypeByName_59C45724","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"name","in":"path","description":"The name of the history document type.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.MetaData.TypeCodes.ActivityType"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":true}},"/api/geographics/phonenumber/masks/{id}":{"delete":{"tags":["Geographics"],"summary":"Delete the phone number mask.","operationId":"Geographics_DeletePhoneMask_6E1968FC","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given mask.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response."},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/geographics/contact-geolocation":{"get":{"tags":["Geographics"],"summary":"Get all geolocation codes for a given contact.","operationId":"Geographics_GetContactGeolocations_88FA78BA","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Geographics.ContactCountByLocation"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/geographics/phonenumber/countries":{"get":{"tags":["Geographics"],"summary":"Get all countries with phone format masks matching an (optional) OData query.","operationId":"Geographics_GetCountries_36346831","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Geographics.Country"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/geographics/phonenumber/masks":{"get":{"tags":["Geographics"],"summary":"Get all phone format mask matching an (optional) OData query.","operationId":"Geographics_GetPhoneFormats_DF3DDE31","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"refresh","in":"query","description":"Refreshing the Act! phone format mask cache.","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Geographics.Mask"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/geographics/phonenumber/default-masks/{id}":{"put":{"tags":["Geographics"],"summary":"Set the phone number mask to be the default.","operationId":"Geographics_PutDefaultPhoneMask_B645F864","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given mask.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Geographics.Mask"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/{contactId}/associated-groups":{"get":{"tags":["Groups"],"summary":"List of groups from a specific contact and matching an (optional) OData query.","operationId":"Groups_GetAssociatedGroupsFromContact_584D5498","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Groups.Group"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Groups"],"summary":"Associate a list of groups to a specific contact.","operationId":"Groups_PutAssociatedGroupsToContact_A219ADDD","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"},{"name":"groupList","in":"body","description":"List of group identifiers (id).","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Groups.GroupListRequest"}}],"responses":{"200":{"description":"OK indicates that the request has been successfully processed and that the response contain list of assigned contacts.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Groups"],"summary":"Dissociate a list of groups from a specific contact.","operationId":"Groups_DeleteAssociatedGroupsFromContact_CFEF8EDF","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"},{"name":"groupList","in":"body","description":"A list of groups.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Groups.GroupListRequest"}}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/{contactId}/associated-groups/{groupId}":{"put":{"tags":["Groups"],"summary":"Associate a group to a specific contact.","operationId":"Groups_PutAssociatedGroupsToContact_F74551DA","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"},{"name":"groupId","in":"path","description":"The unique identifier (id) for a given group.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request has been successfully processed and that the response contain list of assigned contacts.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Groups"],"summary":"Dissociate a group from a specific contact.","operationId":"Groups_DeleteAssociatedGroupsFromContact_D64A54E1","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"},{"name":"groupId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunities/{opportunityId}/associated-groups":{"get":{"tags":["Groups"],"summary":"List of groups from a specific opportunity and matching an (optional) OData query.","operationId":"Groups_GetAssociatedGroupsFromOpportunity_B7851AE9","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Groups.Group"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Groups"],"summary":"Associate a list of groups to a specific opportunity.","operationId":"Groups_PutAssociatedGroupsToOpportunity_7BCA2FDE","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"},{"name":"groupList","in":"body","description":"List of group identifiers (id).","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Groups.GroupListRequest"}}],"responses":{"200":{"description":"OK indicates that the request has been successfully processed and that the response contain list of assigned contacts.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Groups"],"summary":"Dissociate a list of groups from a specific opportunity.","operationId":"Groups_DeleteAssociatedGroupsFromOpportunity_4A000B6E","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"},{"name":"groupList","in":"body","description":"A list of groups.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Groups.GroupListRequest"}}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunities/{opportunityId}/associated-groups/{groupId}":{"put":{"tags":["Groups"],"summary":"Associate a group to a specific opportunity.","operationId":"Groups_PutAssociatedGroupsToOpportunity_4AD8AA6A","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"},{"name":"groupId","in":"path","description":"The unique identifier (id) for a given group.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request has been successfully processed and that the response contain list of assigned contacts.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Groups"],"summary":"Dissociate a list of groups from a specific opportunity.","operationId":"Groups_DeleteAssociatedGroupsFromOpportunity_678469A3","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"},{"name":"groupId","in":"path","description":"The unique identifier (id) for a given group.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/groups/{groupId}":{"get":{"tags":["Groups"],"summary":"Get a specific Group.","operationId":"Groups_GetGroups_99BF0A48","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"path","description":"The unique identifier (id) for a given group.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Groups.Group"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Groups"],"summary":"Update an already existing group.","operationId":"Groups_PutGroup_FEB23D37","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"path","description":"The unique identifier (id) for a given group.","required":true,"type":"string"},{"name":"group","in":"body","description":"The group definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Groups.Group"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Groups.Group"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Groups"],"summary":"Delete an existing group.","operationId":"Groups_DeleteGroup_26D17601","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"path","description":"The unique identifier (id) for a given group.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"patch":{"tags":["Groups"],"summary":"Update (partially) an already existing group.","operationId":"Groups_PatchGroup_F19E7730","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"path","description":"The unique identifier (id) for a given group.","required":true,"type":"string"},{"name":"group","in":"body","description":"The group definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Groups.Group"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Groups.Group"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/groups":{"get":{"tags":["Groups"],"summary":"Get all groups matching an (optional) OData query.","operationId":"Groups_GetGroups_DD9B20F4","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Groups.Group"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["Groups"],"summary":"Create a new group.","operationId":"Groups_PostGroup_22C1BA27","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"group","in":"body","description":"The Group definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Groups.Group"}}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.Groups.Group"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/{entityName}/{id}/associated-groups":{"get":{"tags":["Groups"],"summary":"List of groups from a specific custom entity and matching an (optional) OData query.","operationId":"Groups_GetAssociatedGroupsFromCustomEntity_2B27D8F3","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"entityName","in":"path","description":"The name of the custom entity.","required":true,"type":"string"},{"name":"id","in":"path","description":"The unique identifier (id) for a given entity row","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Groups.Group"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/groups/{groupId}/associated-groups":{"get":{"tags":["Groups"],"summary":"List of groups from a specific group and matching an (optional) OData query.","operationId":"Groups_GetAssociatedGroupsFromGroup_163D567E","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"path","description":"The unique identifier (id) for a given group.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Groups.Group"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/lists/{listId}/dynamic-criteria":{"get":{"tags":["Groups"],"summary":"Get the criteria for a dynamic list matching an (optional) OData query.","operationId":"Groups_GetDynamicListCriteria_02B7B98D","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"listId","in":"path","description":"The unique identifier (id) for a given list","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Lists.Criteria"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Groups"],"summary":"Edit the criteria for a dynamic list.","operationId":"Groups_PutDynamicListCriteria_1D93BFEB","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"listId","in":"path","description":"The unique identifier (id) for a given list.","required":true,"type":"string"},{"name":"criteria","in":"body","description":"The criteria used to build the dynamic list.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Lists.Criteria"}}},{"name":"dateFormat","in":"query","description":"Optional date format string for parsing date criteria values (e.g., \"dd/MM/yyyy\" or \"MM/dd/yyyy\"). If not provided, defaults to dd/MM/yyyy.","required":false,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Lists.Criteria"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/dynamic-list/metadata":{"get":{"tags":["Groups"],"summary":"Get the dynamic list metadata matching an (optional) OData query.","operationId":"Groups_GetDynamicListCriteriaMetadata_5F31C879","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Lists.DynamicListMetadata"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/dynamic-list/operators":{"get":{"tags":["Groups"],"summary":"Get the dynamic list operators for a given datatype","operationId":"Groups_GetDynamicListCriteriaOperators_199DB107","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/System.Object"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/groups/{groupId}/access":{"get":{"tags":["Groups"],"summary":"Get all group access levels matching an (optional) OData query.","operationId":"Groups_GetGroupAccessLevel_907B2362","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"path","description":"The unique identifier for the group.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Contacts.AccessLevel"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Groups"],"summary":"Update an already existing group access levels accessors.","operationId":"Groups_PutGroupAccessors_2D0DD7FE","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"path","description":"The unique identifier (id) for a given group.","required":true,"type":"string"},{"name":"accessLevel","in":"body","description":"The unique identifier (id) for a given accessor.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Contacts.AccessLevel"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Contacts.AccessLevel"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/dynamic-list/company-preview":{"post":{"tags":["Groups"],"summary":"Get the dynamic list criteria preview","operationId":"Groups_PostDynamicListCriteriaCompanyPreview_192BFB76","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"includePrivate","in":"query","description":"Include entities that are marked as private","required":false,"type":"boolean"},{"name":"dateFormat","in":"query","description":"Optional date format string for parsing date criteria values (e.g., \"dd/MM/yyyy\" or \"MM/dd/yyyy\"). If not provided, defaults to dd/MM/yyyy.","required":false,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Companies.Company"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/dynamic-list/preview":{"post":{"tags":["Groups"],"summary":"Get the dynamic list criteria preview","operationId":"Groups_PostDynamicListCriteriaPreview_C5992D65","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"includePrivate","in":"query","description":"Include entities that are marked as private","required":false,"type":"boolean"},{"name":"includeUsers","in":"query","description":"Include contacts and users","required":false,"type":"boolean"},{"name":"dateFormat","in":"query","description":"Optional date format string for parsing date criteria values (e.g., \"dd/MM/yyyy\" or \"MM/dd/yyyy\"). If not provided, defaults to dd/MM/yyyy.","required":false,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/dynamic-list/contact-preview":{"post":{"tags":["Groups"],"summary":"Get the dynamic list criteria preview","operationId":"Groups_PostDynamicListCriteriaContactPreview_04388DB5","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"includePrivate","in":"query","description":"Include entities that are marked as private","required":false,"type":"boolean"},{"name":"includeUsers","in":"query","description":"Include contacts and users","required":false,"type":"boolean"},{"name":"dateFormat","in":"query","description":"Optional date format string for parsing date criteria values (e.g., \"dd/MM/yyyy\" or \"MM/dd/yyyy\"). If not provided, defaults to dd/MM/yyyy.","required":false,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/dynamic-list/group-preview":{"post":{"tags":["Groups"],"summary":"Get the dynamic list criteria preview","operationId":"Groups_PostDynamicListCriteriaGroupPreview_C2843BE4","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"includePrivate","in":"query","description":"Include entities that are marked as private","required":false,"type":"boolean"},{"name":"dateFormat","in":"query","description":"Optional date format string for parsing date criteria values (e.g., \"dd/MM/yyyy\" or \"MM/dd/yyyy\"). If not provided, defaults to dd/MM/yyyy.","required":false,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Groups.Group"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/dynamic-list/opportunity-preview":{"post":{"tags":["Groups"],"summary":"Get the dynamic list criteria preview","operationId":"Groups_PostDynamicListCriteriaOpportunityPreview_29303F6D","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"includePrivate","in":"query","description":"Include entities that are marked as private","required":false,"type":"boolean"},{"name":"dateFormat","in":"query","description":"Optional date format string for parsing date criteria values (e.g., \"dd/MM/yyyy\" or \"MM/dd/yyyy\"). If not provided, defaults to dd/MM/yyyy.","required":false,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.Opportunity"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/history/{id}/contacts/{contactId}":{"put":{"tags":["History"],"summary":"Associate the contact (if it is not already present) to history item.","operationId":"History_PutContactInHistory_59F6F097","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given history item.","required":true,"type":"string"},{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact that is associated with a history item.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Histories.History"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["History"],"summary":"Disassociate a contact (if it is present) from history item.","operationId":"History_DeleteContact_20F52D44","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given history item.","required":true,"type":"string"},{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact that is associated with history item.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/activities/{id}/history":{"get":{"tags":["History"],"summary":"Get all history items that are associated with a given activity and matching an (optional) OData query.","operationId":"History_GetByActivity_18775420","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given activity.","required":true,"type":"string"},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Histories.History"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/companies/{id}/history":{"get":{"tags":["History"],"summary":"Get all history items for a given company and matching an (optional) OData query.","operationId":"History_GetByCompany_D8603D38","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given company that is associated with a history item.","required":true,"type":"string"},{"name":"showFor","in":"query","description":"Filtering based on associations: 0 = All associations, 1 = Company associations, 2 = Company contact associations.","required":false,"type":"string","enum":["All","Company","CompanyContact"]},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Histories.History"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/{id}/history":{"get":{"tags":["History"],"summary":"Get all history items for a given contact and matching an (optional) OData query.","operationId":"History_GetByContact_6664D670","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given contact that is associated with a history item.","required":true,"type":"string"},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Histories.History"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/groups/{id}/history":{"get":{"tags":["History"],"summary":"Get all history items for a given group and matching an (optional) OData query.","operationId":"History_GetByGroup_B093613F","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given contact that is associated with a history item.","required":true,"type":"string"},{"name":"showFor","in":"query","description":"Filtering based on associations: 0 = All associations, 1 = Company associations, 2 = Company contact associations.","required":false,"type":"string","enum":["All","Group","GroupContact"]},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Histories.History"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunities/{id}/history":{"get":{"tags":["History"],"summary":"Get all history items for a given opportunity and matching an (optional) OData query.","operationId":"History_GetByOpportunity_BC00064D","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given opportunity that is associated with a history item.","required":true,"type":"string"},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Histories.History"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/History/{id}":{"get":{"tags":["History"],"summary":"Get a specific history entry.","operationId":"History_Get_E89EFEC9","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given history entry.","required":true,"type":"string"},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Histories.History"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["History"],"summary":"Update an already existing history","operationId":"History_Put_5EF99B3D","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given history item.","required":true,"type":"string"},{"name":"history","in":"body","description":"The history definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Histories.History"}},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Histories.History"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["History"],"summary":"Delete an existing history.","operationId":"History_Delete_BD3B55A2","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given history entry.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"patch":{"tags":["History"],"summary":"Partially update an already existing history","operationId":"History_Patch_B2B2DD81","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given history item.","required":true,"type":"string"},{"name":"history","in":"body","description":"The history definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Histories.History"}},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Histories.History"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/History":{"get":{"tags":["History"],"summary":"Get all history items matching an (optional) OData query.","operationId":"History_Get_F9FA0741","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Histories.History"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["History"],"summary":"Create a new history item.","operationId":"History_Post_E2B6CABD","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"history","in":"body","description":"The history definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Histories.History"}},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.Histories.History"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/history-types/{id}":{"get":{"tags":["HistoryTypes"],"summary":"Get a specific history type.","operationId":"HistoryTypes_GetHistoryTypeById_4E0AF16E","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given history type.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.MetaData.TypeCodes.HistoryType"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/historytypes/{name}":{"get":{"tags":["HistoryTypes"],"summary":"Deprecated (Please use '/api/history-types/{name}' instead).","operationId":"HistoryTypes_GetDeprecatedHistoryTypeByName_3232927F","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"name","in":"path","description":"The name of the history document type.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.MetaData.TypeCodes.ActivityType"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":true}},"/api/history-types":{"get":{"tags":["HistoryTypes"],"summary":"Gets all history types.","operationId":"HistoryTypes_GetHistoryTypes_2691B741","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.MetaData.TypeCodes.HistoryType"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/historytypes":{"get":{"tags":["HistoryTypes"],"summary":"Deprecated (Please use '/api/history-types' instead).","operationId":"HistoryTypes_GetDeprecatedHistoryTypes_76F493AB","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.MetaData.TypeCodes.HistoryType"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":true}},"/api/task-types/{id}/history-types":{"get":{"tags":["HistoryTypes"],"summary":"Gets all history types for a specific tasks type by id.","operationId":"HistoryTypes_GetHistoryTypesByTaskTypeId_C004BADF","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given activity type.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.MetaData.TypeCodes.HistoryType"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/import/mapping/{entityType}":{"post":{"tags":["Import"],"summary":"Get list of target fields for mapping.","operationId":"Import_PostImportMapping_C381049D","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"dataRequest","in":"body","description":"Headers that should be mapped to target fields.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Import.MappingDataRequest"}},{"name":"entityType","in":"path","description":"Type of entity (Contact, Company ectc.).","required":true,"type":"string","enum":["Contact","Company"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Import.MappingData"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/s3-import":{"post":{"tags":["Import"],"summary":"Start import flow.","operationId":"Import_PostImport_FF1F73F5","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"Import configurations.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Import.ImportDataRequest"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Import.GenerateImport"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/s3-import/{id}":{"get":{"tags":["Import"],"summary":"Get import results.","operationId":"Import_GetImportResult_0BF82A0A","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"Unique import identifier.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Import.ImportResult"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["Import"],"summary":"Imports contact records from .csv file.","operationId":"Import_PostStartImport_39EDCFD5","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"Unique import identifier.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/System.Void"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/{id}/campaign-results":{"get":{"tags":["MarketingAutomations"],"summary":"Get all Campaign Results matching an (optional) OData query.","operationId":"MarketingAutomations_GetCampaignResults_2DD93C76","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.MarketingAutomation.CampaignResult"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":true}},"/api/contacts/{id}/campaigns":{"get":{"tags":["MarketingAutomations"],"summary":"Get all Campaign matching an (optional) OData query.","operationId":"MarketingAutomations_GetCampaign_29DE6BDC","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.MarketingAutomation.Campaign"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/MarketingAutomations":{"post":{"tags":["MarketingAutomations"],"summary":"Create a new Marketing Automation Email","operationId":"MarketingAutomations_PostEmail_60DBC5D7","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"email","in":"body","description":"Chronicle AMA Email.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.MarketingAutomation.MarketingAutomationEmail"}}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.MarketingAutomation.MarketingAutomationEmail"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/metadata/drop-down/lists/{id}":{"get":{"tags":["MetadataInfo"],"summary":"Get specific drop-down list","operationId":"MetadataInfo_GetDropDownList_E02B587D","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"A unique identifier for a field.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.MetaData.Picklists.DropDownList"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["MetadataInfo"],"summary":"Update an already existing drop-down list","operationId":"MetadataInfo_PutDropDownList_235230B0","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given drop-down list.","required":true,"type":"string"},{"name":"list","in":"body","description":"The drop-down list definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.MetaData.Picklists.DropDownList"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.MetaData.Picklists.DropDownList"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["MetadataInfo"],"summary":"Delete an existing drop-down list","operationId":"MetadataInfo_DeleteDropDownList_796D9B2D","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given drop-down list.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/metadata/{recordType}/fields/{id}":{"get":{"tags":["MetadataInfo"],"summary":"Get a specific field","operationId":"MetadataInfo_GetField_43A47EF1","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"recordType","in":"path","description":"Specifies the core mutable record types within the ACT! application (Company, Contact, Group, Opportunity, Product or any custom entity name).","required":true,"type":"string"},{"name":"id","in":"path","description":"A unique identifier for a field.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.MetaData.Schema.Column"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["MetadataInfo"],"summary":"Update an already existing field.","operationId":"MetadataInfo_PutField_E8FC57AB","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given field.","required":true,"type":"string"},{"name":"field","in":"body","description":"The field to be modified.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.MetaData.Schema.Column"}},{"name":"recordType","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.MetaData.Schema.Column"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["MetadataInfo"],"summary":"Delete an existing field","operationId":"MetadataInfo_DeleteField_96ACDBD0","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"recordType","in":"path","description":"Specifies the core mutable record types within the ACT! application (Company, Contact, Group, Opportunity, Product or any custom entity name).","required":true,"type":"string"},{"name":"id","in":"path","description":"The unique identifier (id) for a given drop-down list.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/metadata/datatypes":{"get":{"tags":["MetadataInfo"],"summary":"Get all available defined field data types for each Act! record type.","operationId":"MetadataInfo_GetAllowedDataTypes_C0BD5F64","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"recordType","in":"query","description":"Specifies the core mutable record types within the ACT! application (Company, Contact, Group, Opportunity, Product or any custom entity name).","required":false,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.MetaData.TypeCodes.EnumTypes"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/metadata/drop-down/lists":{"get":{"tags":["MetadataInfo"],"summary":"Get all drop-down list matching an (optional) OData query","operationId":"MetadataInfo_GetDropDownLists_1C3E17D1","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.MetaData.Picklists.DropDownList"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["MetadataInfo"],"summary":"Create a new drop-down list","operationId":"MetadataInfo_PostDropDownList_15B36751","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"dropDownList","in":"body","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.MetaData.Picklists.CreateDropDownList"}}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.MetaData.Picklists.DropDownList"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/metadata/drop-down/lists/{list}/items/{item}":{"get":{"tags":["MetadataInfo"],"summary":"Gets a specific drop-down pick list item.","operationId":"MetadataInfo_GetDropDownPickListItem_C1E8E2A4","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"list","in":"path","description":"The unique identifier (id) for a given PickList.","required":true,"type":"string"},{"name":"item","in":"path","description":"The unique identifier (id) for a given item within a PickList.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.MetaData.Picklists.DropDownPickListItem"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/metadata/drop-down/lists/{list}/items":{"get":{"tags":["MetadataInfo"],"summary":"Gets all drop-down pick list item(s).","operationId":"MetadataInfo_GetDropDownPickListItems_452A074F","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"list","in":"path","description":"The unique identifier (id) for a given PickList.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.MetaData.Picklists.DropDownPickListItem"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/metadata/entities":{"get":{"tags":["MetadataInfo"],"summary":"Get all entity matching an (optional) OData query.","operationId":"MetadataInfo_GetEntities_76EDEF77","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.MetaData.Schema.Column"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["MetadataInfo"],"summary":"Create a new custom table (custom entity), optionally linked to parent entities.","operationId":"MetadataInfo_PostTable_6ABDBD3A","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"table","in":"body","description":"The custom table definition (technical name, display name, and optional parent entities).","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.MetaData.Schema.NewCustomTable"}}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.MetaData.Schema.Entity"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"409":{"description":"Conflict indicates that a custom entity with the requested name already exists."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/metadata/fields":{"get":{"tags":["MetadataInfo"],"summary":"Get all fields matching an (optional) OData query.","operationId":"MetadataInfo_GetField_76332063","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"showAll","in":"query","description":"This defines if it only shows customizable (false) metadata or visible (true) metadata","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.MetaData.Schema.Column"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/metadata/fields/{id}":{"get":{"tags":["MetadataInfo"],"summary":"Get a specific field","operationId":"MetadataInfo_GetField_92E2951A","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"A unique identifier for a field.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.MetaData.Schema.Column"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/metadata/{recordType}/fields":{"get":{"tags":["MetadataInfo"],"summary":"Get all fields matching an (optional) OData query.","operationId":"MetadataInfo_GetFields_387CA408","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"recordType","in":"path","description":"Specifies the core mutable record types within the ACT! application (Company, Contact, Group, Opportunity, Product or any custom entity name).","required":true,"type":"string"},{"name":"showAll","in":"query","description":"This defines if it only shows customizable (false) metadata or visible (true) metadata","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.MetaData.Schema.Column"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["MetadataInfo"],"summary":"Create a new field.","operationId":"MetadataInfo_PostField_AD1FA9C5","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"recordType","in":"path","description":"Specifies the core mutable record types within the ACT! application (Company, Contact, Group, Opportunity, Product or any custom entity name).","required":true,"type":"string"},{"name":"column","in":"body","description":"The field descriptor","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.MetaData.Schema.NewColumn"}}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.MetaData.Schema.NewColumn"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/metadata/{recordType}/picklists/{id}":{"get":{"tags":["MetadataInfo"],"summary":"Get specific pick list","operationId":"MetadataInfo_GetPicklist_0EAAC225","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"A unique identifier for a field.","required":true,"type":"string"},{"name":"recordType","in":"path","description":"Specifies the core mutable types within the ACT! application (Company, Contact, Group, Opportunity, Product or any custom entity name).","required":true,"type":"string"},{"name":"showAll","in":"query","description":"This defines if it only shows customizable (false) metadata or visible (true) metadata","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.MetaData.Picklists.PickList"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/metadata/{recordType}/picklists":{"get":{"tags":["MetadataInfo"],"summary":"Get all pick list matching an (optional) OData query.","operationId":"MetadataInfo_GetPicklists_8295BDC6","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"recordType","in":"path","description":"Specifies the core mutable types within the ACT! application (Company, Contact, Group, Opportunity, Product or any custom entity name).","required":true,"type":"string"},{"name":"showAll","in":"query","description":"This defines if it only shows customizable (false) metadata or visible (true) metadata","required":false,"type":"boolean"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.MetaData.Picklists.PickList"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/metadata/entities/{recordType}":{"delete":{"tags":["MetadataInfo"],"summary":"Delete an existing custom table (custom entity), including any parent-link junction tables.","operationId":"MetadataInfo_DeleteTable_98A5268E","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"recordType","in":"path","description":"The name of the custom entity to delete.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/cache-refresh":{"get":{"tags":["MetadataInfo"],"summary":"Refresh metadata cache.","operationId":"MetadataInfo_GetCacheRefresh_2B36A257","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"204":{"description":"Created indicates that the request resulted in a new resource created before the response was sent."},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["MetadataInfo"],"summary":"Refresh metadata cache.","operationId":"MetadataInfo_PostCacheRefresh_D813A0E2","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"204":{"description":"Created indicates that the request resulted in a new resource created before the response was sent."},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/notes/{id}":{"get":{"tags":["Notes"],"summary":"Get all notes matching an (optional) OData query and associated with a contact.","operationId":"Notes_Get_2C9BCB52","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given note.","required":true,"type":"string"},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the noteText ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Notes.Note"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Notes"],"summary":"Update an already existing note","operationId":"Notes_Put_3281DF1B","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given note.","required":true,"type":"string"},{"name":"note","in":"body","description":"The note definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Notes.Note"}},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the noteText ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Notes.Note"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Notes"],"summary":"Delete an existing note.","operationId":"Notes_Delete_158A8476","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given note.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"patch":{"tags":["Notes"],"summary":"Update an already existing note","description":"NoteTypeID is optional. If not supplied, the existing note type is preserved.\r\n            Passing an invalid NoteTypeID returns HTTP 400.","operationId":"Notes_Patch_5F3A0F8F","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given note.","required":true,"type":"string"},{"name":"note","in":"body","description":"The note definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Notes.Note"}},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the noteText ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Notes.Note"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/{contactId}/notes/{id}":{"delete":{"tags":["Notes"],"summary":"Delete an existing contact note.","operationId":"Notes_DeleteNoteFromContact_285BFDC0","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given note.","required":true,"type":"string"},{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact that is associated with a note.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/notes/{id}/contacts/{contactId}":{"put":{"tags":["Notes"],"summary":"Associate the contact (if it is not already present) to a note.","operationId":"Notes_PutContactInNote_E698D4D1","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given note.","required":true,"type":"string"},{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact that is associated with a history item.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Notes.Note"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["Notes"],"summary":"DEPRECATED: DELETE: api/notes/{id}/contacts/{contactID} instead.","operationId":"Notes_DEPRECATE_DisassociateNoteFromContact_A08A29EE","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given note.","required":true,"type":"string"},{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact that is associated with history item.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Notes"],"summary":"Disassociate a contact (if it is present) from a note.","operationId":"Notes_DisassociateNoteFromContact_8FEB308D","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given note.","required":true,"type":"string"},{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact that is associated with history item.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/notes":{"get":{"tags":["Notes"],"summary":"Get all notes that are associated with a given company and matching an (optional) OData query.","operationId":"Notes_Get_82BA5566","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"format","in":"query","description":"Specifics different formats that the API can convert the noteText ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Notes.Note"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["Notes"],"summary":"Create a new note.","description":"NoteTypeID is optional. If not supplied, it defaults to 100 (General).","operationId":"Notes_Post_DE6D7616","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"note","in":"body","description":"The note definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Notes.Note"}},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the noteText ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.Notes.Note"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/companies/{id}/notes":{"get":{"tags":["Notes"],"summary":"Get all notes that are associated with a given company and matching an (optional) OData query.","operationId":"Notes_GetByCompanies_AFA93DFF","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given company that is associated with a note.","required":true,"type":"string"},{"name":"showFor","in":"query","description":"Filtering based on associations: 0 = All associations, 1 = Company associations, 2 = Company contact associations.","required":false,"type":"string","enum":["All","Company","CompanyContact"]},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the noteText ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Notes.Note"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/{id}/notes":{"get":{"tags":["Notes"],"summary":"Get all notes that are associated with a given contact and matching an (optional) OData query.","operationId":"Notes_GetByContact_0ECBDD59","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given contact that is associated with a note.","required":true,"type":"string"},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the noteText ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Notes.Note"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/group/{id}/notes":{"get":{"tags":["Notes"],"summary":"This route has been deprecated use: api/groups/{id}/notes instead.","operationId":"Notes_GetByGroupDep_998BE8AB","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given group that is associated with a note.","required":true,"type":"string"},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the noteText ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Notes.Note"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":true}},"/api/groups/{id}/notes":{"get":{"tags":["Notes"],"summary":"Get all notes that are associated with a given group and matching an (optional) OData query.","operationId":"Notes_GetByGroup_032215FF","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given group that is associated with a note.","required":true,"type":"string"},{"name":"showFor","in":"query","description":"Filtering based on associations: 0 = All associations, 1 = Company associations, 2 = Company contact associations.","required":false,"type":"string","enum":["All","Group","GroupContact"]},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the noteText ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Notes.Note"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunity/{id}/notes":{"get":{"tags":["Notes"],"summary":"deprecated: use this api/opportunities/{id}/notes.","operationId":"Notes_GetByOpportunityDeprecated_8998BFA6","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given opportunity that is associated with a note.","required":true,"type":"string"},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the noteText ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Notes.Note"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":true}},"/api/opportunities/{id}/notes":{"get":{"tags":["Notes"],"summary":"Get all notes that are associated with a given opportunity and matching an (optional) OData query.","operationId":"Notes_GetByOpportunity_DB8CCF05","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given opportunity that is associated with a note.","required":true,"type":"string"},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the noteText ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Notes.Note"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/companies/{companyId}/associated-opportunities/{opportunityId}":{"put":{"tags":["Opportunities"],"summary":"Associate an opportunity to a specific company.","operationId":"Opportunities_PutAssociatedOpportunitiesToCompany_B42852B2","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"companyId","in":"path","description":"The unique identifier (id) for a given company.","required":true,"type":"string"},{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.Opportunity"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Opportunities"],"summary":"Dissociate an opportunity from a specific company.","operationId":"Opportunities_DeleteAssociatedOpportunitiesFromCompany_DBEAE28F","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"companyId","in":"path","description":"The unique identifier (id) for a given company.","required":true,"type":"string"},{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/companies/{companyId}/associated-opportunities":{"get":{"tags":["Opportunities"],"summary":"List of opportunities from a specific company and matching an (optional) OData query.","operationId":"Opportunities_GetAssociatedOpportunitiesFromCompany_D898E4CF","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"companyId","in":"path","description":"The unique identifier (id) for a given company.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.Opportunity"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Opportunities"],"summary":"Associate a list of opportunities to a specific company.","operationId":"Opportunities_PutAssociatedOpportunitiesToCompany_9E6C3979","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"companyId","in":"path","description":"The unique identifier (id) for a given company.","required":true,"type":"string"},{"name":"opportunityList","in":"body","description":"A list of opportunities.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.OpportunityListRequest"}},{"name":"phoneFormat","in":"query","description":"Phone formats: None: APC Local Format, E164: Internation Format","required":false,"type":"string","enum":["None","E164"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.Opportunity"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Opportunities"],"summary":"Dissociate a list of opportunities from a specific company.","operationId":"Opportunities_DeleteAssociatedOpportunitiesFromCompany_041429A2","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"companyId","in":"path","description":"The unique identifier (id) for a given company.","required":true,"type":"string"},{"name":"opportunityList","in":"body","description":"A list of opportunity identifiers.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.OpportunityListRequest"}}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/{contactId}/associated-opportunities/{opportunityId}":{"put":{"tags":["Opportunities"],"summary":"Associate an opportunity to a specific contact.","operationId":"Opportunities_PutAssociatedOpportunitiesToContact_11F1253C","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"},{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.Opportunity"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Opportunities"],"summary":"Dissociate an opportunity from a specific contact.","operationId":"Opportunities_DeleteAssociatedOpportunitiesFromContact_5C2F219C","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"},{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/{contactId}/associated-opportunities":{"get":{"tags":["Opportunities"],"summary":"List of opportunities from a specific contact and matching an (optional) OData query.","operationId":"Opportunities_GetAssociatedOpportunitiesFromContact_DFC33EAE","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.Opportunity"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Opportunities"],"summary":"Associate a list of opportunities to a specific contact.","operationId":"Opportunities_PutAssociatedOpportunitiesToContact_A692E128","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"},{"name":"opportunityList","in":"body","description":"A list of opportunities.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.OpportunityListRequest"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.Opportunity"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Opportunities"],"summary":"Dissociate a list of opportunities from a specific contact.","operationId":"Opportunities_DeleteAssociatedOpportunitiesFromContact_73BCA205","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"},{"name":"opportunityList","in":"body","description":"A list of opportunities.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.OpportunityListRequest"}}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/groups/{groupId}/associated-opportunities/{opportunityId}":{"put":{"tags":["Opportunities"],"summary":"Associate an opportunity to a specific group.","operationId":"Opportunities_PutAssociatedOpportunitiesToGroup_5BC8251D","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"path","description":"The unique identifier (id) for a given group.","required":true,"type":"string"},{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.Opportunity"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Opportunities"],"summary":"Dissociate an opportunity from a specific group.","operationId":"Opportunities_DeleteAssociatedOpportunitiesFromGroup_FDC315EA","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"path","description":"The unique identifier (id) for a given group.","required":true,"type":"string"},{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.Opportunity"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/groups/{groupId}/associated-opportunities":{"get":{"tags":["Opportunities"],"summary":"List of opportunities from a specific group and matching an (optional) OData query.","operationId":"Opportunities_GetAssociatedOpportunitiesFromGroup_FDD26AB8","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"path","description":"The unique identifier (id) for a given group.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.Opportunity"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Opportunities"],"summary":"Associate a list of opportunities to a specific group.","operationId":"Opportunities_PutAssociatedOpportunitiesToGroup_1AF6F015","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"path","description":"The unique identifier (id) for a given group.","required":true,"type":"string"},{"name":"opportunityList","in":"body","description":"A list of opportunities.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.OpportunityListRequest"}},{"name":"phoneFormat","in":"query","description":"","required":false,"type":"string","enum":["None","E164"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.Opportunity"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Opportunities"],"summary":"Dissociate a list of opportunities from a specific group.","operationId":"Opportunities_DeleteAssociatedOpportunitiesFromGroup_83F48409","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"path","description":"The unique identifier (id) for a given group.","required":true,"type":"string"},{"name":"opportunityList","in":"body","description":"A list of opportunities.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.OpportunityListRequest"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.Opportunity"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunities/{opportunityId}":{"get":{"tags":["Opportunities"],"summary":"Get a specific opportunity.","operationId":"Opportunities_GetOpportunity_E0756909","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.Opportunity"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Opportunities"],"summary":"Update an already existing opportunity.","operationId":"Opportunities_PutOpportunity_A7A0EC30","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"},{"name":"opportunity","in":"body","description":"The opportunity definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.Opportunity"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.Opportunity"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Opportunities"],"summary":"Delete a specific opportunity.","operationId":"Opportunities_DeleteOpportunity_C205C3A0","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"patch":{"tags":["Opportunities"],"summary":"Partially update an already existing opportunity.","operationId":"Opportunities_PatchOpportunity_254E3997","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"},{"name":"opportunity","in":"body","description":"The opportunity definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.Opportunity"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.Opportunity"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunities/processes/{processId}":{"get":{"tags":["Opportunities"],"summary":"Get a opportunity process.","operationId":"Opportunities_GetOpportunityProcess_D2CAF9EE","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"processId","in":"path","description":"The unique identifier (id) for a given process.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.Process"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Opportunities"],"summary":"Update an already existing process.","operationId":"Opportunities_PutOpportunityProcess_2391CBFF","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"processId","in":"path","description":"The unique identifier (id) for a given process.","required":true,"type":"string"},{"name":"process","in":"body","description":"The opportunity process.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.Process"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.Process"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Opportunities"],"summary":"Delete a specific opportunity process.","operationId":"Opportunities_DeleteOpportunityProcess_97684F2C","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"processId","in":"path","description":"The unique identifier (id) for a given process.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"patch":{"tags":["Opportunities"],"summary":"Partially update an already existing process.","operationId":"Opportunities_PatchOpportunityProcess_06A5EC19","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"processId","in":"path","description":"The unique identifier (id) for a given process.","required":true,"type":"string"},{"name":"process","in":"body","description":"The opportunity process.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.Process"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.Process"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunities/{opportunityId}/products/{productId}":{"get":{"tags":["Opportunities"],"summary":"Get all product(s) that are associated with a given opportunity and matching an (optional) OData query.","operationId":"Opportunities_GetOpportunityProduct_B07EB976","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"},{"name":"productId","in":"path","description":"The unique identifier (id) for a given opportunity product.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.OpportunityProduct"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Opportunities"],"summary":"Update an already existing opportunity.","operationId":"Opportunities_PutOpportunityProduct_9E7EA7C6","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"},{"name":"productId","in":"path","description":"The unique identifier (id) for a given opportunity product.","required":true,"type":"string"},{"name":"product","in":"body","description":"The opportunity product definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.OpportunityProduct"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.OpportunityProduct"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Opportunities"],"summary":"Delete a specific opportunity product.","operationId":"Opportunities_DeleteOpportunityProduct_82B0765D","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"},{"name":"productId","in":"path","description":"The unique identifier (id) for a given product that is associated with a opportunity.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"patch":{"tags":["Opportunities"],"summary":"Partially update an already existing opportunity product.","operationId":"Opportunities_PatchOpportunityProduct_647E55BB","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"},{"name":"productId","in":"path","description":"The unique identifier (id) for a given opportunity product.","required":true,"type":"string"},{"name":"product","in":"body","description":"The opportunity product definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.OpportunityProduct"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.OpportunityProduct"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunities/stages/{stageId}":{"get":{"tags":["Opportunities"],"summary":"Gets a stage.","operationId":"Opportunities_GetOpportunityStage_ACC53B3A","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"stageId","in":"path","description":"The unique identifier (id) for a given stage.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.Stage"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Opportunities"],"summary":"Update an already existing stage.","operationId":"Opportunities_PutOpportunityStage_C1A3196D","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"stageId","in":"path","description":"The unique identifier (id) for a given process.","required":true,"type":"string"},{"name":"stage","in":"body","description":"The opportunity stage.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.Stage"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.Stage"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Opportunities"],"summary":"Delete a specific opportunity stage.","operationId":"Opportunities_DeleteOpportunityStage_FBC359AE","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"stageId","in":"path","description":"The unique identifier (id) for a given stage.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"patch":{"tags":["Opportunities"],"summary":"Partially update an already existing stage.","operationId":"Opportunities_PatchOpportunityStage_33FD1F55","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"stageId","in":"path","description":"The unique identifier (id) for a given stage.","required":true,"type":"string"},{"name":"stage","in":"body","description":"The opportunity stage.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.Stage"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.Stage"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunities/lookup":{"get":{"tags":["Opportunities"],"summary":"Converts an OData filter query into criteria JSON for use with dynamic list preview endpoints","operationId":"Opportunities_GetLookup_BEE648B9","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}}},"deprecated":false}},"/api/opportunities":{"get":{"tags":["Opportunities"],"summary":"Get all opportunity matching an (optional) OData query.","operationId":"Opportunities_GetOpportunities_DC941A41","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.Opportunity"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["Opportunities"],"summary":"Create a new Opportunity.","operationId":"Opportunities_PostOpportunity_A5EFCD6E","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunity","in":"body","description":"The opportunity definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.Opportunity"}}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.Opportunity"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunity-lists":{"get":{"tags":["Opportunities"],"summary":"Get a list of opportunities matching an (optional) OData query.","operationId":"Opportunities_GetOpportunityList_CDA0CD53","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"ids","in":"query","description":"An array of unique identifier (id) for a given tasks.","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.Opportunity"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/{entityName}/{id}/associated-opportunities":{"get":{"tags":["Opportunities"],"summary":"List of opportunities from a specific custom entity and matching an (optional) OData query.","operationId":"Opportunities_GetAssociatedOpportunitiesFromCustomEntity_CAF7B8D5","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"entityName","in":"path","description":"The name of the custom entity.","required":true,"type":"string"},{"name":"id","in":"path","description":"The unique identifier (id) for a given entity row","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.Opportunity"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunities/{opportunityId}/access":{"get":{"tags":["Opportunities"],"summary":"Get all opportunity access levels matching an (optional) OData query.","operationId":"Opportunities_GetOpportunityAccessLevel_8D67555D","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier for the opportunity.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Contacts.AccessLevel"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Opportunities"],"summary":"Update an already existing opportunity access levels accessors.","operationId":"Opportunities_PutOpportunityAccessors_9206D7E6","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"},{"name":"accessLevel","in":"body","description":"The unique identifier (id) for a given accessor.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Contacts.AccessLevel"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Contacts.AccessLevel"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunities/processes":{"get":{"tags":["Opportunities"],"summary":"Get all processes matching an (optional) OData query.","operationId":"Opportunities_GetOpportunityProcesses_5865E751","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.Process"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["Opportunities"],"summary":"Create a new process.","operationId":"Opportunities_PostOpportunityProcess_4F592A0C","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"newProcess","in":"body","description":"The process to be added.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.ProcessRequest"}}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.ProcessRequest"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunities/{opportunityId}/products":{"get":{"tags":["Opportunities"],"summary":"Get all product(s) that are associated with a given opportunity and matching an (optional) OData query.","operationId":"Opportunities_GetOpportunityProducts_8E133CEE","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.OpportunityProduct"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["Opportunities"],"summary":"Create a new Opportunity Product.","operationId":"Opportunities_PostOpportunityProduct_128DC173","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity.","required":true,"type":"string"},{"name":"product","in":"body","description":"The opportunity product definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.OpportunityProduct"}}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.OpportunityProduct"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunities/stages":{"get":{"tags":["Opportunities"],"summary":"Get all stages matching an (optional) OData query.","operationId":"Opportunities_GetOpportunityStages_6D9C2133","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.Stage"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunities/processes/{processId}/stages":{"get":{"tags":["Opportunities"],"summary":"Get all stages for a given process and matching an (optional) OData query.","operationId":"Opportunities_GetOpportunityStagesByProcess_B86A73FE","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"processId","in":"path","description":"The unique identifier (id) for a given process.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.Stage"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["Opportunities"],"summary":"Create a new Stage.","operationId":"Opportunities_PostOpportunityStage_B14F6438","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"processId","in":"path","description":"The unique identifier (id) for a given process.","required":true,"type":"string"},{"name":"stage","in":"body","description":"The process stage to be added.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.StageInfo"}}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.Opportunities.Stage"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/preferences/{id}":{"put":{"tags":["Preferences"],"summary":"Create or modify user preferences.","operationId":"Preferences_PutPreferences_6DBB04E0","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","required":true,"type":"string"},{"name":"preference","in":"body","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Users.Preference"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/act.web.api.models.Users.Preference"}},"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/act.web.api.models.Users.Preference"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Preferences"],"summary":"Delete an existing user.","operationId":"Preferences_DeletePreferences_DAC20CCD","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given user preference.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/preferences":{"get":{"tags":["Preferences"],"summary":"Get the current user's preferences","operationId":"Preferences_GetPreferences_1BE4A240","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"search","in":"query","description":"A comma delimited base64 string of preference keys.","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Users.Preference"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["Preferences"],"summary":"Create or modify user preferences.","operationId":"Preferences_PostPreferences_AC8AE5E2","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"preference","in":"body","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Users.Preference"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/act.web.api.models.Users.Preference"}},"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/act.web.api.models.Users.Preference"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/preferences/contact/salutation-and-names":{"get":{"tags":["Preferences"],"summary":"Get salutation and name affixes settings","operationId":"Preferences_GetContactSalutationPreferences_2C8E9C92","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Preferences.SalutationNamePreferences"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Preferences"],"summary":"Update salutations and name affixes preferences.","operationId":"Preferences_PutContactSalutationPreferences_610E1A3F","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"{act.web.api.models.Preferences.SalutationNamePreferences}","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Preferences.SalutationNamePreferences"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Preferences.SalutationNamePreferences"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server or item not found. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/preferences/tasks":{"get":{"tags":["Preferences"],"summary":"Get task preferences.","operationId":"Preferences_GetTasksPreferences_0D5D4992","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Preferences.TaskPreferences"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Preferences"],"summary":"Update task preferences.","operationId":"Preferences_PutTasksPreferences_33BB4F54","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"model","in":"body","description":"Input data for task settings. {act.web.api.models.Preferences.TaskPreferences}","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Preferences.TaskPreferences"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Preferences.TaskPreferences"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/preferences/tasks/color-palette":{"get":{"tags":["Preferences"],"summary":"Gets all task types.","operationId":"Preferences_GetColorPalette_CD5A7DAC","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Preferences.CalendarColorPalette"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/preferences/duplicates-checking/{recordType}/fields":{"get":{"tags":["Preferences"],"summary":"Get list of fields for selected record type.","operationId":"Preferences_GetDuplicateFields_D08C6E56","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"recordType","in":"path","description":"Record type identifier (Contact|Company|Group).","required":true,"type":"string","enum":["Contact","Company","Group"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Preferences.DuplicatesField"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/preferences/duplicates-checking/{recordType}":{"get":{"tags":["Preferences"],"summary":"Get selected dup-checking options for selected record type.","operationId":"Preferences_GetContactsDuplicatesSettings_35C0DB85","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"recordType","in":"path","description":"Record type identifier (Contact|Company|Group).","required":true,"type":"string","enum":["Contact","Company","Group"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Preferences.DuplicatesPreferences"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Preferences"],"summary":"Update or create indexes info for selected record type.","operationId":"Preferences_PutContactsDuplicatesSettings_331AE30F","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"recordType","in":"path","description":"Record type identifier (Contact|Company|Group).","required":true,"type":"string","enum":["Contact","Company","Group"]},{"name":"request","in":"body","description":"List of column names for indexes.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Preferences.DuplicatesPreferences"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Preferences.DuplicatesPreferences"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/Products/{id}":{"get":{"tags":["Products"],"summary":"Get a specific product.","operationId":"Products_Get_00075A29","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given product.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Products.Product"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Products"],"summary":"Update an already existing product.","operationId":"Products_Put_90182304","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given product.","required":true,"type":"string"},{"name":"product","in":"body","description":"The product definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Products.Product"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Products.Product"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Products"],"summary":"Delete an existing product.","operationId":"Products_Delete_8EB4A086","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given product.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"patch":{"tags":["Products"],"summary":"Partially update an already existing product.","operationId":"Products_Patch_779E4AF5","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given product.","required":true,"type":"string"},{"name":"product","in":"body","description":"The product definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Products.Product"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Products.Product"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/Products":{"get":{"tags":["Products"],"summary":"Get all products matching an (optional) OData query.","operationId":"Products_Get_C9A89283","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Products.Product"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["Products"],"summary":"Create a new product.","operationId":"Products_Post_37AD3DE4","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"product","in":"body","description":"The product definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Products.Product"}}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.Products.Product"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/{contactId}/secondary-contacts/{id}":{"get":{"tags":["SecondaryContacts"],"summary":"Get a specific secondary contact.","operationId":"SecondaryContacts_Get_5AE7C09D","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier for the primary contact.","required":true,"type":"string"},{"name":"id","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"},{"name":"phoneFormat","in":"query","description":"","required":false,"type":"string","enum":["None","E164"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["SecondaryContacts"],"summary":"Update an already existing secondary contact.","operationId":"SecondaryContacts_Put_5975AAF3","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier for the primary contact.","required":true,"type":"string"},{"name":"id","in":"path","description":"The unique identifier (id) for a given secondary contact.","required":true,"type":"string"},{"name":"contact","in":"body","description":"The contact definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}},{"name":"phoneFormat","in":"query","description":"","required":false,"type":"string","enum":["None","E164"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["SecondaryContacts"],"summary":"Delete an existing secondary contact.","operationId":"SecondaryContacts_Delete_33369209","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier for the primary contact.","required":true,"type":"string"},{"name":"id","in":"path","description":"The unique identifier (id) for a given secondary contact.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"patch":{"tags":["SecondaryContacts"],"summary":"Update (partially) an already existing secondary contact.","operationId":"SecondaryContacts_Patch_29CC2E85","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier for the primary contact.","required":true,"type":"string"},{"name":"id","in":"path","description":"The unique identifier (id) for a given secondary contact.","required":true,"type":"string"},{"name":"contact","in":"body","description":"The contact definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}},{"name":"phoneFormat","in":"query","description":"","required":false,"type":"string","enum":["None","E164"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/{contactId}/secondary-contacts":{"get":{"tags":["SecondaryContacts"],"summary":"Get all secondary contacts matching an (optional) OData query.","operationId":"SecondaryContacts_Get_CD9BB980","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier for the primary contact.","required":true,"type":"string"},{"name":"phoneFormat","in":"query","description":"","required":false,"type":"string","enum":["None","E164"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["SecondaryContacts"],"summary":"Create a new secondary contact.","operationId":"SecondaryContacts_Post_C7CBE102","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier for the primary contact.","required":true,"type":"string"},{"name":"contact","in":"body","description":"The contact definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}},{"name":"phoneFormat","in":"query","description":"","required":false,"type":"string","enum":["None","E164"]}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.Contacts.Contact"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/{contactId}/secondary-contacts/{id}/promote":{"put":{"tags":["SecondaryContacts"],"summary":"Promote secondary contact to primary","operationId":"SecondaryContacts_PutPromote_BAF24408","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier for the primary contact.","required":true,"type":"string"},{"name":"id","in":"path","description":"The unique identifier (id) for a given secondary contact.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/attachments/activities/{id}":{"get":{"tags":["SupplementalFiles"],"summary":"Get a specific activity attachment.","operationId":"SupplementalFiles_GetByActivity_CF24B225","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier for the activity.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["SupplementalFiles"],"summary":"Create a new activity attachment.","operationId":"SupplementalFiles_PostActivityAttachment_1E201089","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given activity.","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted indicates that the request has been accepted for processing, but the processing may or may not been completed.","schema":{"$ref":"#/definitions/act.web.api.models.Attachments.Attachment"}},"206":{"description":"Indicates intermediate chunk accepted during chunked upload."},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"409":{"description":"Conflict indicates that the request could not be completed due to a conflict with the current state of the resource."},"415":{"description":"UnsupportedMediaType indicates that the entity of the request is in a format not supported by the requested resource."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["SupplementalFiles"],"summary":"Delete an existing activity attachment.","operationId":"SupplementalFiles_DeleteByActivity_6E842025","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given activity.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"423":{"description":"Locked indicates that an upload is currently in progress for this resource."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/attachments/documents/{id}":{"get":{"tags":["SupplementalFiles"],"summary":"Get a specific document attachment.","operationId":"SupplementalFiles_GetByDocument_969374C4","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier for the history item.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["SupplementalFiles"],"summary":"Create a new document attachment.","operationId":"SupplementalFiles_PostDocumentAttachments_32FDFB20","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given history item.","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted indicates that the request has been accepted for processing, but the processing may or may not been completed.","schema":{"$ref":"#/definitions/act.web.api.models.Attachments.Attachment"}},"206":{"description":"Indicates intermediate chunk accepted during chunked upload."},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"409":{"description":"Conflict indicates that the request could not be completed due to a conflict with the current state of the resource."},"415":{"description":"UnsupportedMediaType indicates that the entity of the request is in a format not supported by the requested resource."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["SupplementalFiles"],"summary":"Delete an existing document attachment.","operationId":"SupplementalFiles_DeleteByDocument_D3D6EC90","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given history item.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"423":{"description":"Locked indicates that an upload is currently in progress for this resource."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/attachments/history/{id}":{"get":{"tags":["SupplementalFiles"],"summary":"Get a specific history attachment.","operationId":"SupplementalFiles_GetByHistory_C6FD6D97","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier for the history item.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["SupplementalFiles"],"summary":"Create a new history attachment.","operationId":"SupplementalFiles_PostHistoryAttachments_B509AF9D","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given history item.","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted indicates that the request has been accepted for processing, but the processing may or may not been completed.","schema":{"$ref":"#/definitions/act.web.api.models.Attachments.Attachment"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"409":{"description":"Conflict indicates that the request could not be completed due to a conflict with the current state of the resource."},"415":{"description":"UnsupportedMediaType indicates that the entity of the request is in a format not supported by the requested resource."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["SupplementalFiles"],"summary":"Delete an existing history attachment.","operationId":"SupplementalFiles_DeleteByHistory_A660565D","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given history item.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/attachments/notes/{id}":{"get":{"tags":["SupplementalFiles"],"summary":"Get a specific note attachment.","operationId":"SupplementalFiles_GetByNote_E6495E1B","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier for the note.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["SupplementalFiles"],"summary":"Create a new note attachment.","operationId":"SupplementalFiles_PostNoteAttachments_ACC89468","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given note.","required":true,"type":"string"}],"responses":{"202":{"description":"Accepted indicates that the request has been accepted for processing, but the processing may or may not been completed.","schema":{"$ref":"#/definitions/act.web.api.models.Attachments.Attachment"}},"206":{"description":"Indicates intermediate chunk accepted during chunked upload."},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"409":{"description":"Conflict indicates that the request could not be completed due to a conflict with the current state of the resource."},"415":{"description":"UnsupportedMediaType indicates that the entity of the request is in a format not supported by the requested resource."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["SupplementalFiles"],"summary":"Delete an existing note attachment.","operationId":"SupplementalFiles_DeleteByNote_6C96060F","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given note.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"423":{"description":"Locked indicates that an upload is currently in progress for this resource."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/attachments/{id}/upload-status":{"get":{"tags":["SupplementalFiles"],"summary":"Returns the upload status for the given entity, allowing clients to disable\r\n            delete/edit controls while a chunked upload is in progress.","operationId":"SupplementalFiles_GetUploadStatus_A24AF9D4","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier of the entity being uploaded to.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."}},"deprecated":false}},"/api/layouts/{filename}":{"get":{"tags":["SupplementalFiles"],"summary":"Get a layout definitions.","operationId":"SupplementalFiles_GetLayoutDefinition_B202BFC9","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"filename","in":"path","description":"The filename for the layout definition.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/layouts":{"get":{"tags":["SupplementalFiles"],"summary":"Get a list of layout definitions.","operationId":"SupplementalFiles_GetLayoutDefinitions_A76A2FAC","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.SupplementalFiles.Layout"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/templates":{"post":{"tags":["SupplementalFiles"],"summary":"Upload a template.","operationId":"SupplementalFiles_PostTemplates_E92AB914","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"202":{"description":"Accepted indicates that the request has been accepted for processing, but the processing may or may not been completed.","schema":{"$ref":"#/definitions/act.web.api.models.Attachments.Attachment"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"409":{"description":"Conflict indicates that the request could not be completed due to a conflict with the current state of the resource."},"415":{"description":"UnsupportedMediaType indicates that the entity of the request is in a format not supported by the requested resource."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/sync-data/search-contacts-by-business-email":{"post":{"tags":["SyncData"],"summary":"Get contacts identifiers by business emails.","operationId":"SyncData_PostSearchContactsByBusinessEmail_094FD90D","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"emails","in":"body","description":"Array of business emails.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"object","additionalProperties":{"type":"string"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/sync-data/search-synced-external-ids":{"post":{"tags":["SyncData"],"summary":"Find existed identifiers.","operationId":"SyncData_PostSearchSyncedExternalId_8F2C702D","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"externalIds","in":"body","description":"Array of external ids.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"type":"string"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/sync-data/search-synced-calendar-uids":{"post":{"tags":["SyncData"],"summary":"Find existed calendar identifiers with related external ids.","operationId":"SyncData_PostSearchSyncedCalendarUids_AC7119F4","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"calendarUids","in":"body","description":"Array of calendar uids.","required":true,"schema":{"type":"array","items":{"type":"string"}}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.SyncData.ActivitySyncInfo"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/email-integration-cache-refresh":{"post":{"tags":["SyncData"],"summary":"Refresh email integration cache for current user","operationId":"SyncData_PostRefreshEmailIntegarionCache_480299E9","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"204":{"description":"Created indicates that the request resulted in a new resource created for non-authenticated user before the response was sent.","schema":{"$ref":"#/definitions/System.Void"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/multilanguage/currencies":{"get":{"tags":["System"],"summary":"Get a list of currency symbol from system regional settings.","operationId":"System_GetMultilanguageCurrencies_56F2B4ED","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Database.Currency"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/multilanguage/currencies/current":{"get":{"tags":["System"],"summary":"Gets the configured culture settings for the database.","operationId":"System_GetMultilanguageCurrency_403C990D","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Database.Currency"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/multilanguage/currency":{"get":{"tags":["System"],"summary":"Deprecated (Please use 'api/multilanguage/currencies/current' instead).","operationId":"System_GetMultilanguageCurrencyDeprecated_F1F71F04","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Database.Currency"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":true}},"/api/registration":{"get":{"tags":["System"],"summary":"Gets the registered Act! serial number and the total number of client access licenses.","operationId":"System_GetSerialNumber_D9EF7725","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Utilities.LicenseInfo"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/system":{"get":{"tags":["System"],"summary":"Gets version information for Act! and the Web API.","operationId":"System_GetVersion_2833248C","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/act.web.api.models.Utilities.SystemInfo"}},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/{contactId}/associated-tasks/{taskId}":{"put":{"tags":["Tasks"],"summary":"Associate the contact (if it is not already present) to an task.","operationId":"Tasks_PutAssociatedTasksFromContact_70092312","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"},{"name":"taskId","in":"path","description":"The unique identifier (id) for a given task.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivityOccurrence"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Tasks"],"summary":"Disassociate a task from a contact.","operationId":"Tasks_DeleteAssociatedTasksFromContact_B922C336","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact.","required":true,"type":"string"},{"name":"taskId","in":"path","description":"The unique identifier (id) for a given task.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/tasks/{taskId}/clear":{"put":{"tags":["Tasks"],"summary":"History a task.","operationId":"Tasks_PutClearTask_4BC27298","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"taskId","in":"path","description":"The unique identifier (id) for a given tasks.","required":true,"type":"string"},{"name":"clear","in":"body","description":"The history that will be be recorded for this action.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Tasks.TaskClearRequest"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Activities.ClearActivity"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Tasks"],"summary":"UnclearTasks an activity.","operationId":"Tasks_DeleteClearTask_3DC85A04","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"taskId","in":"path","description":"The unique identifier (id) for a given tasks.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/tasks/clear":{"put":{"tags":["Tasks"],"summary":"History a list of task.","operationId":"Tasks_PutClearTask_0212212A","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"clearTaskListRequest","in":"body","description":"The clear task or history model in the request body","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Tasks.TaskListClearRequest"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Activities.ClearActivity"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Tasks"],"summary":"UnclearTasks a cleared task.","operationId":"Tasks_DeleteClearTask_E382B558","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"unclearTaskListRequest","in":"body","description":"List of unique identifier (id) for a given tasks.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Tasks.TaskListRequest"}}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/recurring-tasks/{recurringId}":{"get":{"tags":["Tasks"],"summary":"Get a specific recurring tasks.","operationId":"Tasks_GetRecurringTasks_6D8FB44E","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"recurringId","in":"path","description":"The unique identifier (id) for a given recurring tasks.","required":true,"type":"string"},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivitySeries"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Tasks"],"summary":"Update an already existing recurring tasks","operationId":"Tasks_PutRecurringTask_0777AA11","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"recurringId","in":"path","description":"The unique identifier (id) for a given recurring tasks.","required":true,"type":"string"},{"name":"series","in":"body","description":"The recurring task definition","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivitySeries"}},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivitySeries"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Tasks"],"summary":"Delete an existing recurring tasks.","description":"This will not remove activities that were part of the series and were rescheduled.","operationId":"Tasks_DeleteRecurringTasks_82DEAE6F","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"recurringId","in":"path","description":"The unique identifier (id) for a given recurring tasks.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"patch":{"tags":["Tasks"],"summary":"Partially update an already existing recurring tasks","operationId":"Tasks_PatchRecurringTasks_AE95DD6C","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"recurringId","in":"path","description":"The unique identifier (id) for a given recurring tasks.","required":true,"type":"string"},{"name":"series","in":"body","description":"The recurring tasks definition","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivitySeries"}},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivitySeries"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/tasks/{taskId}":{"get":{"tags":["Tasks"],"summary":"Get a specific tasks.","operationId":"Tasks_GetTasks_A7AE9362","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"taskId","in":"path","description":"The unique identifier (id) for a given tasks.","required":true,"type":"string"},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivityOccurrence"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Tasks"],"summary":"Update an already existing task  (Recur Spec will be ignored)","operationId":"Tasks_PutTasks_F1B2C288","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"taskId","in":"path","description":"The unique identifier (id) for a given task.","required":true,"type":"string"},{"name":"task","in":"body","description":"The task definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivityOccurrence"}},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivityOccurrence"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Tasks"],"summary":"Delete an existing task.","operationId":"Tasks_DeleteTask_79C0B39F","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"taskId","in":"path","description":"A unique identifier (id) for a given task.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"patch":{"tags":["Tasks"],"summary":"Partially update an existing tasks  (Recur Spec will be ignored)","operationId":"Tasks_PatchTasks_419ECA90","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"taskId","in":"path","description":"The unique identifier (id) for a given tasks.","required":true,"type":"string"},{"name":"task","in":"body","description":"The tasks definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivityOccurrence"}},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivityOccurrence"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/tasks":{"get":{"tags":["Tasks"],"summary":"Get all task matching an (optional) OData query.","operationId":"Tasks_GetTasks_82532732","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Activities.ActivityOccurrence"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["Tasks"],"summary":"Create a new tasks (Recur Spec will be ignored).","operationId":"Tasks_PostTasks_87E31868","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"task","in":"body","description":"The task definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivityOccurrence"}},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivityOccurrence"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Tasks"],"summary":"Delete an existing task.","operationId":"Tasks_DeleteTasks_1FEF77B8","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"taskListRequest","in":"body","description":"A list of unique identifier (id) for a given task.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Tasks.TaskListRequest"}}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/companies/{companyId}/associated-tasks":{"get":{"tags":["Tasks"],"summary":"Get tasks associations with a given company (?showAll=All|Company|CompanyContacts) and matching an (optional) OData query.","operationId":"Tasks_GetAssociatedTasksFromCompany_EB48D54F","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"companyId","in":"path","description":"The unique identifier (id) for a given company that is associated with a task.","required":true,"type":"string"},{"name":"showFor","in":"query","description":"Filtering based on associations: 0 = All associations, 1 = Company associations, 2 = Company contact associations.","required":false,"type":"string","enum":["All","Company","CompanyContact"]},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Activities.ActivityOccurrence"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/{contactId}/associated-tasks":{"get":{"tags":["Tasks"],"summary":"Get all tasks that are associated with a given contact and matching an (optional) OData query.","operationId":"Tasks_GetAssociatedTasksFromContact_416BB7A5","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"contactId","in":"path","description":"The unique identifier (id) for a given contact that is associated with a tasks.","required":true,"type":"string"},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Activities.ActivityOccurrence"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/groups/{groupId}/associated-tasks":{"get":{"tags":["Tasks"],"summary":"Get all tasks that are associated with a given contact and matching an (optional) OData query.","operationId":"Tasks_GetAssociatedTasksFromGroup_DCEDDE6D","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"groupId","in":"path","description":"The unique identifier (id) for a given group that is associated with a tasks.","required":true,"type":"string"},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Activities.ActivityOccurrence"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/opportunities/{opportunityId}/associated-tasks":{"get":{"tags":["Tasks"],"summary":"Get all tasks that are associated with a given opportunity and matching an (optional) OData query.","operationId":"Tasks_GetAssociatedTasksFromOpportunity_A2697D87","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"opportunityId","in":"path","description":"The unique identifier (id) for a given opportunity that is associated with a task.","required":true,"type":"string"},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Activities.ActivityOccurrence"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/recurring-tasks":{"get":{"tags":["Tasks"],"summary":"Get all recurring tasks matching an (optional) OData query.","operationId":"Tasks_GetRecurringTasks_662BB41B","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]},{"name":"restriction","in":"query","description":"Controls how each recurring series is represented: All (every occurrence), FirstOccurrence (the first occurrence of each series - the default), or FirstUnclearedOccurrence (the first uncleared occurrence). Defaults to FirstOccurrence.","required":false,"type":"string","enum":["All","FirstOccurrence","FirstUnclearedOccurrence"]},{"name":"filterBy","in":"query","description":"Controls how a startTime filter is interpreted: InRange (the default - the filter selects occurrences in the range, so a series spanning several ranges is returned once per range) or InSeries (the filter is applied to the first occurrence of the whole series, so each series is returned only from the range containing its first occurrence). InSeries requires a startTime filter and cannot be combined with restriction=FirstUnclearedOccurrence.","required":false,"type":"string","enum":["InRange","InSeries"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Activities.ActivitySeries"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["Tasks"],"summary":"Create a new recurring tasks.","operationId":"Tasks_PostRecurringTask_6D08C5A4","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"series","in":"body","description":"The recurring tasks definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivitySeries"}},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivitySeries"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/tasks-lists":{"get":{"tags":["Tasks"],"summary":"Get a a list of task matching an (optional) OData query.","operationId":"Tasks_GetTasks_95690A14","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"taskIds","in":"query","description":"An array of unique identifier (id) for a given tasks.","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Activities.ActivityOccurrence"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/tasks/priorities":{"get":{"tags":["Tasks"],"summary":"Get all activity priorities.","operationId":"Tasks_GetTaskPriorities_7082F9FF","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivityPriority"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/organizers/{userId}/tasks":{"post":{"tags":["Tasks"],"summary":"Create a new task on behalf of (ScheduleFor).","operationId":"Tasks_PostScheduledForActivity_8C8B84E3","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"userId","in":"path","description":"The unique identifier (id) for the user that is organizing the task (ScheduledFor).","required":true,"type":"string"},{"name":"task","in":"body","description":"The task definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivityOccurrence"}},{"name":"format","in":"query","description":"Specifics different formats that the API can convert the details ((RichText (Default), PlainText, and HyperText).","required":false,"type":"string","enum":["auto","rtf","text","html"]}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.Activities.ActivityOccurrence"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/tasks/alarms":{"get":{"tags":["Tasks"],"summary":"Gets all currently alarmed activities for the logged-in user.","operationId":"Tasks_GetTaskAlarms_E7125A25","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Activities.AlarmedActivity"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/tasks/alarms/updates":{"get":{"tags":["Tasks"],"summary":"Gets the current alarm state for a set of activities the client is tracking,\r\n            and indicates which are no longer alarmed.","operationId":"Tasks_GetTaskAlarmUpdates_31784C81","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"activityIds","in":"query","description":"The activity IDs to check.","required":true,"type":"array","items":{"type":"string"},"collectionFormat":"multi"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Activities.AlarmedActivityChanges"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/tasks/alarms/snooze":{"put":{"tags":["Tasks"],"summary":"Snoozes the alarms for the specified activities.","operationId":"Tasks_PutSnoozeTaskAlarms_0BADF053","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"request","in":"body","description":"Activity IDs and snooze duration in minutes.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Tasks.SnoozeAlarmsRequest"}}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/tasks/alarms/mark-snooze-read":{"put":{"tags":["Tasks"],"summary":"Marks active snoozes as read for the specified activities.","operationId":"Tasks_PutMarkTaskSnoozeAlarmsRead_3A2BCC86","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"request","in":"body","description":"Activity IDs whose snoozes should be marked as read.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Tasks.AlarmRequest"}}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/tasks/alarms/mark-all-snooze-read":{"put":{"tags":["Tasks"],"summary":"Marks all active snoozes as read for the current user.","operationId":"Tasks_PutMarkAllTaskSnoozeAlarmsRead_25DB106B","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/tasks/clear-alarms":{"put":{"tags":["Tasks"],"summary":"Clears alarms for the specified activities.","operationId":"Tasks_PutClearTaskAlarmsMulti_6D1600DD","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"request","in":"body","description":"Activity IDs to clear — either the 44-character composite ID (activityId+MMddyyyy, as returned by the alarms endpoint) or a plain 36-character GUID (clears all occurrences of that activity).","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Tasks.ClearAlarmsRequest"}}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/tasks/clear-all-alarms":{"put":{"tags":["Tasks"],"summary":"Clears all alarms for the current user.","operationId":"Tasks_PutClearAllTaskAlarms_BFAB9D20","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/tasks/{id}/clear-alarms":{"put":{"tags":["Tasks"],"summary":"Clears the alarm for a single task. Accepts either a 44-character composite ID (activityId + MMddyyyy,\r\n            as returned by the alarms endpoint) or a plain 36-character GUID (clears all occurrences of that activity).","operationId":"Tasks_PutClearTaskAlarms_A1BC070F","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The alarm identifier — either the 44-character composite format (activityId+MMddyyyy) or a plain 36-character activity GUID.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Activities.ClearActivity"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/tasks/{taskId}/duplicate":{"put":{"tags":["Tasks"],"summary":"Duplicate task.","operationId":"Tasks_PutDuplicateTasks_315F2FB1","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"taskId","in":"path","description":"The unique identifier (id) for a given tasks.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Activities.ActivityOccurrence"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/tasks/duplicate":{"put":{"tags":["Tasks"],"summary":"Duplicate a list of task.","operationId":"Tasks_PutDuplicateTasks_207483BE","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"taskListRequest","in":"body","description":"The list of unique identifier(s) (id) for a given tasks.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Tasks.TaskListRequest"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Activities.ActivityOccurrence"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/organizers/{userId}/tasks/{taskId}":{"put":{"tags":["Tasks"],"summary":"Modify an existing task on behalf of (ScheduleFor).","operationId":"Tasks_PutScheduledForActivity_625FBBDC","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"taskId","in":"path","description":"The unique identifier (id) for a given task.","required":true,"type":"string"},{"name":"userId","in":"path","description":"The unique identifier (id) for the user that is organizing the task (ScheduledFor).","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/task-types/{taskTypeId}/regarding-dropdown":{"get":{"tags":["TaskTypes"],"summary":"Gets the regarding dropdown list by task type id.","operationId":"TaskTypes_GetRegardingDropdownList_9668D3E9","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"taskTypeId","in":"path","description":"","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.MetaData.Picklists.DropDownPickListItem"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/task-types":{"get":{"tags":["TaskTypes"],"summary":"Gets all task types.","operationId":"TaskTypes_Get_CA70DD31","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.TaskTypes.TaskType"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["TaskTypes"],"summary":"Create a new custom task types.","operationId":"TaskTypes_Post_49D8FCA6","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"taskType","in":"body","description":"The custom task type definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.TaskTypes.TaskType"}}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.TaskTypes.TaskType"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/task-types/{id}":{"get":{"tags":["TaskTypes"],"summary":"Get task type by identifier.","operationId":"TaskTypes_GetById_82B0E217","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given task type.","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.TaskTypes.TaskType"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["TaskTypes"],"summary":"Update an already existing custom task type.","operationId":"TaskTypes_Put_85CD258C","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given custom task type.","required":true,"type":"integer","format":"int32"},{"name":"taskType","in":"body","description":"The custom task type definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.TaskTypes.TaskType"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.TaskTypes.TaskType"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["TaskTypes"],"summary":"Delete an existing custom task type.","operationId":"TaskTypes_Delete_AA10E002","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given custom task type.","required":true,"type":"integer","format":"int32"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"patch":{"tags":["TaskTypes"],"summary":"Partially update an already existing custom task type.","operationId":"TaskTypes_Patch_C3E0417B","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given custom task type.","required":true,"type":"integer","format":"int32"},{"name":"taskType","in":"body","description":"The custom task type definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.TaskTypes.TaskType"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.TaskTypes.TaskType"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/task-types/batch":{"patch":{"tags":["TaskTypes"],"summary":"Partially update for list of already created task types.","operationId":"TaskTypes_PatchUpdateBatchOfActivityTasks_DE61FFCD","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"customTaskTypes","in":"body","description":"The list of custom task type.","required":true,"schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.TaskTypes.TaskType"}}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.TaskTypes.TaskType"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/teams/{teamNameOrId}/roster":{"get":{"tags":["Teams"],"summary":"Get a team roster.","operationId":"Teams_GetTeamRoster_7201F6F3","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"teamNameOrId","in":"path","description":"The team name or id.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Users.UserInfo"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/teams/{id}":{"get":{"tags":["Teams"],"summary":"Get a specific team.","operationId":"Teams_Get_0D2F7CC7","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given team.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Teams.Team"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Teams"],"summary":"Update an already existing team.","operationId":"Teams_Put_DE1E6972","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given team.","required":true,"type":"string"},{"name":"team","in":"body","description":"The team definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Teams.Team"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Teams.Team"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Teams"],"summary":"Delete an existing team.","operationId":"Teams_Delete_271736CA","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given team.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"patch":{"tags":["Teams"],"summary":"Partially update an already existing team.","operationId":"Teams_Patch_90233207","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given team.","required":true,"type":"string"},{"name":"team","in":"body","description":"The team definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Teams.Team"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Teams.Team"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/teams":{"get":{"tags":["Teams"],"summary":"Get all teams.","operationId":"Teams_Get_97F70E6A","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Teams.Team"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["Teams"],"summary":"Create a new team.","operationId":"Teams_Post_80B0D373","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"team","in":"body","description":"The team definition.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Teams.Team"}}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.Teams.Team"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/users/{id}":{"get":{"tags":["Users"],"summary":"Get a specific user","operationId":"Users_Get_8564C547","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given user.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Users.UserInfo"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Users"],"summary":"Delete an existing user.","operationId":"Users_Delete_3C7F08ED","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given user.","required":true,"type":"string"},{"name":"reassignTo","in":"query","description":"The unique identifier (id) for the user to reassign records to.  If null, all records for this user will be deleted.","required":false,"type":"string"},{"name":"removeContact","in":"query","description":"If true, the contact for this user will also be removed.","required":false,"type":"boolean"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/users/{id}/contact-info":{"delete":{"tags":["Users"],"summary":"Deprecated: Delete an existing user.","operationId":"Users_DeleteAndContact_6643F4AA","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given user.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":true}},"/api/users/analytics/configurations/view-definitions/{id}":{"put":{"tags":["Users"],"summary":"Deprecated (Please use Configurations: '/api/analytics/definitions/insight-views' instead).","operationId":"Users_PutAnalyticConfigurationViewDefinitions_676A59FA","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for the current logged in user.","required":true,"type":"string"},{"name":"definition","in":"body","description":"The user's profile.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Configuration.ConfigurationDefinition"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":true},"delete":{"tags":["Users"],"summary":"Deprecated (Please use Configurations: '/api/analytics/definitions/insight-views' instead).","operationId":"Users_DeleteAnalyticConfigurationViewDefinitions_BDE9AD07","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for the current logged in user.","required":true,"type":"string"}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":true}},"/api/users":{"get":{"tags":["Users"],"summary":"Get all users","operationId":"Users_Get_BF8BFFDA","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Users.UserInfo"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["Users"],"summary":"Create a new user.","operationId":"Users_Post_0F04839D","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"newUser","in":"body","description":"Information about the user.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Users.NewUser"}}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.Users.UserInfo"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/accessors":{"get":{"tags":["Users"],"summary":"Get all accessors matching an (optional) OData query.","operationId":"Users_GetAccessors_17298FE5","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Users.Accessor"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/users/analytics/configurations/view-definitions":{"get":{"tags":["Users"],"summary":"Deprecated (Please use Configurations: '/api/analytics/definitions/insight-views' instead).","operationId":"Users_GetAnalyticConfigurationViewDefinitions_3800DA22","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Configuration.ConfigurationDefinition"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":true}},"/api/users/permissions":{"get":{"tags":["Users"],"summary":"Get a specific permission.","operationId":"Users_GetAvailablePermissions_784083AF","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Users.Permission"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/users/analytics/configurations/opportunity-pipeline":{"get":{"tags":["Users"],"summary":"Deprecated (Please use Configurations: '/api/analytics/settings/opportunity-pipeline' instead).","operationId":"Users_GetOpportunityPipelineViewSettings_C69F11A7","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Users.OpportunityPipelineViewSettings"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":true}},"/api/permissions/{id}":{"get":{"tags":["Users"],"summary":"Get a specific permission.","operationId":"Users_GetPermissions_B71A17B9","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"Unique identifier for the user's permission.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Users.Feature"}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/users/{userId}/permissions/{id}":{"get":{"tags":["Users"],"summary":"Get a specific user permission.","operationId":"Users_GetPermissions_FAE9EF9C","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"},{"name":"id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.Users.Feature"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/users/{userId}/permissions":{"get":{"tags":["Users"],"summary":"Gets all user's permissions.","operationId":"Users_GetPermissions_BB6D4D6B","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"userId","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Users.Feature"}}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/permissions":{"get":{"tags":["Users"],"summary":"Get all permissions.","operationId":"Users_GetPermissions_DD385B36","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Users.Feature"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/contacts/{id}/users":{"post":{"tags":["Users"],"summary":"Convert an existing contact to a user.","operationId":"Users_Post_3CF6457E","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for the contact.","required":true,"type":"string"},{"name":"contact","in":"body","description":"Information about the user.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Users.ConvertContact"}}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.Users.UserInfo"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/users/analytics/configurations/opportunity-pipeline/{userId}":{"put":{"tags":["Users"],"summary":"Deprecated (Please use Configurations: '/api/analytics/settings/opportunity-pipeline' instead).","operationId":"Users_PutOpportunityPipelineViewSettings_CB26E079","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"userId","in":"path","description":"The unique identifier (id) for the current logged in user.","required":true,"type":"string"},{"name":"pipeline","in":"body","description":"The user's pipeline settings.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.Configuration.ConfigurationSettings"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/System.Object"}},"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":true}},"/api/webhooks/{id}/continue":{"put":{"tags":["Webhooks"],"summary":"Continue a suspended webhook.","operationId":"Webhooks_Continue_511537A0","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given webhook.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/webhooks/{id}":{"get":{"tags":["Webhooks"],"summary":"Get a specific webhook.","operationId":"Webhooks_Get_8857FC56","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given webhook.","required":true,"type":"string"}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.WebHooks.RegistrationViewModel"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"put":{"tags":["Webhooks"],"summary":"Update a webhook.","operationId":"Webhooks_Put_20B03A3C","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given webhook.","required":true,"type":"string"},{"name":"webhook","in":"body","description":"Webhook callback registration.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.WebHooks.WebhookRequest"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.WebHooks.RegistrationViewModel"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"delete":{"tags":["Webhooks"],"summary":"Delete an existing webhook.","operationId":"Webhooks_Delete_649F8293","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given webhook.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false},"patch":{"tags":["Webhooks"],"summary":"Update (Partial) an already existing webhook.","operationId":"Webhooks_Patch_B8C243E8","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given webhook.","required":true,"type":"string"},{"name":"webhook","in":"body","description":"Webhook callback registration.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.WebHooks.WebhookRequest"}}],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.WebHooks.RegistrationViewModel"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/webhooks":{"get":{"tags":["Webhooks"],"summary":"Get all webhooks matching an (optional) OData query.","operationId":"Webhooks_Get_3F017BC6","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.WebHooks.RegistrationViewModel"}}},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false},"post":{"tags":["Webhooks"],"summary":"Create a webhook.","operationId":"Webhooks_Post_EE3CCFA8","consumes":["application/json","application/xml","text/xml","application/x-www-form-urlencoded"],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"webhook","in":"body","description":"Webhook callback registration.","required":true,"schema":{"$ref":"#/definitions/act.web.api.models.WebHooks.WebhookRequest"}}],"responses":{"201":{"description":"Created indicates that the request resulted in a new resource created before the response was sent.","schema":{"$ref":"#/definitions/act.web.api.models.WebHooks.RegistrationViewModel"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/webhooks/reset-token":{"put":{"tags":["Webhooks"],"summary":"Update the current user's registrations with a new token.","operationId":"Webhooks_PutTokenReset_C1A718D3","consumes":[],"produces":["application/json","application/xml","text/xml"],"responses":{"200":{"description":"OK indicates that the request succeeded and that the requested information is in the response.","schema":{"$ref":"#/definitions/act.web.api.models.WebHooks.RegistrationViewModel"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}},"/api/webhooks/{id}/suspend":{"put":{"tags":["Webhooks"],"summary":"Suspend webhook.","operationId":"Webhooks_Suspend_A12B132D","consumes":[],"produces":["application/json","application/xml","text/xml"],"parameters":[{"name":"id","in":"path","description":"The unique identifier (id) for a given webhook.","required":true,"type":"string"}],"responses":{"204":{"description":"NoContent indicates that the request has been successfully processed and that the response is intentionally blank.","schema":{"$ref":"#/definitions/System.Object"}},"400":{"description":"BadRequest indicates that the request could not be understood by the server. BadRequest is sent when no other error is applicable, or if the exact error is unknown or does not have its own error code."},"401":{"description":"Unauthorized indicates that the requested resource requires authentication. The WWW-Authenticate header contains the details of how to perform the authentication."},"404":{"description":"NotFound indicates that the requested resource does not exist on the server."},"500":{"description":"Unexpected error."}},"deprecated":false}}},"definitions":{"System.Object":{"type":"object","properties":{}},"act.web.api.models.Activities.ActivitySeries":{"description":"","type":"object","properties":{"id":{"description":"A unique identifier that represents the activity.","type":"string"},"isCleared":{"description":"Indicates that the activity has been cleared.","type":"boolean"},"isAlarmCleared":{"description":"","type":"boolean"},"isAlarmed":{"description":"","type":"boolean"},"leadMinutes":{"format":"int32","description":"","type":"integer"},"alarmDue":{"description":"","type":"string"},"originalTime":{"format":"date-time","description":"Gets the date and time for which this activity was originally scheduled.","type":"string"},"startTime":{"format":"date-time","description":"The time the activity is to begin","type":"string"},"endTime":{"format":"date-time","description":"The time the activity is to end","type":"string"},"externalId":{"description":"Provides a unique identifier to an external system.","type":"string"},"calendarUid":{"description":"Provides a unique calendar uid, common for all invited users.","type":"string"},"duration":{"description":"Representing the difference between the start time and end time of the activity.","type":"string"},"durationDisplay":{"description":"Human-readable representation of the activity's duration (e.g. \"1 hour\"),\r\n            formatted identically to the Duration string on ActivityOccurrence.","type":"string"},"location":{"description":"Describes the physical location that the activity is to take place.","type":"string"},"isTimeless":{"description":"Indicates whether a specifies action is to be completed at a specific time-of-day.","type":"boolean"},"isAllDay":{"description":"Indicates whether a specified activity takes up entire day.","type":"boolean"},"isPrivate":{"description":"Indicates elevated security that only the creator/owner has access to this activity.","type":"boolean"},"isRecurring":{"description":"True: if activity is recurring, otherwise false.","type":"boolean","readOnly":true},"activityPriorityId":{"format":"int32","description":"Displays the type of the activity.","type":"integer"},"activityPriorityName":{"description":"Displays the priority of the activity.","type":"string"},"activityTypeId":{"format":"int32","description":"Displays the type of the activity.","type":"integer"},"activityTypeName":{"description":"Displays the type of the activity.","type":"string"},"attachment":{"$ref":"#/definitions/act.web.api.models.Attachments.Attachment","description":"Gets the attachment referenced by this note."},"bannerColor":{"description":"The banner color.","type":"string"},"details":{"description":"Additional detailed information about the activity.","type":"string"},"subject":{"description":"A description of the action to be completed.","type":"string"},"recurSpec":{"$ref":"#/definitions/act.web.api.models.Activities.RecurSpec","description":"The recurrence pattern for the activity."},"created":{"format":"date-time","description":"The date and time the activity was created.","type":"string"},"edited":{"format":"date-time","description":"The date and time the activity was last updated.","type":"string"},"scheduledById":{"description":"The id of the activity's organizer.","type":"string"},"scheduledBy":{"description":"The contact who created this activity.","type":"string"},"scheduledForId":{"description":"The id of the activity's organizer.","type":"string"},"scheduledFor":{"description":"The name of the activity's organizer.","type":"string"},"scheduledWithCompany":{"description":"Company name of the contact with whom this activity was scheduled. If more than one contact, first encountered","type":"string"},"scheduledWithEmail":{"description":"Business Email address of the contact with whom this activity was scheduled. If more than one contact, first encountered is used","type":"string"},"scheduledWithPhone":{"description":"Phone number of the contact with whom this activity was scheduled. If more than one contact, first encountered is used","type":"string"},"scheduledWithPhoneExt":{"description":"Phone number extension of the contact with whom this activity was scheduled. If more than one contact, first encountered is used","type":"string"},"companies":{"description":"List of companies that are associated to this activity.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Companies.EmbeddedCompany"}},"contacts":{"description":"The attendees scheduled for the activity.  Note: at least one contact is required.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Activities.EmbededActivityContact"}},"groups":{"description":"List a groups that are associated to this activity.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Groups.EmbeddedGroup"}},"opportunities":{"description":"List a opportunities that are associated to this activity.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.EmbeddedOpportunity"}}}},"act.web.api.models.Attachments.Attachment":{"description":"Provides properties information about attachments.","type":"object","properties":{"displayName":{"description":"Gets presentation name of the attachment.","type":"string"},"fileExtension":{"description":"Gets the extension of the Attachment","type":"string"},"fileName":{"description":"Gets a string representing the directory's full path.","type":"string"},"fileSize":{"format":"int64","description":"Gets the size (bytes) of the attachments.","type":"integer"},"fileSizeDisplay":{"description":"Gets the displayable text representation of the attachment","type":"string"},"fileType":{"description":"Gets the registered system file type name of the attachment","type":"string"},"lastModified":{"format":"date-time","description":"Gets the last modified date of the attachment","type":"string"},"personal":{"description":"Indicates whether the attachment is bound for the personal suppplemental files or the workgroup supplemental files.","type":"boolean"}}},"act.web.api.models.Activities.RecurSpec":{"description":"","type":"object","properties":{"seriesStart":{"format":"date-time","description":"Specifying the starting time for a given day.","type":"string"},"day":{"$ref":"#/definitions/act.web.api.models.Activities.RecurDay","description":"Specifying the day of a recurrence."},"seriesEnd":{"format":"date-time","description":"Specifying the ending time for a given day.","type":"string"},"isEndless":{"description":"Flag denoting whether an end date has been specified for the pattern. Note: If false, the following defaults are used: For Daily and Weekly: 2 years beyond the start date For Monthly and Yearly: June 6, 2073.","type":"boolean"},"month":{"format":"int32","description":"Represents the specific month for certain recurrence patterns","type":"integer"},"frequency":{"format":"int32","description":"Represents how often for the recurrence patterns","type":"integer"},"recurType":{"description":"Represents a unit of time used to separate recurences (i.e. Daily, Weekly, Monthly, Yearly).","enum":["None","Daily","Weekly","Monthly","Yearly"],"type":"string"}}},"act.web.api.models.Companies.EmbeddedCompany":{"description":"A company entity that displayed as a sub-child to a parent entity.","type":"object","properties":{"id":{"description":"Gets a unique identifier (id) for a given company.","type":"string"},"name":{"description":"Gets the name of the company.","type":"string"}}},"act.web.api.models.Activities.EmbededActivityContact":{"description":"","type":"object","properties":{"id":{"description":"A unique identifier that represents the attendee.","type":"string"},"displayName":{"description":"The name of the attendee.","type":"string"},"emailAddress":{"description":"The name of the attendee.","type":"string"},"isInvited":{"description":"The name of the attendee.","type":"boolean"}}},"act.web.api.models.Groups.EmbeddedGroup":{"description":"An group entity that displayed as a sub-child to a parent entity.","type":"object","properties":{"id":{"description":"Gets a unique identifier (id) for a given group.","type":"string"},"name":{"description":"Gets the name of the group.","type":"string"}}},"act.web.api.models.Opportunities.EmbeddedOpportunity":{"description":"An opportunity entity that displayed as a sub-child to a parent entity.","type":"object","properties":{"id":{"description":"Gets a unique identifier (id) for a given opportunity.","type":"string"},"name":{"description":"Gets the name of the opportunity.","type":"string"}}},"act.web.api.models.Activities.RecurDay":{"description":"Specifying the day of a recurrence.","type":"object","properties":{"dayAsInt":{"format":"int32","description":"An integer representation of the day of the week portion of a recurrence pattern.","type":"integer"},"daysOfWeek":{"description":"Representation of the day of the week portion of a recurrence pattern.","type":"array","items":{"enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"}},"typedDay":{"description":"Describing the TypedDay (Day, WeekDay or Weekend Day) for the recurrence pattern when DayType is \"Typed\".","enum":["None","Day","Weekday","WeekendDay"],"type":"string"},"dayType":{"description":"Describing the day-portion of the recurrence pattern.","enum":["None","Numbered","Named","Typed"],"type":"string"},"ordinal":{"description":"Describes recurrence in relative terms for certain recurrence patterns (i.e. First, Third, Last) .","enum":["None","First","Second","Third","Fourth","Last"],"type":"string"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Activities.ActivitySeries]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"Microsoft.AspNet.OData.ODataQueryContext":{"type":"object","properties":{"defaultQuerySettings":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.DefaultQuerySettings","readOnly":true},"model":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmModel","readOnly":true},"elementType":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmType","readOnly":true},"navigationSource":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmNavigationSource","readOnly":true},"elementClrType":{"type":"string","readOnly":true},"path":{"$ref":"#/definitions/Microsoft.AspNet.OData.Routing.ODataPath","readOnly":true},"requestContainer":{"$ref":"#/definitions/System.IServiceProvider","readOnly":true}}},"Microsoft.AspNet.OData.Query.ODataRawQueryOptions":{"type":"object","properties":{"filter":{"type":"string","readOnly":true},"apply":{"type":"string","readOnly":true},"orderBy":{"type":"string","readOnly":true},"top":{"type":"string","readOnly":true},"skip":{"type":"string","readOnly":true},"select":{"type":"string","readOnly":true},"expand":{"type":"string","readOnly":true},"count":{"type":"string","readOnly":true},"format":{"type":"string","readOnly":true},"skipToken":{"type":"string","readOnly":true},"deltaToken":{"type":"string","readOnly":true}}},"Microsoft.AspNet.OData.Query.SelectExpandQueryOption":{"type":"object","properties":{"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawSelect":{"type":"string","readOnly":true},"rawExpand":{"type":"string","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.SelectExpandQueryValidator"},"selectExpandClause":{"$ref":"#/definitions/Microsoft.OData.UriParser.SelectExpandClause","readOnly":true},"levelsMaxLiteralExpansionDepth":{"format":"int32","type":"integer"}}},"Microsoft.AspNet.OData.Query.ApplyQueryOption":{"type":"object","properties":{"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"resultClrType":{"type":"string","readOnly":true},"applyClause":{"$ref":"#/definitions/Microsoft.OData.UriParser.Aggregation.ApplyClause","readOnly":true},"rawValue":{"type":"string","readOnly":true}}},"Microsoft.AspNet.OData.Query.FilterQueryOption":{"type":"object","properties":{"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.FilterQueryValidator"},"filterClause":{"$ref":"#/definitions/Microsoft.OData.UriParser.FilterClause","readOnly":true},"rawValue":{"type":"string","readOnly":true}}},"Microsoft.AspNet.OData.Query.OrderByQueryOption":{"type":"object","properties":{"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"orderByNodes":{"type":"array","items":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByNode"},"readOnly":true},"rawValue":{"type":"string","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.OrderByQueryValidator"},"orderByClause":{"$ref":"#/definitions/Microsoft.OData.UriParser.OrderByClause","readOnly":true}}},"Microsoft.AspNet.OData.Query.SkipQueryOption":{"type":"object","properties":{"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValue":{"type":"string","readOnly":true},"value":{"format":"int32","type":"integer","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.SkipQueryValidator"}}},"Microsoft.AspNet.OData.Query.TopQueryOption":{"type":"object","properties":{"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValue":{"type":"string","readOnly":true},"value":{"format":"int32","type":"integer","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.TopQueryValidator"}}},"Microsoft.AspNet.OData.Query.CountQueryOption":{"type":"object","properties":{"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValue":{"type":"string","readOnly":true},"value":{"type":"boolean","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.CountQueryValidator"}}},"Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator":{"type":"object","properties":{}},"Microsoft.AspNet.OData.Query.DefaultQuerySettings":{"type":"object","properties":{"enableExpand":{"type":"boolean"},"enableSelect":{"type":"boolean"},"enableCount":{"type":"boolean"},"enableOrderBy":{"type":"boolean"},"enableFilter":{"type":"boolean"},"maxTop":{"format":"int32","type":"integer"}}},"Microsoft.OData.Edm.IEdmModel":{"type":"object","properties":{"schemaElements":{"type":"array","items":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmSchemaElement"},"readOnly":true},"vocabularyAnnotations":{"type":"array","items":{"$ref":"#/definitions/Microsoft.OData.Edm.Vocabularies.IEdmVocabularyAnnotation"},"readOnly":true},"referencedModels":{"type":"array","items":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmModel"},"readOnly":true},"declaredNamespaces":{"type":"array","items":{"type":"string"},"readOnly":true},"directValueAnnotationsManager":{"$ref":"#/definitions/Microsoft.OData.Edm.Vocabularies.IEdmDirectValueAnnotationsManager","readOnly":true},"entityContainer":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmEntityContainer","readOnly":true}}},"Microsoft.OData.Edm.IEdmType":{"type":"object","properties":{"typeKind":{"enum":["None","Primitive","Entity","Complex","Collection","EntityReference","Enum","TypeDefinition","Untyped","Path"],"type":"string","readOnly":true}}},"Microsoft.OData.Edm.IEdmNavigationSource":{"type":"object","properties":{"navigationPropertyBindings":{"type":"array","items":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmNavigationPropertyBinding"},"readOnly":true},"path":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmPathExpression","readOnly":true},"type":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmType","readOnly":true},"name":{"type":"string","readOnly":true}}},"Microsoft.AspNet.OData.Routing.ODataPath":{"type":"object","properties":{"edmType":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmType","readOnly":true},"navigationSource":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmNavigationSource","readOnly":true},"segments":{"type":"array","items":{"$ref":"#/definitions/Microsoft.OData.UriParser.ODataPathSegment"},"readOnly":true},"pathTemplate":{"type":"string","readOnly":true},"path":{"type":"array","items":{"$ref":"#/definitions/Microsoft.OData.UriParser.ODataPathSegment"},"readOnly":true}}},"System.IServiceProvider":{"type":"object","properties":{}},"Microsoft.AspNet.OData.Query.Validators.SelectExpandQueryValidator":{"type":"object","properties":{}},"Microsoft.OData.UriParser.SelectExpandClause":{"type":"object","properties":{"selectedItems":{"type":"array","items":{"$ref":"#/definitions/Microsoft.OData.UriParser.SelectItem"},"readOnly":true},"allSelected":{"type":"boolean","readOnly":true}}},"Microsoft.OData.UriParser.Aggregation.ApplyClause":{"type":"object","properties":{"transformations":{"type":"array","items":{"$ref":"#/definitions/Microsoft.OData.UriParser.Aggregation.TransformationNode"},"readOnly":true}}},"Microsoft.AspNet.OData.Query.Validators.FilterQueryValidator":{"type":"object","properties":{}},"Microsoft.OData.UriParser.FilterClause":{"type":"object","properties":{"expression":{"$ref":"#/definitions/Microsoft.OData.UriParser.SingleValueNode","readOnly":true},"rangeVariable":{"$ref":"#/definitions/Microsoft.OData.UriParser.RangeVariable","readOnly":true},"itemType":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmTypeReference","readOnly":true}}},"Microsoft.AspNet.OData.Query.OrderByNode":{"type":"object","properties":{"direction":{"enum":["Ascending","Descending"],"type":"string","readOnly":true}}},"Microsoft.AspNet.OData.Query.Validators.OrderByQueryValidator":{"type":"object","properties":{}},"Microsoft.OData.UriParser.OrderByClause":{"type":"object","properties":{"thenBy":{"$ref":"#/definitions/Microsoft.OData.UriParser.OrderByClause","readOnly":true},"expression":{"$ref":"#/definitions/Microsoft.OData.UriParser.SingleValueNode","readOnly":true},"direction":{"enum":["Ascending","Descending"],"type":"string","readOnly":true},"rangeVariable":{"$ref":"#/definitions/Microsoft.OData.UriParser.RangeVariable","readOnly":true},"itemType":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmTypeReference","readOnly":true}}},"Microsoft.AspNet.OData.Query.Validators.SkipQueryValidator":{"type":"object","properties":{}},"Microsoft.AspNet.OData.Query.Validators.TopQueryValidator":{"type":"object","properties":{}},"Microsoft.AspNet.OData.Query.Validators.CountQueryValidator":{"type":"object","properties":{}},"Microsoft.OData.Edm.IEdmSchemaElement":{"type":"object","properties":{"schemaElementKind":{"enum":["None","TypeDefinition","Term","Action","EntityContainer","Function"],"type":"string","readOnly":true},"namespace":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true}}},"Microsoft.OData.Edm.Vocabularies.IEdmVocabularyAnnotation":{"type":"object","properties":{"qualifier":{"type":"string","readOnly":true},"term":{"$ref":"#/definitions/Microsoft.OData.Edm.Vocabularies.IEdmTerm","readOnly":true},"target":{"$ref":"#/definitions/Microsoft.OData.Edm.Vocabularies.IEdmVocabularyAnnotatable","readOnly":true},"value":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmExpression","readOnly":true}}},"Microsoft.OData.Edm.Vocabularies.IEdmDirectValueAnnotationsManager":{"type":"object","properties":{}},"Microsoft.OData.Edm.IEdmEntityContainer":{"type":"object","properties":{"elements":{"type":"array","items":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmEntityContainerElement"},"readOnly":true},"schemaElementKind":{"enum":["None","TypeDefinition","Term","Action","EntityContainer","Function"],"type":"string","readOnly":true},"namespace":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true}}},"Microsoft.OData.Edm.IEdmNavigationPropertyBinding":{"type":"object","properties":{"navigationProperty":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmNavigationProperty","readOnly":true},"target":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmNavigationSource","readOnly":true},"path":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmPathExpression","readOnly":true}}},"Microsoft.OData.Edm.IEdmPathExpression":{"type":"object","properties":{"pathSegments":{"type":"array","items":{"type":"string"},"readOnly":true},"path":{"type":"string","readOnly":true},"expressionKind":{"enum":["None","BinaryConstant","BooleanConstant","DateTimeOffsetConstant","DecimalConstant","FloatingConstant","GuidConstant","IntegerConstant","StringConstant","DurationConstant","Null","Record","Collection","Path","If","Cast","IsType","FunctionApplication","LabeledExpressionReference","Labeled","PropertyPath","NavigationPropertyPath","DateConstant","TimeOfDayConstant","EnumMember","AnnotationPath"],"type":"string","readOnly":true}}},"Microsoft.OData.UriParser.ODataPathSegment":{"type":"object","properties":{"edmType":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmType","readOnly":true},"identifier":{"type":"string"}}},"Microsoft.OData.UriParser.SelectItem":{"type":"object","properties":{}},"Microsoft.OData.UriParser.Aggregation.TransformationNode":{"type":"object","properties":{"kind":{"enum":["Aggregate","GroupBy","Filter","Compute","Expand"],"type":"string","readOnly":true}}},"Microsoft.OData.UriParser.SingleValueNode":{"type":"object","properties":{"typeReference":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmTypeReference","readOnly":true},"kind":{"enum":["None","Constant","Convert","NonResourceRangeVariableReference","BinaryOperator","UnaryOperator","SingleValuePropertyAccess","CollectionPropertyAccess","SingleValueFunctionCall","Any","CollectionNavigationNode","SingleNavigationNode","SingleValueOpenPropertyAccess","SingleResourceCast","All","CollectionResourceCast","ResourceRangeVariableReference","SingleResourceFunctionCall","CollectionFunctionCall","CollectionResourceFunctionCall","NamedFunctionParameter","ParameterAlias","EntitySet","KeyLookup","SearchTerm","CollectionOpenPropertyAccess","CollectionComplexNode","SingleComplexNode","Count","SingleValueCast","CollectionPropertyNode","AggregatedCollectionPropertyNode","In","CollectionConstant"],"type":"string","readOnly":true}}},"Microsoft.OData.UriParser.RangeVariable":{"type":"object","properties":{"name":{"type":"string","readOnly":true},"typeReference":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmTypeReference","readOnly":true},"kind":{"format":"int32","type":"integer","readOnly":true}}},"Microsoft.OData.Edm.IEdmTypeReference":{"type":"object","properties":{"isNullable":{"type":"boolean","readOnly":true},"definition":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmType","readOnly":true}}},"Microsoft.OData.Edm.Vocabularies.IEdmTerm":{"type":"object","properties":{"type":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmTypeReference","readOnly":true},"appliesTo":{"type":"string","readOnly":true},"defaultValue":{"type":"string","readOnly":true},"schemaElementKind":{"enum":["None","TypeDefinition","Term","Action","EntityContainer","Function"],"type":"string","readOnly":true},"namespace":{"type":"string","readOnly":true},"name":{"type":"string","readOnly":true}}},"Microsoft.OData.Edm.Vocabularies.IEdmVocabularyAnnotatable":{"type":"object","properties":{}},"Microsoft.OData.Edm.IEdmExpression":{"type":"object","properties":{"expressionKind":{"enum":["None","BinaryConstant","BooleanConstant","DateTimeOffsetConstant","DecimalConstant","FloatingConstant","GuidConstant","IntegerConstant","StringConstant","DurationConstant","Null","Record","Collection","Path","If","Cast","IsType","FunctionApplication","LabeledExpressionReference","Labeled","PropertyPath","NavigationPropertyPath","DateConstant","TimeOfDayConstant","EnumMember","AnnotationPath"],"type":"string","readOnly":true}}},"Microsoft.OData.Edm.IEdmEntityContainerElement":{"type":"object","properties":{"containerElementKind":{"enum":["None","EntitySet","ActionImport","FunctionImport","Singleton"],"type":"string","readOnly":true},"container":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmEntityContainer","readOnly":true},"name":{"type":"string","readOnly":true}}},"Microsoft.OData.Edm.IEdmNavigationProperty":{"type":"object","properties":{"partner":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmNavigationProperty","readOnly":true},"onDelete":{"enum":["None","Cascade"],"type":"string","readOnly":true},"containsTarget":{"type":"boolean","readOnly":true},"referentialConstraint":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmReferentialConstraint","readOnly":true},"propertyKind":{"enum":["None","Structural","Navigation"],"type":"string","readOnly":true},"type":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmTypeReference","readOnly":true},"declaringType":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmStructuredType","readOnly":true},"name":{"type":"string","readOnly":true}}},"Microsoft.OData.Edm.IEdmReferentialConstraint":{"type":"object","properties":{"propertyPairs":{"type":"array","items":{"$ref":"#/definitions/Microsoft.OData.Edm.EdmReferentialConstraintPropertyPair"},"readOnly":true}}},"Microsoft.OData.Edm.IEdmStructuredType":{"type":"object","properties":{"isAbstract":{"type":"boolean","readOnly":true},"isOpen":{"type":"boolean","readOnly":true},"baseType":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmStructuredType","readOnly":true},"declaredProperties":{"type":"array","items":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmProperty"},"readOnly":true},"typeKind":{"enum":["None","Primitive","Entity","Complex","Collection","EntityReference","Enum","TypeDefinition","Untyped","Path"],"type":"string","readOnly":true}}},"Microsoft.OData.Edm.EdmReferentialConstraintPropertyPair":{"type":"object","properties":{"dependentProperty":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmStructuralProperty","readOnly":true},"principalProperty":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmStructuralProperty","readOnly":true}}},"Microsoft.OData.Edm.IEdmProperty":{"type":"object","properties":{"propertyKind":{"enum":["None","Structural","Navigation"],"type":"string","readOnly":true},"type":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmTypeReference","readOnly":true},"declaringType":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmStructuredType","readOnly":true},"name":{"type":"string","readOnly":true}}},"Microsoft.OData.Edm.IEdmStructuralProperty":{"type":"object","properties":{"defaultValueString":{"type":"string","readOnly":true},"propertyKind":{"enum":["None","Structural","Navigation"],"type":"string","readOnly":true},"type":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmTypeReference","readOnly":true},"declaringType":{"$ref":"#/definitions/Microsoft.OData.Edm.IEdmStructuredType","readOnly":true},"name":{"type":"string","readOnly":true}}},"act.web.api.models.Analytics.UserActivityCount":{"description":"","type":"object","properties":{"userId":{"description":"","type":"string"},"userName":{"description":"","type":"string"},"activityCount":{"format":"int32","description":"","type":"integer"}}},"act.web.api.models.Analytics.TaskListActivity":{"description":"Activity to display in user's analytics task list","type":"object","properties":{"id":{"description":"A unique identifier for the activity","type":"string"},"accessorActivityId":{"description":"The unique id of the intersection between the accessor and the activity","type":"string"},"contactCount":{"format":"int32","description":"The number of contacts associated with this activity","type":"integer"},"startTime":{"format":"date-time","description":"The start time of the activity","type":"string"},"regarding":{"description":"The subject of the activity","type":"string"},"type":{"description":"The type of the activity","type":"string"},"typeId":{"format":"int32","description":"The numerical type of the activity","type":"integer"},"priority":{"description":"The priority of the activity","type":"string"},"scheduledWith":{"description":"One or more of the contacts associated with the activity","type":"string"}}},"act.web.api.models.Analytics.UserActivityDetail":{"description":"","type":"object","properties":{"activityId":{"description":"","type":"string"},"regarding":{"description":"","type":"string"},"startTime":{"format":"date-time","description":"","type":"string"},"type":{"description":"","type":"string"},"userName":{"description":"","type":"string"},"contactName":{"description":"","type":"string"},"location":{"description":"","type":"string"}}},"act.web.api.models.Analytics.MarketingLead":{"description":"","type":"object","properties":{"contactId":{"description":"","type":"string"},"contactName":{"description":"","type":"string"},"companyName":{"description":"","type":"string"},"businessPhone":{"description":"","type":"string"},"businessEmail":{"description":"","type":"string"},"amaScore":{"format":"int32","description":"","type":"integer"},"sends":{"format":"int32","description":"","type":"integer"},"totalClicks":{"format":"int32","description":"","type":"integer"},"totalOpens":{"format":"int32","description":"","type":"integer"},"uniqueClicks":{"format":"int32","description":"","type":"integer"},"uniqueOpens":{"format":"int32","description":"","type":"integer"}}},"act.web.api.models.Analytics.CampaignLeadInfo":{"description":"A Breakdown of opportunities within a campaign (# of opportunities, total and weighted values).","type":"object","properties":{"campaignId":{"description":"","type":"string"},"campaignName":{"description":"","type":"string"},"leadCount":{"format":"int32","description":"","type":"integer"},"totalValue":{"format":"double","description":"","type":"number"},"weightedValue":{"format":"double","description":"","type":"number"}}},"act.web.api.models.Analytics.CampaignInfo":{"description":"","type":"object","properties":{"campaignId":{"description":"","type":"string"},"campaignName":{"description":"","type":"string"},"sendDate":{"format":"date-time","description":"","type":"string"}}},"act.web.api.models.Analytics.CampaignResult":{"description":"","type":"object","properties":{"campaignDate":{"format":"date-time","description":"","type":"string"},"campaignName":{"description":"","type":"string"},"sends":{"format":"int32","description":"","type":"integer"},"opens":{"format":"int32","description":"","type":"integer"},"clicks":{"format":"int32","description":"","type":"integer"},"uniqueClicks":{"format":"int32","description":"","type":"integer"},"uniqueSends":{"format":"int32","description":"","type":"integer"}}},"act.web.api.models.Analytics.CustomData":{"description":"","type":"object","properties":{"label":{"description":"","type":"string"},"value":{"format":"double","description":"","type":"number"},"numbericFormat":{"description":"","type":"string"}}},"act.web.api.models.Analytics.EmarketingHistory":{"description":"Describes historical e-marketing information.","type":"object","properties":{"sends":{"format":"int32","description":"Gets the total number of e-marketing emails sent.","type":"integer"},"emailActions":{"description":"Describes information about e-marketing email actions","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Analytics.EmailAction"}}}},"act.web.api.models.Analytics.EmailAction":{"description":"Describes information about e-marketing email actions","type":"object","properties":{"action":{"description":"Gets the e-marketing action.","type":"string"},"count":{"format":"int32","description":"Gets the total number of actions related to the number of e-marketing emails sent.","type":"integer"},"percent":{"format":"int32","description":"Gets the percentage of actions to sent e-marketing emails.","type":"integer"}}},"act.web.api.models.Analytics.KpiData":{"description":"","type":"object","properties":{"label":{"description":"","type":"string"},"value":{"format":"double","description":"","type":"number"}}},"act.web.api.models.Analytics.PeriodicRevenueArgs":{"description":"Analytics Reports: Periodic Revienue arguments.","type":"object","properties":{"interval":{"description":"An intervening period of time.","enum":["Daily","Weekly","Monthly","Quarterly","Yearly"],"type":"string"},"start":{"format":"date-time","description":"The start date that the period requesting.","type":"string"},"end":{"format":"date-time","description":"The end date that the period requesting.","type":"string"},"fiscalYearStart":{"format":"int32","description":"The oppourtunity products that will be evaludated to generate the revenue data.","type":"integer"}}},"act.web.api.models.Analytics.PeriodicActualAndPredictedRevenue":{"description":"This model describes actual revenue vs. potential revenue vs. projected (weighted) revenue for a given time period. Projected values\r\n            are available for future time periods and describe the weighted total value of open activities. Potential is the total value\r\n            of all active opportunities for the time period","type":"object","properties":{"timePeriod":{"description":"The name of a specific time interval","type":"string"},"actual":{"format":"double","description":"The actual revenue with the time period.","type":"number"},"potential":{"format":"double","description":"The total value of all active opportunities for the time period.","type":"number"},"projected":{"format":"double","description":"The projected weighted revenue for a given time period.","type":"number"}}},"act.web.api.models.Analytics.ForecastByProduct":{"description":"Sales revenue or revenues is income received from selling goods or services over a period of time.","type":"object","properties":{"productId":{"description":"Unique identifier for the product.","type":"string"},"productName":{"description":"Defines a unique name for the product.","type":"string"},"totalValue":{"format":"double","description":"The total product amount.","type":"number"},"weightedValue":{"format":"double","description":"","type":"number"},"oppCount":{"format":"int32","description":"","type":"integer"},"totalValuePercent":{"format":"double","description":"","type":"number"},"weightedValuePercent":{"format":"double","description":"","type":"number"},"countPercent":{"format":"double","description":"","type":"number"}}},"act.web.api.models.Analytics.ForecastByProductDetail":{"description":"","type":"object","properties":{"oppName":{"description":"","type":"string"},"productName":{"description":"","type":"string"},"probabilityPct":{"format":"int32","description":"","type":"integer"},"status":{"description":"","type":"string"},"productWeightedValue":{"format":"double","description":"","type":"number"},"estCloseDate":{"format":"date-time","description":"","type":"string"}}},"act.web.api.models.Analytics.ForecastByRep":{"description":"Sales revenue or revenues is income received from selling goods or services over a period of time.","type":"object","properties":{"salesRep":{"description":"The name of the sales rep.","type":"string"},"userId":{"description":"Unique identifier for the user.","type":"string"},"totalValue":{"format":"double","description":"The total product amount.","type":"number"},"weightedValue":{"format":"double","description":"","type":"number"},"oppCount":{"format":"int32","description":"","type":"integer"},"totalValuePercent":{"format":"double","description":"","type":"number"},"weightedValuePercent":{"format":"double","description":"","type":"number"},"countPercent":{"format":"double","description":"","type":"number"}}},"act.web.api.models.Analytics.ForecastByRepDetail":{"description":"","type":"object","properties":{"oppName":{"description":"","type":"string"},"repName":{"description":"","type":"string"},"probabilityPct":{"format":"int32","description":"","type":"integer"},"status":{"description":"","type":"string"},"weightedValue":{"format":"double","description":"","type":"number"},"estCloseDate":{"format":"date-time","description":"","type":"string"}}},"act.web.api.models.Analytics.PipelineOpportunity":{"description":"Opportunity currently being worked.","type":"object","properties":{"id":{"description":"A unique identifier that represents an opportunity in the pipeline.","type":"string"},"name":{"description":"The name of the opportunity","type":"string"},"contactName":{"description":"The name of the contact.","type":"string"},"companyName":{"description":"The name of the company","type":"string"},"stageId":{"description":"A unique identifier that represents the stage of the opportunity.","type":"string"},"stageName":{"description":"The name of the stage that the opportunity is in.","type":"string"},"estCloseDate":{"format":"date-time","description":"The date the opportunity is expected to be closed.","type":"string"},"totalValue":{"format":"double","description":"The total cost of the product or services.","type":"number"},"weightedValue":{"format":"double","description":"The weight of the product.","type":"number"},"contactCount":{"format":"int32","description":"The number of contacts","type":"integer"},"probabilityPct":{"format":"int32","description":"Probability of successfully winning the sale","type":"integer"}}},"act.web.api.Controllers.AnalyticsPipeline":{"description":"","type":"object","properties":{"start":{"format":"date-time","description":"","type":"string"},"end":{"format":"date-time","description":"","type":"string"},"dateType":{"format":"int32","description":"","type":"integer"},"valueType":{"format":"int32","description":"","type":"integer"},"probabilityValue":{"format":"int32","description":"","type":"integer"},"probabilityOperation":{"description":"","type":"string"},"amountValue":{"format":"double","description":"","type":"number"},"amountOperation":{"description":"","type":"string"},"omitPrivate":{"description":"","type":"boolean"},"typeIds":{"description":"","type":"array","items":{"type":"string"}},"userIds":{"description":"","type":"array","items":{"type":"string"}},"stageIds":{"description":"","type":"array","items":{"type":"string"}},"pickListItemIds":{"description":"","type":"array","items":{"type":"string"}},"statuses":{"description":"","type":"array","items":{"type":"string"}}}},"act.web.api.models.Analytics.TimeInStage":{"description":"Describes information about the average time an opportunity is in a stage.","type":"object","properties":{"stageId":{"description":"Unique identifier for the stage.","type":"string"},"stageName":{"description":"The name of the stage.","type":"string"},"avgDays":{"format":"double","description":"The average time in stage (days).","type":"number"}}},"act.web.api.models.Analytics.CloseReasonCount":{"description":"Totals the number of closed reasons.","type":"object","properties":{"reason":{"description":"","type":"string"},"count":{"format":"int32","description":"","type":"integer"}}},"act.web.api.models.Analytics.CloseReasonDetails":{"description":"","type":"object","properties":{"oppId":{"description":"","type":"string"},"oppName":{"description":"","type":"string"},"status":{"description":"","type":"string"},"closeReason":{"description":"","type":"string"},"actualValue":{"format":"double","description":"","type":"number"},"actualCloseDate":{"format":"date-time","description":"","type":"string"}}},"act.web.api.models.Analytics.OpportunityStageCount":{"description":"","type":"object","properties":{"stageId":{"description":"A unique identifier that represents the stage of the opportunity.","type":"string"},"stageName":{"description":"The name of the stage that the opportunity is in.","type":"string"},"value":{"format":"double","description":"The total cost of the product or services.","type":"number"},"count":{"format":"int32","description":"Total number of opportunties in this stage.","type":"integer"},"ordinal":{"format":"int32","description":"","type":"integer"}}},"act.web.api.models.Analytics.PeriodicRevenueAndCost":{"description":"Sales revenue or revenues is income received from selling goods or services over a period of time.","type":"object","properties":{"timePeriod":{"description":"The name of a specific time interval.","type":"string"},"alternateText":{"description":"","type":"string"},"revenue":{"format":"double","description":"The income generated from sale of goods or services, or any other use of capital or assets, associated with the main operations of an organization before any costs or expenses are deducted.","type":"number"},"cost":{"format":"double","description":"An amount that has to be paid or given up in order to get something.","type":"number"},"oppCount":{"format":"int32","description":"Total count of opportunity produces assicated with the revenue.","type":"integer"}}},"act.web.api.models.Analytics.SalesByProduct":{"description":"","type":"object","properties":{"productId":{"description":"","type":"string"},"productName":{"description":"","type":"string"},"revenue":{"format":"double","description":"","type":"number"},"percent":{"format":"int32","description":"","type":"integer"}}},"act.web.api.models.Analytics.SalesByProductDetail":{"description":"","type":"object","properties":{"oppName":{"description":"","type":"string"},"productName":{"description":"","type":"string"},"productValue":{"format":"double","description":"","type":"number"},"closedDate":{"format":"date-time","description":"","type":"string"}}},"act.web.api.models.Analytics.SalesByRep":{"description":"","type":"object","properties":{"salesRep":{"description":"","type":"string"},"revenue":{"format":"double","description":"","type":"number"},"oppCount":{"format":"int32","description":"","type":"integer"},"revenuePercent":{"format":"int32","description":"","type":"integer"},"countPercent":{"format":"int32","description":"","type":"integer"}}},"act.web.api.models.Analytics.SalesByRepDetail":{"description":"","type":"object","properties":{"oppName":{"description":"","type":"string"},"repName":{"description":"","type":"string"},"oppValue":{"format":"double","description":"","type":"number"},"closedDate":{"format":"date-time","description":"","type":"string"}}},"act.web.api.models.Analytics.WonLostMetrics":{"description":"Describes opportunity wins vs losses.","type":"object","properties":{"status":{"description":"","type":"string"},"revenue":{"format":"double","description":"","type":"number"},"count":{"format":"int32","description":"","type":"integer"},"revenuePercent":{"format":"int32","description":"","type":"integer"},"countPercent":{"format":"int32","description":"","type":"integer"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Calendar.Schedule]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Calendar.Schedule":{"description":"","type":"object","properties":{"date":{"description":"","type":"string"},"total":{"format":"int32","description":"","type":"integer"},"totalActivities":{"format":"int32","description":"","type":"integer"},"totalHistories":{"format":"int32","description":"","type":"integer"},"items":{"description":"","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Calendar.ScheduledItems"}}}},"act.web.api.models.Calendar.ScheduledItems":{"description":"","type":"object","properties":{"id":{"description":"","type":"string"},"recordType":{"description":"","enum":["Activity","History"],"type":"string"},"title":{"description":"","type":"string"},"duration":{"format":"double","description":"","type":"number"},"durationDisplay":{"description":"","type":"string"},"startTime":{"format":"date-time","description":"","type":"string"},"endTime":{"format":"date-time","description":"","type":"string"},"details":{"description":"","type":"string"},"isPrivate":{"description":"","type":"boolean"}}},"act.web.api.models.Calendar.CalendarPreferences":{"description":"","type":"object","properties":{"firsDayOfWorkWeek":{"description":"","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"},"numberOfWorkWeekDays":{"format":"int32","description":"","type":"integer"},"startTime":{"format":"date-time","description":"","type":"string"},"endTme":{"format":"date-time","description":"","type":"string"},"dailyCalendarIncrement":{"format":"int32","description":"","type":"integer"},"workWeekCalendarIncrement":{"format":"int32","description":"","type":"integer"},"firsDayOfWeek":{"description":"","enum":["Sunday","Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"type":"string"},"firstWeekOfYearMonth":{"format":"int32","description":"","type":"integer"},"firstWeekOfYearDay":{"format":"int32","description":"","type":"integer"},"calendarShowOn":{"description":"","type":"string"},"enablePopupsFor":{"description":"","type":"string"},"activityDurationBanner":{"format":"int32","description":"","type":"integer"},"displayEvents":{"description":"","type":"boolean"}}},"act.web.api.models.Companies.CompanyListRequest":{"description":"Assign contacts request model.","type":"object","properties":{"companies":{"description":"List of contact identifiers.","type":"array","items":{"type":"string"}}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Companies.Company]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Companies.Company":{"description":"A company is any entity that engages in business.","type":"object","properties":{"id":{"description":"The unique identifier (id) for this company.","type":"string"},"name":{"description":"The company's given name.","type":"string"},"address":{"$ref":"#/definitions/act.web.api.models.Address","description":"The company's business address."},"billingAddress":{"$ref":"#/definitions/act.web.api.models.Address","description":"The company's billing address."},"description":{"description":"A brief written representation or account of this company.","type":"string"},"division":{"description":"The name of a smaller part of a parent company tasked with overseeing different types of products or services than those offered by the parent company.","type":"string"},"fax":{"description":"The company's fax phone number.","type":"string"},"faxExtension":{"description":"The company's fax phone number extension.","type":"string"},"hasDivisions":{"description":"This readonly property indicates that this company has divisions.","type":"boolean"},"hierarchyLevel":{"format":"int32","description":"The positional level of where this company lays within a company hierarchy.","type":"integer"},"idStatus":{"description":"The relative social or professional position of an individual within a group or organization.","type":"string"},"importDate":{"format":"date-time","description":"This readonly property displays the date that the opportunity was imported into the system.","type":"string"},"industry":{"description":"Economic activity concerned with the processing of raw materials and manufacture of goods in factories.","type":"string"},"isPrivate":{"description":"Indicates elevated security that only the creator/owner has access to this company.","type":"boolean"},"acl":{"description":"Access Levels","type":"string"},"numberOfEmployees":{"format":"int32","description":"The total number of employees that this company operates with.","type":"integer"},"rootParentID":{"description":"The unique identifier (id) of the parent company.","type":"string"},"parentID":{"description":"The unique identifier (id) of the parent company.","type":"string"},"phone":{"description":"The company's phone number.","type":"string"},"phoneExtension":{"description":"The company's phone number extension.","type":"string"},"referredBy":{"description":"Mention or allude to.","type":"string"},"region":{"description":"A part of a country, of the world, etc., that is different or separate from other parts in some way.","type":"string"},"revenue":{"format":"double","description":"The amount of money that this company actually receives during a specific period, including discounts and deductions for returned merchandise.","type":"number"},"shippingAddress":{"$ref":"#/definitions/act.web.api.models.Address","description":"The company's shipping address."},"sicCode":{"description":"Standard Industrial Classification (SIC) codes are four-digit numerical codes assigned by the U.S. government to business establishments to identify the primary business of the establishment.","type":"string"},"territory":{"description":"Geographical area.","type":"string"},"tickerSymbol":{"description":"An arrangement of characters (usually letters) representing a particular security listed on an exchange or otherwise traded publicly.","type":"string"},"tollFreePhone":{"description":"The company's toll free phone number.","type":"string"},"tollFreeExtension":{"description":"The company's toll free phone number.","type":"string"},"website":{"description":"The company's website.","type":"string"},"recordManagerID":{"description":"The record manager.","type":"string"},"customFields":{"type":"object","additionalProperties":{"$ref":"#/definitions/System.Object"}},"created":{"format":"date-time","type":"string"},"edited":{"format":"date-time","type":"string"},"editedBy":{"type":"string"},"recordManager":{"type":"string"}}},"act.web.api.models.Address":{"description":"A specific place where a person, business, or organization can be found and where physical mail can be received.","type":"object","properties":{"line1":{"description":"Primary street address","type":"string"},"line2":{"description":"Secondary street address","type":"string"},"line3":{"description":"Miscellaneous street address","type":"string"},"city":{"description":"An inhabited place of greater size, population, or importance than a town or village.","type":"string"},"state":{"description":"A nation or territory considered as an organized political community under one government.","type":"string"},"postalCode":{"description":"A code of letters and digits added to a postal address to aid in the sorting of mail.","type":"string"},"country":{"description":"A nation with its own government, occupying a particular territory.","type":"string"},"latitude":{"format":"double","description":"The angular distance of a place north or south of the earth's equator, or of a celestial object north or south of the celestial equator, usually expressed in degrees and minutes.","type":"number"},"longitude":{"format":"double","description":"The angular distance of a place east or west of the meridian at Greenwich, England, or west of the standard meridian of a celestial object, usually expressed in degrees and minutes.","type":"number"}}},"act.web.api.models.Contacts.Contact":{"description":"The person who is designated for giving information or being a representative for an organization.","type":"object","properties":{"id":{"description":"The unique identifier (id) for this contact.","type":"string"},"idStatus":{"description":"The relative social or professional position of an individual within a group or organization.","type":"string"},"isUser":{"description":"An indicator if this contact is also a user within the system.","type":"boolean"},"company":{"description":"The organization that this contact is associated with.","type":"string"},"department":{"description":"An area of special expertise or responsibility.","type":"string"},"companyID":{"description":"The unique identifier (companyID) for a given companies.","type":"string"},"contactType":{"description":"The type of contact: Contact, Secondary, or User.","type":"string"},"namePrefix":{"description":"A patronymic prefix.","type":"string"},"firstName":{"description":"A personal given name.","type":"string"},"middleName":{"description":"A name between one's first name and surname.","type":"string"},"lastName":{"description":"The family name or surname.","type":"string"},"nameSuffix":{"description":"Provides additional information about the person that identifies an individual position, educational degree, accreditation, orffice, or honors.","type":"string"},"fullName":{"description":"The first name, any middle names, and surname of a contact.  This may also include name prefixes and sufixes that are defined within Act!","type":"string"},"isFavorite":{"description":"Assign this contact as a favorite.","type":"boolean"},"isImported":{"description":"Identifies last communication or action with a contact.","type":"boolean"},"importDate":{"format":"date-time","description":"This readonly property displays the date that the opportunity was imported into the system.","type":"string"},"isPrivate":{"description":"Identifies last communication or action with a contact.","type":"boolean"},"acl":{"description":"Access Levels","type":"string"},"lastResults":{"description":"Identifies last communication or action with a contact.","type":"string"},"lastEmail":{"format":"date-time","description":"","type":"string"},"lastAttempt":{"format":"date-time","description":"","type":"string"},"lastReach":{"format":"date-time","description":"","type":"string"},"lastMeeting":{"format":"date-time","description":"","type":"string"},"lastLetterSent":{"format":"date-time","description":"","type":"string"},"messengerID":{"description":"An online identifier alias.","type":"string"},"referredBy":{"description":"Indicates how this contact came about.","type":"string"},"salutation":{"description":"A gesture or utterance made as a greeting or acknowledgment.","type":"string"},"jobTitle":{"description":"The title or position this contact holds.","type":"string"},"amaScore":{"format":"int32","description":"The contact's","type":"integer"},"emailAddress":{"description":"A unique electronic address that an individual can be contacted.","type":"string"},"altEmailAddress":{"description":"A unique electronic address that an individual can be contacted.","type":"string"},"personalEmailAddress":{"description":"A unique electronic address that an individual can be contacted.","type":"string"},"website":{"description":"The contact's web site.","type":"string"},"birthday":{"format":"date-time","description":"The anniversary of the day on which a person was born.","type":"string"},"businessAddress":{"$ref":"#/definitions/act.web.api.models.Address","description":"The contact's business address."},"businessPhone":{"description":"The contact's business phone number.","type":"string"},"businessExtension":{"description":"The contact's business phone number extension.","type":"string"},"businessCountryCode":{"format":"int32","description":"The contact's business phone country code.","type":"integer"},"businessMaskFormat":{"description":"The contact's business phone mask format.","type":"string"},"mobilePhone":{"description":"The contact's mobile phone number.","type":"string"},"mobileExtension":{"description":"The contact's mobile phone extension.","type":"string"},"mobileCountryCode":{"format":"int32","description":"The contact's mobile phone country code.","type":"integer"},"mobileMaskFormat":{"description":"The contact's mobile phone mask format.","type":"string"},"faxPhone":{"description":"The contact's fax phone number.","type":"string"},"faxExtension":{"description":"The contact's fax phone number extension.","type":"string"},"faxCountryCode":{"format":"int32","description":"The contact's fax phone country code.","type":"integer"},"faxMaskFormat":{"description":"The contact's fax phone mask format.","type":"string"},"homeAddress":{"$ref":"#/definitions/act.web.api.models.Address","description":"The contact's home address."},"homePhone":{"description":"The contact's home phone number.","type":"string"},"homeExtension":{"description":"The contact's home phone extension.","type":"string"},"homeCountryCode":{"format":"int32","description":"The contact's home phone country code.","type":"integer"},"homeMaskFormat":{"description":"The contact's home phone mask format.","type":"string"},"alternatePhone":{"description":"The contact's alternate phone number.","type":"string"},"alternateExtension":{"description":"The contact's alternate phone number extension.","type":"string"},"alternateCountryCode":{"format":"int32","description":"The contact's alternate phone country code.","type":"integer"},"alternateMaskFormat":{"description":"The contact's alternate phone mask.","type":"string"},"pagerPhone":{"description":"The contact's pager phone number.","type":"string"},"pagerExtension":{"description":"The contact's pager phone number extension","type":"string"},"pagerCountryCode":{"format":"int32","description":"The contact's pager phone country code.","type":"integer"},"pagerMaskFormat":{"description":"The contact's pager phone mask.","type":"string"},"aemOptOut":{"description":"","type":"boolean"},"aemBounceBack":{"description":"","type":"boolean"},"recordManagerID":{"description":"The record manager.","type":"string"},"quickbooksId":{"description":"Quickbooks external Id to match record with quickbooks contact","type":"string"},"nylasContactId":{"description":"Nylas contact Id to match record with a contact","type":"string"},"customFields":{"type":"object","additionalProperties":{"$ref":"#/definitions/System.Object"}},"created":{"format":"date-time","type":"string"},"edited":{"format":"date-time","type":"string"},"editedBy":{"type":"string"},"recordManager":{"type":"string"}}},"act.web.api.models.Contacts.AccessLevel":{"description":"","type":"object","properties":{"type":{"description":"Defines the entity's access level.","enum":["Public","Private","LimitedAccess"],"type":"string"},"accessors":{"description":"The accessors that have been selected for limited access.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Users.Accessor"}}}},"act.web.api.models.Users.Accessor":{"description":"The user/team that is granted access.","type":"object","properties":{"id":{"description":"Unique identifier for the accessor/user id","type":"string"},"type":{"description":"The type of accessor (User = 1 or Team = 2)","enum":["Unknown","User","Team","Resource"],"type":"string"},"name":{"description":"The name of the accessor","type":"string"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Companies.SubCompany]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Companies.SubCompany":{"description":"A company is any entity that engages in business.","type":"object","properties":{"id":{"description":"The unique identifier (id) for this company.","type":"string"},"name":{"description":"The company's given name.","type":"string"},"rootParentID":{"description":"The unique identifier (id) of the parent company.","type":"string"},"parentID":{"description":"The unique identifier (id) of the parent company.","type":"string"},"hasDivisions":{"description":"This readonly property indicates that this company has divisions.","type":"boolean"},"hierarchyLevel":{"format":"int32","description":"The positional level of where this company lays within a company hierarchy.","type":"integer"},"divisions":{"description":"List of divisions (sub-companies) that are associated to this opportunity entity.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Companies.SubCompany"}}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Users.WebInfo]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Users.WebInfo":{"description":"","type":"object","properties":{"id":{"description":"","type":"string"},"name":{"description":"","type":"string"},"hyperLinks":{"description":"","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Users.HyperLinks"}}}},"act.web.api.models.Users.HyperLinks":{"description":"Anchor tags associated with an entity.","type":"object","properties":{"id":{"description":"","type":"string"},"name":{"description":"Name of the anchor link tag","type":"string"},"href":{"description":"Specifies the URL of the page the link will redirect to.","type":"string"}}},"act.web.api.models.Configuration.ConfigurationDefinition":{"description":"This class defines a generic view definitions.","type":"object","properties":{"userId":{"description":"The unique identifier (id) for the user.","type":"string"},"definition":{"description":"The configuration schema definitions file (XML|Json)","type":"string"}}},"act.web.api.models.Users.OpportunityPipelineViewSettings":{"description":"","type":"object","properties":{"userId":{"description":"","type":"string"},"fiscalYearStartMonth":{"format":"int32","description":"","type":"integer"},"currencySettings":{"$ref":"#/definitions/act.web.api.models.Users.CurrencySettings","description":""},"filterPreferences":{"description":"","type":"string"}}},"act.web.api.models.Users.CurrencySettings":{"description":"","type":"object","properties":{"symbol":{"description":"","type":"string"},"decimalSeparator":{"description":"","type":"string"},"groupSeparator":{"description":"","type":"string"},"symbolPosition":{"description":"","type":"string"}}},"act.web.api.models.Configuration.ConfigurationSettings":{"description":"This class defines a generic view settings.","type":"object","properties":{"userId":{"description":"The unique identifier (id) the user.","type":"string"},"settingsDefinition":{"description":"The configuration schema definitions file (XML|Json)","type":"string"}}},"act.web.api.models.Contacts.ContactListRequest":{"description":"Assign contacts request model.","type":"object","properties":{"contacts":{"description":"List of contact identifiers.","type":"array","items":{"type":"string"}}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Contacts.Contact]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.CustomEntity":{"description":"Represents the base properties of a custom table.","type":"object","properties":{"id":{"description":"The unique identifier (id) for this custom entity.","type":"string"},"companies":{"description":"List of companies that are associated to this custom entity.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Companies.EmbeddedCompany"}},"contacts":{"description":"List of contacts that are associated to this custom entity.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.EmbeddedContact"}},"groups":{"description":"List of groups that are associated to this custom entity.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Groups.EmbeddedGroup"}},"opportunity":{"description":"List of opportunity that are associated to this custom entity.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.EmbeddedOpportunity"}},"created":{"format":"date-time","description":"The date that this record was created.","type":"string"},"edited":{"format":"date-time","description":"The date that this record was edited.","type":"string"},"editedBy":{"description":"The user's name that last editied this record.","type":"string"},"recordOwner":{"description":"The user's name that owners this record.","type":"string"}}},"act.web.api.models.Contacts.EmbeddedContact":{"description":"","type":"object","properties":{"id":{"description":"","type":"string"},"displayName":{"description":"","type":"string","readOnly":true},"company":{"description":"AS-1763 - API: Expose Opportunity Company name for use in Companion, removed [JsonIgnore]","type":"string"},"isInvited":{"description":"Invited contact flag","type":"boolean"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[System.Object]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Database.DatabaseBackupInfo":{"description":"","type":"object","properties":{"fileName":{"description":"","type":"string"},"submitted":{"description":"","type":"string"},"created":{"description":"","type":"string"},"isUploaded":{"description":"","type":"boolean"},"message":{"description":"","type":"string"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Database.DatabaseBackupInfo]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Database.DatabaseBackupUser":{"description":"This model is used to create a database backup file.","type":"object","properties":{"username":{"description":"An Act! user that has administrative privileges","type":"string"},"password":{"description":"The password that will be used to secure the database basckup file.","type":"string"}}},"act.web.api.models.Database.LockRequest":{"description":"The request model when posting a database lock.","type":"object","properties":{"comments":{"description":"A brief description for the database lock.","type":"string"},"delayUntilLock":{"format":"int32","description":"The number of minutes to delay before a lock is placed on the database.","type":"integer"},"reason":{"description":"The reason for the lock.","enum":["General","Restore","SchemaChanges"],"type":"string"}}},"act.web.api.models.Database.LockResult":{"description":"","type":"object","properties":{"userId":{"description":"The user identifier that is requesting a database lock.","type":"string"},"username":{"description":"The user's name.","type":"string"},"lockTypeId":{"description":"An identifier for the type of lock being applied.","enum":["UNLOCK","PENDING_LOCK","LOCK"],"type":"string"},"lockType":{"description":"The name of the locking type.","type":"string"},"reasonId":{"description":"An identifier for the reason of the lock being applied.","enum":["General","Restore","Delete","Repair","SchemaChanges","TierUpgrade","SchemaUpdate","MoveDatabase"],"type":"string"},"reason":{"description":"The name of the locking reason.","type":"string"},"issued":{"format":"date-time","description":"The datetime that the database lock was requested.","type":"string"},"effective":{"format":"date-time","description":"The datetime that the database lock was applied or will be applied.","type":"string"},"applyLockIn":{"description":"Amount of time until a database lock is applied.","type":"string"},"comments":{"description":"A brief description for the database lock.","type":"string"}}},"act.web.api.models.Database.NewDatabaseRequest":{"description":"The database name must begin with a letter, consists only of letters, numbers, and underscore characters.","required":["databaseName","username","password"],"type":"object","properties":{"databaseName":{"description":"Database name (no spaces, punctuation, and must begin with a letter)  Maximum length is 32 characters.","maxLength":32,"minLength":0,"type":"string"},"username":{"description":"The database administrator","type":"string"},"password":{"description":"The database administrator's password.","type":"string"},"shared":{"description":"Database will be a shared","type":"boolean"},"currency":{"description":"The currency format that will be used (default if not supplied).\r\n            api/multilanguage/currencies -- (DisplayText)","type":"string"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Database.OpenSession]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Histories.History]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Histories.History":{"description":"","type":"object","properties":{"id":{"description":"","type":"string"},"recordManagerID":{"description":"","type":"string"},"recordManager":{"description":"","type":"string"},"createUserID":{"description":"","type":"string"},"createUserName":{"description":"","type":"string"},"editUserID":{"description":"","type":"string"},"editUserName":{"description":"","type":"string"},"contactEmail":{"description":"","type":"string"},"contactPhone":{"description":"","type":"string"},"contactPhoneExt":{"description":"","type":"string"},"contactCompany":{"description":"","type":"string"},"isPrivate":{"description":"","type":"boolean"},"details":{"description":"","type":"string"},"regarding":{"description":"","type":"string"},"duration":{"description":"","type":"string"},"startTime":{"format":"date-time","description":"","type":"string"},"endTime":{"format":"date-time","description":"","type":"string"},"outlookID":{"description":"","type":"string"},"historyTypeID":{"format":"int32","description":"","type":"integer"},"historyType":{"$ref":"#/definitions/act.web.api.models.Histories.HistoryType","description":""},"created":{"format":"date-time","description":"","type":"string"},"edited":{"format":"date-time","description":"","type":"string"},"companies":{"description":"List of companies that are associated to this history entity.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Companies.EmbeddedCompany"}},"contacts":{"description":"List of contacts that are associated to this history entity.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.EmbeddedContact"}},"groups":{"description":"List a groups that are associated to this history entity.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Groups.EmbeddedGroup"}},"opportunities":{"description":"List a opportunities that are associated to this history entity.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.EmbeddedOpportunity"}},"attachment":{"$ref":"#/definitions/act.web.api.models.Attachments.Attachment","description":"Gets the attachment referenced by this history item."}}},"act.web.api.models.Histories.HistoryType":{"description":"This class provides information about the history event.","type":"object","properties":{"id":{"format":"int32","description":"This unique identifier (HistoryTypeId) for a given history type.","type":"integer"},"name":{"description":"This defines the type of history event at which it will be known.","type":"string"},"activityTypeId":{"format":"int32","description":"This defines the type of activity event at which it will be known.","type":"integer"},"activityTypeName":{"description":"This defines the type of activity event at which it will be known.","type":"string"},"description":{"description":"A written representation or account of a history event.","type":"string"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.MetaData.TypeCodes.HistoryType]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.MetaData.TypeCodes.HistoryType":{"description":"","type":"object","properties":{"id":{"format":"int32","description":"","type":"integer"},"name":{"description":"","type":"string"},"activityTypeId":{"description":"","type":"string"},"activityTypeName":{"description":"","type":"string"},"description":{"description":"","type":"string"},"isActive":{"description":"","type":"boolean"},"isCustom":{"description":"","type":"boolean"},"isDefault":{"description":"","type":"boolean"},"isUserRecordable":{"description":"","type":"boolean"}}},"act.web.api.models.MetaData.TypeCodes.ActivityType":{"description":"","type":"object","properties":{"id":{"format":"int32","description":"","type":"integer"},"name":{"description":"","type":"string"},"description":{"description":"","type":"string"},"isActive":{"description":"","type":"boolean"},"isCustom":{"description":"","type":"boolean"},"activityTypeGuid":{"description":"","type":"string"}}},"act.web.api.models.Geographics.ContactCountByLocation":{"description":"A nation with its own government, occupying a particular territory.","type":"object","properties":{"countryName":{"description":"A nation with its own government, occupying a particular territory.","type":"string"},"postalCode":{"description":"A code of letters and digits added to a postal address to aid in the sorting of mail.","type":"string"},"latitude":{"format":"double","description":"The angular distance of a place north or south of the earth's equator, or of a celestial object north or south of the celestial equator, usually expressed in degrees and minutes.","type":"number"},"longitude":{"format":"double","description":"The angular distance of a place east or west of the meridian at Greenwich, England, or west of the standard meridian of a celestial object, usually expressed in degrees and minutes.","type":"number"},"contactCount":{"format":"int32","description":"Total number of contacts for a given location.","type":"integer"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Geographics.Country]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Geographics.Country":{"description":"A nation with its own government, occupying a particular territory.","type":"object","properties":{"id":{"description":"The unique identifier (id) for this country.","type":"string"},"name":{"description":"The country's given name.","type":"string"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Geographics.Mask]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Geographics.Mask":{"description":"","type":"object","properties":{"id":{"description":"The unique identifier (id) for this phone format mask.","type":"string"},"country":{"$ref":"#/definitions/act.web.api.models.Geographics.Country","description":"A territory where this phone format mask is uses."},"default":{"description":"Indicates that this mask is the default phone format mask.","type":"boolean"},"format":{"description":"The mask that is used to format the phone number.","type":"string"},"isActive":{"description":"Indicates that this mask is in an active state or not.","type":"boolean"}}},"act.web.api.models.Groups.GroupListRequest":{"description":"Assign group request model.","type":"object","properties":{"groups":{"description":"List of group identifiers.","type":"array","items":{"type":"string"}}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Groups.Group]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Groups.Group":{"description":"Represents a group of ACT! entities.","type":"object","properties":{"id":{"description":"The unique identifier (id) for a group.","type":"string"},"name":{"description":"The name of the group.","type":"string"},"description":{"description":"A brief written respresentation of a group.","type":"string"},"contacts":{"format":"int32","description":"Get the total number of contacts within the group.\r\n            Contacts is nullable and hide it if the value is null","type":"integer"},"parentID":{"description":"The group's parent entity.","type":"string"},"hasSubgroups":{"description":"This readonly property indicates that this group has sub groups.","type":"boolean"},"hierarchyLevel":{"format":"int32","description":"The level this group appears in its hierarchy.","type":"integer"},"isPrivate":{"description":"Indicates elevated security that only the creator/owner has access to this company.","type":"boolean"},"acl":{"description":"Access Levels","type":"string"},"importDate":{"format":"date-time","description":"This readonly property displays the date that the opportunity was imported into the system.","type":"string"},"address":{"$ref":"#/definitions/act.web.api.models.Address","description":"The group address."},"recordManagerID":{"description":"The record manager.","type":"string"},"customFields":{"type":"object","additionalProperties":{"$ref":"#/definitions/System.Object"}},"created":{"format":"date-time","type":"string"},"edited":{"format":"date-time","type":"string"},"editedBy":{"type":"string"},"recordManager":{"type":"string"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Lists.Criteria]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Lists.Criteria":{"description":"Represents a single criteria item for filtering opportunities","type":"object","properties":{"columnId":{"type":"string"},"tableName":{"type":"string"},"columnName":{"type":"string"},"tableDisplayName":{"type":"string"},"columnDisplayName":{"type":"string"},"domain":{"enum":["IDKey","Boolean","DateTime","String","Numeric","Image","Calculated","Memo","AnnualEvent"],"type":"string"},"operator":{"enum":["Contains","StartsWith","EndsWith","EqualTo","NotEqualTo","GreaterThan","GreaterThanEqualTo","LessThan","LessThanEqualTo","Between","OnOrAfter","OnOrBefore","WithinLast","WithinNext","DoesNotContain","OlderThan","AfterNext","MonthEquals","DayEquals","YearEquals","MonthNotEquals","DayNotEquals","YearNotEquals","MonthGreaterThan","DayGreaterThan","YearGreaterThan","MonthGreaterThanEqualTo","DayGreaterThanEqualTo","YearGreaterThanEqualTo","MonthLessThan","DayLessThan","YearLessThan","MonthLessThanEqualTo","DayLessThanEqualTo","YearLessThanEqualTo","ContainsData","DoesNotContainData"],"type":"string"},"leftParentheses":{"format":"int32","type":"integer"},"rightParentheses":{"format":"int32","type":"integer"},"values":{"type":"array","items":{"$ref":"#/definitions/act.web.api.models.Lists.XmlValue"}},"logicalOperator":{"enum":["End","And","Or"],"type":"string"}}},"act.web.api.models.Lists.XmlValue":{"type":"object","properties":{"type":{"type":"string"},"dataItem":{"type":"string"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Lists.DynamicListMetadata]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Lists.DynamicListMetadata":{"description":"","type":"object","properties":{"name":{"type":"string"},"type":{"type":"string"},"fields":{"description":"The defines all the fields that can be used to build a dynamic list.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Lists.DynamicListMetadataFields"}}}},"act.web.api.models.Lists.DynamicListMetadataFields":{"description":"","type":"object","properties":{"name":{"description":"Readable name of the field.","type":"string"},"table":{"description":"The table/view where the data was found.","type":"string"},"column":{"description":"The name of the column","type":"string"},"dataType":{"description":"The criteria value will be represented by this datatype.","enum":["IDKey","Boolean","DateTime","String","Numeric","Image","Calculated","Memo","AnnualEvent"],"type":"string"},"list":{"$ref":"#/definitions/act.web.api.models.Lists.DynamicListDropdown","description":"The dropdown list that is assigned to the column."}}},"act.web.api.models.Lists.DynamicListDropdown":{"description":"","type":"object","properties":{"name":{"description":"The name of the dropdown list.","type":"string"},"isEditable":{"description":"If values can be added outside of what is defined in the list.","type":"boolean"},"items":{"description":"The value items of the dropdown list.","type":"array","items":{"type":"string"}}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Lists.Operator]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Opportunities.Opportunity]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Opportunities.Opportunity":{"description":"A contact or company which has been qualified.","type":"object","properties":{"id":{"description":"A unique identifier that represents a potential piece of business.","type":"string"},"name":{"description":"The name of an opportunity.","type":"string"},"actualCloseDate":{"format":"date-time","description":"The date that the opportunity as closed.","type":"string"},"companies":{"description":"List of companies that are associated to this opportunity entity.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Companies.EmbeddedCompany"}},"competitor":{"description":"Gets the name of the competitor for this opportunity.","type":"string"},"contactNames":{"description":"The names of the contacts associated with this opportunity.","type":"string"},"contacts":{"description":"List of contacts that are associated to this opportunity entity.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.EmbeddedContact"}},"creator":{"description":"The name of the creator of this opportunity.","type":"string"},"daysOpen":{"format":"int32","description":"The number of days this opportunity has been opened.","type":"integer"},"daysInStage":{"format":"int32","description":"the number of days this opportunity has been in a given stage.","type":"integer"},"estimatedCloseDate":{"format":"date-time","description":"The date the opportunity is expected to be closed.","type":"string"},"stageStartDate":{"format":"date-time","description":"The date the opportunity stage started.","type":"string"},"grossMargin":{"format":"double","description":"Represents the net sales less the cost of goods and services sold.","type":"number"},"groups":{"description":"List of groups that are associated to this opportunity entity.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Groups.EmbeddedGroup"}},"isPrivate":{"description":"Indicates whether this opportunity is private","type":"boolean"},"acl":{"description":"Access Levels","type":"string"},"openDate":{"format":"date-time","description":"The date the opportunity was opened.","type":"string"},"probability":{"format":"int32","description":"The likelihood this opportunity will will be won by the close date.","type":"integer"},"productTotal":{"format":"double","description":"The total cost of the product or services.","type":"number"},"product":{"description":"Comma-delimited list of product names.","type":"string"},"reason":{"description":"Describes why the opportunity status changed.","type":"string"},"source":{"description":"Describes the source of the opportunity.","type":"string"},"sourceId":{"description":"The external source id for the opportunity","type":"string"},"stage":{"$ref":"#/definitions/act.web.api.models.Opportunities.Stage","description":"The stage of the opportunity."},"status":{"description":"This gets/sets the opportunity status (0 = Open, 1 = Won, 2 = Lost, or 3 = inactive).","enum":["Open","Won","Lost","Inactive"],"type":"string"},"statusName":{"description":"This displays the opportunity status name (Open, Won, Lost, or inactive).","type":"string","readOnly":true},"importDate":{"format":"date-time","description":"This readonly property displays the date that the opportunity was imported into the system.","type":"string"},"totalPerCompany":{"format":"double","description":"The average total per associated company.","type":"number"},"totalPerContact":{"format":"double","description":"The average total per associated contact.","type":"number"},"totalPerGroup":{"format":"double","description":"The average total per associated group.","type":"number"},"weightedTotal":{"format":"double","description":"The weight of the product.","type":"number"},"quickbooksInvoiceId":{"description":"Quickbooks external Id to match record with quickbooks contact","type":"string"},"relatedEntitiesResolver":{"description":"If true: prevents related entities from serializing.","type":"boolean"},"recordManagerID":{"description":"The record manager.","type":"string"},"customFields":{"type":"object","additionalProperties":{"$ref":"#/definitions/System.Object"}},"created":{"format":"date-time","type":"string"},"edited":{"format":"date-time","type":"string"},"editedBy":{"type":"string"},"recordManager":{"type":"string"}}},"act.web.api.models.Opportunities.Stage":{"description":"A class describes the stage state of a particular {act.web.api.models.Opportunities.Opportunity} object.","type":"object","properties":{"id":{"description":"Gets the unique identifier of the stage.","type":"string"},"name":{"description":"Gets/Sets the name of the stage.","type":"string"},"description":{"description":"Gets/Sets the description of the stage.","type":"string"},"probability":{"format":"int32","description":"Gets/Sets the probability of the stage.","type":"integer"},"number":{"format":"int32","description":"The order of the stage progresses throw the process lifecycle.","type":"integer"},"process":{"$ref":"#/definitions/act.web.api.models.Opportunities.Process","description":"Represents the current process for a given opportunity"}}},"act.web.api.models.Opportunities.Process":{"description":"The current process for a given opportunity.","type":"object","properties":{"id":{"description":"Gets the unique identifier of the process.","type":"string"},"name":{"description":"The name of the process.","type":"string"},"description":{"description":"The description of the process.","type":"string"},"status":{"description":"The description of the process.","enum":["None","Active","Inactive"],"type":"string"},"stagesCount":{"format":"int32","description":"Count of stages of current process","type":"integer"},"stages":{"description":"Customized stages for the new process","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.Stage"}}}},"act.web.api.models.Import.MappingDataRequest":{"type":"object","properties":{"headers":{"description":"Array of headers to map with fields","type":"array","items":{"type":"string"}}}},"act.web.api.models.Import.MappingData":{"description":"","type":"object","properties":{"targetFields":{"description":"List of fields valid for mapping","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Import.WebImportField"}},"mappings":{"description":"Fields mappings","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Import.ResolvedMapping"}},"uniqueHeaders":{"description":"Define if all headers are unique","type":"boolean"}}},"act.web.api.models.Import.WebImportField":{"type":"object","properties":{"name":{"description":"Field name","type":"string"},"display":{"description":"Display name","type":"string"}}},"act.web.api.models.Import.ResolvedMapping":{"type":"object","properties":{"sourceField":{"$ref":"#/definitions/act.web.api.models.Import.WebImportField","description":""},"targetField":{"$ref":"#/definitions/act.web.api.models.Import.WebImportField","description":""}}},"act.web.api.models.Import.ImportDataRequest":{"type":"object","properties":{"mappings":{"description":"","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Import.ResolvedMapping"}},"hasHeaders":{"description":"","type":"boolean"},"contentType":{"description":"","type":"string"},"entityType":{"description":"","enum":["Contact","Company"],"type":"string"},"tempFilePath":{"description":"","type":"string"}}},"act.web.api.models.Import.GenerateImport":{"type":"object","properties":{"id":{"type":"string"},"preSignedUrl":{"type":"string"}}},"act.web.api.models.Import.ImportResult":{"description":"Result of contacts import","type":"object","properties":{"isReady":{"description":"Define if import completed","type":"boolean"},"success":{"description":"Define if import was successful","type":"boolean"},"errorMessage":{"description":"Error message if import went wrong","type":"string"},"successCount":{"format":"int32","description":"Count of successfully added/merged records","type":"integer"},"failedCount":{"format":"int32","description":"Count of failed records","type":"integer"},"failedErrors":{"description":"","type":"array","items":{"type":"string"}}}},"System.Void":{"type":"object","properties":{}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.MarketingAutomation.CampaignResult]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.MarketingAutomation.CampaignResult":{"description":"","type":"object","properties":{"campaignId":{"description":"","type":"string"},"campaignEmailId":{"description":"","type":"string"},"campaignName":{"description":"","type":"string"},"campaignResultsId":{"description":"","type":"string"},"clicks":{"format":"int32","description":"","type":"integer"},"createDate":{"format":"date-time","description":"","type":"string"},"createUserId":{"description":"","type":"string"},"creatorName":{"description":"","type":"string"},"editDate":{"format":"date-time","description":"","type":"string"},"editorName":{"description":"","type":"string"},"editUserId":{"description":"","type":"string"},"hasComplained":{"description":"","type":"boolean"},"isBounced":{"description":"","type":"boolean"},"isPrivate":{"description":"","type":"boolean"},"isUnsubscribed":{"description":"","type":"boolean"},"jumpToURL":{"description":"","type":"string"},"lastClickDate":{"format":"date-time","description":"","type":"string"},"managerName":{"description":"","type":"string"},"manageUserId":{"description":"","type":"string"},"openDate":{"format":"date-time","description":"","type":"string"},"opens":{"format":"int32","description":"","type":"integer"},"recipientEmail":{"description":"","type":"string"},"sendDate":{"format":"date-time","description":"","type":"string"},"senderEmail":{"description":"","type":"string"},"subjectLine":{"description":"","type":"string"},"typeEnum":{"format":"int32","description":"","type":"integer"},"url":{"description":"","type":"string"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.MarketingAutomation.Campaign]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.MarketingAutomation.Campaign":{"description":"","type":"object","properties":{"id":{"description":"Unique identifier.","type":"string"},"emailId":{"description":"The unique identifier (id) for this email.","type":"string"},"campaignId":{"description":"The unique identifier (id) for this campaign.","type":"string"},"campaignName":{"description":"The friendly name of the campaign.","type":"string"},"contacts":{"description":"","type":"array","items":{"type":"string"}},"receiverEmail":{"description":"","type":"string"},"senderEmail":{"description":"","type":"string"},"sendDate":{"format":"date-time","description":"","type":"string"},"subject":{"description":"","type":"string"},"url":{"description":"","type":"string"},"jumpUrl":{"description":"","type":"string"},"clicks":{"description":"","type":"boolean"},"clickDate":{"format":"date-time","description":"","type":"string"},"opens":{"description":"","type":"boolean"},"openDate":{"format":"date-time","description":"","type":"string"},"bounced":{"description":"When an email message cannot be delivered to an email address","type":"boolean"},"unsubscribed":{"description":"Cancel from an electronic mailing list.","type":"boolean"},"complained":{"description":"A statement that a situation is unsatisfactory or unacceptable","type":"boolean"},"isPrivate":{"description":"","type":"boolean"},"createDate":{"format":"date-time","description":"","type":"string"},"createUserId":{"description":"","type":"string"},"creatorName":{"description":"","type":"string"},"editDate":{"format":"date-time","description":"","type":"string"},"editUserId":{"description":"","type":"string"},"editorName":{"description":"","type":"string"},"manageUserId":{"description":"","type":"string"},"managerName":{"description":"","type":"string"},"recipientEmail":{"description":"","type":"string"},"typeEnum":{"format":"int32","description":"","type":"integer"}}},"act.web.api.models.MarketingAutomation.MarketingAutomationEmail":{"description":"AMA Emails","required":["emailId","campaignId","campaignName"],"type":"object","properties":{"id":{"description":"Unique identifier.","type":"string"},"emailId":{"description":"The unique identifier (id) for this email.","type":"string"},"campaignId":{"description":"The unique identifier (id) for this campaign.","type":"string"},"campaignName":{"description":"The friendly name of the campaign.","type":"string"},"contacts":{"description":"","type":"array","items":{"type":"string"}},"receiverEmail":{"description":"","type":"string"},"senderEmail":{"description":"","type":"string"},"sendDate":{"format":"date-time","description":"","type":"string"},"subject":{"description":"","type":"string"},"url":{"description":"","type":"string"},"jumpUrl":{"description":"","type":"string"},"clicks":{"description":"","type":"boolean"},"clickDate":{"format":"date-time","description":"","type":"string"},"opens":{"description":"","type":"boolean"},"openDate":{"format":"date-time","description":"","type":"string"},"bounced":{"description":"When an email message cannot be delivered to an email address","type":"boolean"},"unsubscribed":{"description":"Cancel from an electronic mailing list.","type":"boolean"},"complained":{"description":"A statement that a situation is unsatisfactory or unacceptable","type":"boolean"},"isPrivate":{"description":"","type":"boolean"}}},"act.web.api.models.MetaData.Picklists.DropDownList":{"description":"Represents a typed list of custom values in the application database.","type":"object","properties":{"id":{"description":"Gets the unique identifier of the PickList object.","type":"string"},"name":{"description":"Gets or sets the name of the PickList.","type":"string"},"type":{"description":"Gets or sets the name of the PickList.","type":"string"},"isEditable":{"description":"Indicates that the drop-down will allow editing.","type":"boolean"},"isAutoInsert":{"description":"Indicates that the drop-down will allow multiple item selection.","type":"boolean"},"description":{"description":"Gets or sets the description of the PickList.","type":"string"},"created":{"format":"date-time","description":"Gets the creation date of the PickList object.","type":"string"},"edited":{"format":"date-time","description":"Gets the edit date of the PickList object.","type":"string"},"items":{"description":"List of drop-down list items that are associated to this drop-down list.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.MetaData.Picklists.DropDownPickListItem"}}}},"act.web.api.models.MetaData.Picklists.DropDownPickListItem":{"description":"Represents a value item for a PickList object.","type":"object","properties":{"id":{"description":"Gets the unique identifier of the PickListItem object.","type":"string"},"value":{"description":"Gets or sets the value of the PickListItem object.","type":"string"},"description":{"description":"Gets the description of the picklist item.","type":"string"}}},"act.web.api.models.MetaData.Schema.Column":{"description":"","type":"object","properties":{"id":{"description":"","type":"string"},"name":{"description":"","type":"string"},"columnName":{"description":"","type":"string"},"recordType":{"description":"","type":"string"},"aliasName":{"description":"","type":"string"},"columnType":{"description":"","type":"string"},"displayName":{"description":"","type":"string"},"tableName":{"description":"","type":"string"},"type":{"description":"","type":"string"},"dataType":{"description":"","type":"string"},"virtualId":{"description":"","type":"string"},"virtualType":{"description":"","type":"string"},"virtualObject":{"description":"","type":"string"},"virtualField":{"description":"","type":"string"},"length":{"format":"int32","description":"","type":"integer"},"minimumLength":{"format":"int32","description":"","type":"integer"},"precision":{"format":"int32","description":"","type":"integer"},"scale":{"format":"int32","description":"","type":"integer"},"minValue":{"description":"","type":"string"},"maxValue":{"description":"","type":"string"},"defaultValue":{"description":"","type":"string"},"fieldFormat":{"description":"","type":"string"},"formula":{"description":"Gets the database calculated field expression for the column.","type":"string"},"calcDisplay":{"description":"Gets the database calculated field expression for the column.","type":"string"},"isAllowBlank":{"description":"","type":"boolean"},"isCustom":{"description":"","type":"boolean"},"isDefinedField":{"description":"","type":"boolean"},"isDisplayed":{"description":"","type":"boolean"},"isNullable":{"description":"","type":"boolean"},"isPrimary":{"description":"","type":"boolean"},"isProtected":{"description":"","type":"boolean"},"isReadOnly":{"description":"Indicates this field to be readonly","type":"boolean"},"isTracked":{"description":"","type":"boolean"},"isVirtual":{"description":"","type":"boolean"},"createDate":{"format":"date-time","description":"","type":"string"},"editDate":{"format":"date-time","description":"","type":"string"},"changeEvent":{"description":"","type":"string"},"enterEvent":{"description":"","type":"string"},"leaveEvent":{"description":"","type":"string"},"picklist":{"$ref":"#/definitions/act.web.api.models.MetaData.Schema.PickListInfo","description":""}}},"act.web.api.models.MetaData.Schema.PickListInfo":{"description":"","type":"object","properties":{"id":{"description":"","type":"string"},"name":{"description":"","type":"string"},"description":{"description":"","type":"string"},"isLimitToList":{"description":"","type":"boolean"},"isMultiSelect":{"description":"","type":"boolean"},"isTypeAhead":{"description":"","type":"boolean"},"showDescription":{"description":"","type":"boolean"}}},"act.web.api.models.MetaData.TypeCodes.EnumTypes":{"description":"","type":"object","properties":{"name":{"description":"","type":"string"},"value":{"format":"int32","description":"","type":"integer"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.MetaData.Picklists.DropDownList]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.MetaData.Picklists.CreateDropDownList":{"description":"Represents a typed list of custom values in the application database.","required":["name","type"],"type":"object","properties":{"name":{"description":"Gets or sets the name of the PickList.","type":"string"},"type":{"description":"The picklist data type.","enum":["Character","Currency","Number","Decimal"],"type":"string"},"description":{"description":"Gets or sets the description of the PickList.","type":"string"},"isEditable":{"description":"Defines if the picklist is editable.","type":"boolean"},"isAutoInsert":{"description":"Defines if the picklist can create new items.","type":"boolean"},"items":{"description":"Picklist Items","type":"array","items":{"$ref":"#/definitions/act.web.api.models.MetaData.Picklists.DropDownPickListItem"}}}},"act.web.api.models.MetaData.Picklists.PickList":{"description":"Represents a typed list of custom values in the application database.","type":"object","properties":{"id":{"description":"Gets the unique identifier of the PickList object.","type":"string"},"name":{"description":"Gets or sets the name of the PickList.","type":"string"},"recordType":{"description":"","type":"string"},"description":{"description":"Gets or sets the description of the PickList.","type":"string"},"created":{"format":"date-time","description":"Gets the creation date of the PickList object.","type":"string"},"edited":{"format":"date-time","description":"Gets the edit date of the PickList object.","type":"string"},"fields":{"description":"","type":"array","items":{"$ref":"#/definitions/act.web.api.models.MetaData.Picklists.ColumnBindings"}}}},"act.web.api.models.MetaData.Picklists.ColumnBindings":{"description":"","type":"object","properties":{"id":{"description":"","type":"string"},"name":{"description":"","type":"string"},"isLimitToList":{"description":"","type":"boolean"},"isMultiSelect":{"description":"","type":"boolean"},"isTypeAhead":{"description":"","type":"boolean"},"showDescription":{"description":"","type":"boolean"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.MetaData.Picklists.DropDownPickListItem]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.MetaData.Schema.Entity]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.MetaData.Schema.Entity":{"description":"","type":"object","properties":{"id":{"description":"","type":"string"},"name":{"description":"","type":"string"},"displayName":{"description":"","type":"string"},"isCustom":{"description":"","type":"boolean"},"recordType":{"description":"","type":"string"},"parents":{"description":"","type":"string"},"createUserID":{"description":"","type":"string"},"createDate":{"format":"date-time","description":"","type":"string"}}},"act.web.api.models.MetaData.Schema.NewCustomTable":{"description":"Definition for creating a new custom table (custom entity).","required":["name","displayName"],"type":"object","properties":{"name":{"description":"The technical name of the custom table. Becomes the physical table CUST_&lt;NAME&gt; and primary key &lt;NAME&gt;ID\r\n            (normalized to upper case). Letters, digits, and underscores only; must begin with a letter or underscore.\r\n            Maximum 27 characters (the framework prepends a 5-character \"CUST_\" prefix).","maxLength":27,"minLength":0,"pattern":"^[A-Za-z_][A-Za-z0-9_]*$","type":"string"},"displayName":{"description":"The user-facing display name of the custom table (the APC tab label). Stored verbatim. Maximum 32 characters.","maxLength":32,"minLength":0,"pattern":"^.*\\S.*$","type":"string"},"description":{"description":"An optional description of the custom table. Maximum 128 characters.","maxLength":128,"minLength":0,"type":"string"},"isDefineField":{"description":"Indicates whether the custom table is visible in the Define Fields UI.","type":"boolean"},"parentEntities":{"description":"Optional parent entities to link this custom table to: Contacts, Groups, Companies, Opportunities.\r\n            When empty, a standalone top-level custom table is created; otherwise a sub-entity is created with a\r\n            many-to-many junction table to each named parent.","type":"array","items":{"type":"string"}}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.MetaData.Schema.Column]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.MetaData.Schema.NewColumn":{"description":"","required":["name","type"],"type":"object","properties":{"name":{"description":"The database column alias or display name.","type":"string"},"type":{"description":"The Act! field data type.","enum":["YesNo","Character","InitialCaps","Lowercase","Uppercase","Memo","Url","Number","Currency","Decimal","Date","Time","DateTime","AnnualEvent","Picture","Calculated","Email","Phone","Address"],"type":"string"},"length":{"format":"int32","description":"The size of the data type","type":"integer"},"precision":{"format":"int32","description":"Precision is the number of digits in a number","type":"integer"},"scale":{"format":"int32","description":"Scale is the number of digits to the right of the decimal point in a number","type":"integer"},"defaultValue":{"description":"The default value of the field if nothing is provided.","type":"string"},"fieldFormat":{"description":"Defines a specific format for this field.","type":"string"},"isPrimary":{"description":"Primary fields are copied when duplicating the record.","type":"boolean"},"isAllowBlank":{"description":"Indicates that this field will be a required field or not","type":"boolean"},"isTracked":{"description":"Indicates that this field will track changes","type":"boolean"},"changeEvent":{"description":"Sets up a change event trigger.","type":"string"},"enterEvent":{"description":"Sets up a change event trigger.","type":"string"},"leaveEvent":{"description":"Sets up a change event trigger.","type":"string"},"picklist":{"$ref":"#/definitions/act.web.api.models.MetaData.Schema.AssignPicklist","description":"Provides a drop-down list of the items avaiable for this column"},"calculated":{"$ref":"#/definitions/act.web.api.models.MetaData.Schema.FieldBehavior","description":"Calculated Field"}}},"act.web.api.models.MetaData.Schema.AssignPicklist":{"description":"","required":["isLimitToList","isMultiSelect","isTypeAhead","showDescription"],"type":"object","properties":{"id":{"description":"","type":"string"},"name":{"description":"","type":"string"},"isLimitToList":{"description":"","type":"boolean"},"isMultiSelect":{"description":"","type":"boolean"},"isTypeAhead":{"description":"","type":"boolean"},"showDescription":{"description":"","type":"boolean"}}},"act.web.api.models.MetaData.Schema.FieldBehavior":{"description":"","type":"object","properties":{"fieldType":{"description":"The datatype of the fields being used in the calculated field (Currency, Decimal, Number).","enum":["Number","Currency","Decimal"],"type":"string"},"fields":{"description":"Comma delimited list of the entity column names being used in the  formula.","type":"string"},"formula":{"description":"Specify formats or rules for entering data in the field.","type":"string"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.MetaData.Picklists.PickList]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Notes.Note":{"description":"","type":"object","properties":{"id":{"description":"","type":"string"},"recordManager":{"description":"","type":"string"},"recordManagerID":{"description":"","type":"string"},"createUserID":{"description":"","type":"string"},"isPrivate":{"description":"","type":"boolean"},"noteText":{"description":"","type":"string"},"noteTypeID":{"format":"int32","description":"The type of note.\r\n            POST: optional — defaults to 100 (General) if omitted.\r\n            PATCH: optional — existing value preserved if omitted.\r\n            PUT: required — omitting returns 400.","type":"integer"},"displayDate":{"format":"date-time","description":"","type":"string"},"created":{"format":"date-time","description":"","type":"string"},"edited":{"format":"date-time","description":"","type":"string"},"companies":{"description":"List of companies that are associated to this note entity.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Companies.EmbeddedCompany"}},"contacts":{"description":"List of companies that are associated to this note entity.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Contacts.EmbeddedContact"}},"groups":{"description":"List a groups that are associated to this note entity.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Groups.EmbeddedGroup"}},"opportunities":{"description":"List a opportunities that are associated to this note entity.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.EmbeddedOpportunity"}},"attachment":{"$ref":"#/definitions/act.web.api.models.Attachments.Attachment","description":"Gets the attachment referenced by this note."}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Notes.Note]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Opportunities.OpportunityListRequest":{"description":"Assign opportunities request model.","type":"object","properties":{"opportunities":{"description":"List of opportunity identifiers.","type":"array","items":{"type":"string"}}}},"act.web.api.models.Opportunities.OpportunityProduct":{"description":"This class describes a particular product that is associated with an opportunity.","type":"object","properties":{"id":{"description":"A unique identifier (id) for a given opportunity product.","type":"string"},"name":{"description":"The name of the opportunity product.","type":"string"},"cost":{"format":"double","description":"The cost of the opportunity product.","type":"number"},"createDate":{"format":"date-time","description":"The date that the opportunity product was created.","type":"string"},"discount":{"format":"double","description":"The opportunity product's discounted percentage (ignore on updates).","type":"number"},"discountPrice":{"format":"double","description":"The discounted price of the opportunity product.","type":"number"},"editDate":{"format":"date-time","description":"The date that the opportunity product was lasted modified.","type":"string"},"itemNumber":{"description":"A item number assigned to this opportunity product.","type":"string"},"opportunityID":{"description":"A unique identifier (id) for a given opportunity.","type":"string"},"price":{"format":"double","description":"The price of the opportunity product.","type":"number"},"productID":{"description":"A unique identifier (id) for a given product.","type":"string"},"quantity":{"format":"double","description":"The quantity of opportunity products.","type":"number"},"type":{"description":"The quantity of opportunity products.","type":"string"},"total":{"format":"double","description":"The total pricie of the opportunity product (adjusted price * quantity).","type":"number"},"isQuickbooksProduct":{"description":"Define is product linked with Quickbooks Product","type":"boolean"},"customFields":{"type":"object","additionalProperties":{"$ref":"#/definitions/System.Object"}},"created":{"format":"date-time","type":"string"},"edited":{"format":"date-time","type":"string"},"editedBy":{"type":"string"},"recordManager":{"type":"string"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Lookups.OpportunityLookup]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Opportunities.Process]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Opportunities.ProcessRequest":{"description":"The current process for a given opportunity.","type":"object","properties":{"name":{"description":"The name of the process.","type":"string"},"status":{"description":"","enum":["None","Active","Inactive"],"type":"string"},"description":{"description":"The description of the process.","type":"string"},"stages":{"description":"Customized stages for the new process.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.StageInfo"}}}},"act.web.api.models.Opportunities.StageInfo":{"description":"A class describes the stage of a particular {act.web.api.models.Opportunities.Opportunity} object.","type":"object","properties":{"name":{"description":"The name of the stage.","type":"string"},"description":{"description":"The description of the stage.","type":"string"},"probability":{"format":"int32","description":"The probability of the stage.","type":"integer"},"number":{"format":"int32","description":"The order of the stage progresses throw the process lifecycle.","type":"integer"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Opportunities.OpportunityProduct]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Opportunities.Stage]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Users.Preference":{"description":"User preferences.","type":"object","properties":{"id":{"description":"A base64 representation of the unique identifier (name).","type":"string"},"name":{"description":"A unique identifier (key) for this preference.","type":"string"},"value":{"$ref":"#/definitions/System.Object","description":"The preference setting."},"isAdmin":{"description":"","type":"boolean"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Users.Preference]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Preferences.SalutationNamePreferences":{"description":"","type":"object","properties":{"nameAffixSettings":{"description":"List of affix types and values.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Preferences.NameAffixSetting"}},"salutationSettings":{"description":"List of salutation types.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Preferences.SalutationSetting"}},"autoShowDialog":{"description":"","type":"boolean"}}},"act.web.api.models.Preferences.NameAffixSetting":{"description":"","type":"object","properties":{"id":{"description":"Affix type identifier.","type":"string"},"name":{"description":"Affix typ name.","type":"string"},"items":{"description":"List of affix values.","type":"array","items":{"type":"string"}}}},"act.web.api.models.Preferences.SalutationSetting":{"description":"Salutation type  input model.","type":"object","properties":{"code":{"type":"string"},"value":{"type":"boolean"}}},"act.web.api.models.Preferences.TaskPreferences":{"description":"Activity preferences model.","type":"object","properties":{"clearingTasks":{"description":"When clearing tasks.","enum":["Grey","Strikeout"],"type":"string"},"taskConflictChecking":{"description":"Activity conflict checking.","type":"boolean"},"makeNewTaskPublic":{"description":"Make new activity public.","type":"boolean"},"schedulingSeparateTasks":{"description":"Schedule separate activities.","type":"boolean"},"scheduleTaskForNewContact":{"description":"Prompt to schedule an task for new contact.","type":"boolean"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Preferences.CalendarColorPalette]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Preferences.CalendarColorPalette":{"description":"","type":"object","properties":{"name":{"description":"","enum":["Green","Orange","Purple","Plum","Blue","Yellow","Raspberry","Emerald","DarkBlue","Grape"],"type":"string"},"hex":{"description":"","type":"string"},"rgb":{"description":"Stands for \"Red Green Blue.\" RGB refers to three hues of light that can be mixed together to create different colors.","type":"string"},"cmyk":{"description":"Stands for \"Cyan Magenta Yellow Black.\" These are the four basic colors used for printing color images.","type":"string"},"hsv":{"description":"HSV (hue, saturation, value).","type":"string"},"hsl":{"description":"HSL (hue, saturation, lighting).","type":"string"}}},"act.web.api.models.Preferences.DuplicatesField":{"description":"Allowed for index field info.","type":"object","properties":{"columnName":{"description":"Field column name","type":"string"},"displayName":{"description":"Field display name","type":"string"}}},"act.web.api.models.Preferences.DuplicatesPreferences":{"description":"Dup-checking preferences","type":"object","properties":{"fields":{"description":"List of selected indexes","type":"string"}}},"act.web.api.models.Products.Product":{"description":"This class describes a particular product.","type":"object","properties":{"id":{"description":"A unique identifier (id) for a given product.","type":"string"},"name":{"description":"The name of the product.","type":"string"},"cost":{"format":"double","description":"The cost of the product.","type":"number"},"createDate":{"format":"date-time","description":"The date that the product was created.","type":"string"},"editDate":{"format":"date-time","description":"The date that the opportunity product was lasted modified.","type":"string"},"itemNumber":{"description":"A item number assigned to this opportunity product.","type":"string"},"price":{"format":"double","description":"The price of the opportunity product.","type":"number"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Products.Product]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.SupplementalFiles.Layout]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.SupplementalFiles.Layout":{"description":"","type":"object","properties":{"entity":{"description":"The record type is the entity (Company, Contact, Group, Opportunity) that the layout definition represents.","enum":["Contact","Company","Group","Opportunity","Product"],"type":"string"},"fileName":{"description":"The name of the layout file.","type":"string"},"isDefault":{"description":"The default layout.","type":"boolean"},"lastEdit":{"format":"date-time","description":"The date and time of the last modification.","type":"string"}}},"act.web.api.models.SyncData.ActivitySyncInfo":{"description":"Activty sync info","type":"object","properties":{"activityId":{"description":"Activity identifier.","type":"string"},"externalId":{"description":"External id","type":"string"},"calendarUid":{"description":"Calendar Uid","type":"string"}}},"act.web.api.models.Database.Currency":{"description":"","type":"object","properties":{"symbol":{"description":"","type":"string"},"description":{"description":"","type":"string"},"country":{"description":"","type":"string"},"code":{"description":"","type":"string"},"displayText":{"description":"","type":"string"},"decimalDigits":{"format":"int32","description":"","type":"integer"},"decimalSeparator":{"description":"","type":"string"},"groupSeparator":{"description":"","type":"string"},"negativeSign":{"description":"","type":"string"},"percentSymbol":{"description":"","type":"string"}}},"act.web.api.models.Utilities.LicenseInfo":{"description":"Registered license information","type":"object","properties":{"serialNumber":{"description":"The registered Act! license serial number","type":"string"},"type":{"description":"The licensing option selected for this serial number (Subscription or Perpetual)","type":"string"},"userLicenses":{"format":"int32","description":"The number of user seats available for this serial number","type":"integer"}}},"act.web.api.models.Utilities.SystemInfo":{"description":"Provides system information about the API","type":"object","properties":{"apiVersion":{"description":"The API version.","type":"string"},"sdkVersion":{"description":"The Act! SDK version.","type":"string"},"update":{"format":"int32","description":"The Act! Update version.","type":"integer"},"culture":{"$ref":"#/definitions/act.web.api.models.Utilities.Culture","description":"Provides information about the current culture."}}},"act.web.api.models.Utilities.Culture":{"description":"Provides information about the current culture.","type":"object","properties":{"displayName":{"description":"Gets the full localized culture name.","type":"string"},"name":{"description":"Gets the culture name in the format languagecode2-country/regioncode2.","type":"string"},"nativeName":{"description":"Gets the culture name, consisting of the language, the country/region, and the optional script, that the culture is set to display.","type":"string"},"threeLetterISOLanguageName":{"description":"Gets the ISO 639-2 three-letter code for the language of the current System.Globalization.CultureInfo.","type":"string"},"twoLetterISOLanguageName":{"description":"Gets the ISO 639-1 two-letter code for the language of the current System.Globalization.CultureInfo.","type":"string"},"dateTimeFormat":{"$ref":"#/definitions/act.web.api.models.Utilities.DateFormat","description":"The Culture"}}},"act.web.api.models.Utilities.DateFormat":{"description":"","type":"object","properties":{"fullDateTimePattern":{"description":"Gets the custom format string for a long date and long time value.","type":"string"},"longDatePattern":{"description":"Gets the custom format string for a long date value.","type":"string"},"longTimePattern":{"description":"Gets the custom format string for a long time value.","type":"string"},"shortDatePattern":{"description":"Gets the custom format string for a short date value.","type":"string"},"shortTimePattern":{"description":"Gets the custom format string for a short time value.","type":"string"},"sortableDateTimePattern":{"description":"Gets the custom format string for a sortable date and time value.","type":"string"}}},"act.web.api.models.Activities.ActivityOccurrence":{"description":"","type":"object","properties":{"id":{"description":"A unique identifier that represents the activity.","type":"string"},"isCleared":{"description":"Indicates that the activity has been cleared.","type":"boolean"},"isAlarmCleared":{"description":"","type":"boolean"},"isAlarmed":{"description":"Turns on/off an alarm for this activity.","type":"boolean"},"leadMinutes":{"format":"int32","description":"Indicates the number of minutes the alarm will sounds before an activity is scheduled to start.","type":"integer"},"alarmDue":{"description":"","type":"string"},"seriesID":{"description":"A unique identifier that represents the activity.  The id that is returned is based on if it is a recurring or not.\r\n            Recurrent activity: RecurSourceActivityId or Single Occurence activity: ActivityID","type":"string","readOnly":true},"originalTime":{"format":"date-time","description":"Gets the date and time for which this activity was originally scheduled.","type":"string"},"startTime":{"format":"date-time","description":"The time the activity is to begin","type":"string"},"endTime":{"format":"date-time","description":"The time the activity is to end","type":"string"},"duration":{"description":"The difference between the start time and end time of the {act.web.api.models.Activities.ActivityOccurrence}.","type":"string"},"externalId":{"description":"Provides a unique identifier to an external system.","type":"string"},"calendarUid":{"description":"Provides a unique calendar uid, common for all invited users.","type":"string"},"accessorId":{"description":"The unique id of the activity accessor who's view of the this.","type":"string"},"location":{"description":"Describes the physical location that the activity is to take place.","type":"string"},"isTimeless":{"description":"Indicates whether a specifies action is to be completed at a specific time-of-day.","type":"boolean"},"isAllDay":{"description":"Indicates whether a specified activity takes up entire day.","type":"boolean"},"isPrivate":{"description":"Indicates elevated security that only the creator/owner has access to this activity.","type":"boolean"},"isRecurring":{"description":"True: if activity is recurring, otherwise false.","type":"boolean","readOnly":true},"activityPriorityId":{"format":"int32","description":"Displays the type of the activity.","type":"integer"},"activityPriorityName":{"description":"Displays the priority of the activity.","type":"string"},"activityTypeId":{"format":"int32","description":"Displays the type of the activity.","type":"integer"},"activityTypeName":{"description":"Displays the type of the activity.","type":"string"},"attachment":{"$ref":"#/definitions/act.web.api.models.Attachments.Attachment","description":"Gets the attachment referenced by this note."},"bannerColor":{"description":"The banner color.","type":"string"},"details":{"description":"Additional detailed information about the activity.","type":"string"},"subject":{"description":"A description of the action to be completed.","type":"string"},"recurSpec":{"$ref":"#/definitions/act.web.api.models.Activities.RecurSpec","description":"The recurrence pattern for the activity."},"created":{"format":"date-time","description":"The date and time the activity was created.","type":"string"},"edited":{"format":"date-time","description":"The date and time the activity was last updated.","type":"string"},"scheduledById":{"description":"The id of the activity's organizer.","type":"string"},"scheduledBy":{"description":"The contact who created this activity.","type":"string"},"scheduledForId":{"description":"The id of the activity's organizer.","type":"string"},"scheduledFor":{"description":"The name of the activity's organizer.","type":"string"},"scheduledWithCompany":{"description":"Company name of the contact with whom this activity was scheduled. If more than one contact, first encountered","type":"string"},"scheduledWithEmail":{"description":"Business Email address of the contact with whom this activity was scheduled. If more than one contact, first encountered is used","type":"string"},"scheduledWithPhone":{"description":"Phone number of the contact with whom this activity was scheduled. If more than one contact, first encountered is used","type":"string"},"scheduledWithPhoneExt":{"description":"Phone number extension of the contact with whom this activity was scheduled. If more than one contact, first encountered is used","type":"string"},"companies":{"description":"List of companies that are associated to this activity.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Companies.EmbeddedCompany"}},"contacts":{"description":"The attendees scheduled for the activity.  Note: at least one contact is required.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Activities.EmbededActivityContact"}},"groups":{"description":"List a groups that are associated to this activity.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Groups.EmbeddedGroup"}},"opportunities":{"description":"List a opportunities that are associated to this activity.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Opportunities.EmbeddedOpportunity"}}}},"act.web.api.models.Tasks.TaskClearRequest":{"description":"Creates a history when clearing an activity","type":"object","properties":{"result":{"$ref":"#/definitions/act.web.api.models.Tasks.ClearResultType","description":""},"history":{"$ref":"#/definitions/act.web.api.models.Tasks.ClearTaskHistory","description":""}}},"act.web.api.models.Tasks.ClearResultType":{"description":"","type":"object","properties":{"id":{"format":"int32","description":"This unique identifier (HistoryTypeId) for a given history type.","type":"integer"},"name":{"description":"This defines the type of history event at which it will be known.","type":"string"}}},"act.web.api.models.Tasks.ClearTaskHistory":{"description":"Creates a history when clearing an activity","type":"object","properties":{"startTime":{"format":"date-time","description":"The time the activity is to begin.","type":"string"},"endTime":{"format":"date-time","description":"The time the activity is to end.","type":"string"},"includeDetailsToHistory":{"description":"Indicates that shared history includes details.","type":"boolean"},"details":{"description":"Additional detailed information about the activity.","type":"string"},"subject":{"description":"A description of the action to be completed.","type":"string"},"isPrivate":{"description":"Indicates elevated security that only the creator/owner has access to this activity.","type":"boolean"}}},"act.web.api.models.Activities.ClearActivity":{"description":"Creates a history when clearing an activity","required":["startTime","endTime"],"type":"object","properties":{"historyType":{"$ref":"#/definitions/act.web.api.models.Histories.HistoryType","description":"Provides information about the history event."},"startTime":{"format":"date-time","description":"The time the activity is to begin.","type":"string"},"endTime":{"format":"date-time","description":"The time the activity is to end.","type":"string"},"includeDetailsToHistory":{"description":"Indicates that shared history includes details.","type":"boolean"},"details":{"description":"Additional detailed information about the activity.","type":"string"},"subject":{"description":"A description of the action to be completed.","type":"string"},"isPrivate":{"description":"Indicates elevated security that only the creator/owner has access to this activity.","type":"boolean"},"attachment":{"$ref":"#/definitions/act.web.api.models.Attachments.Attachment","description":"Gets the attachment referenced by this note."}}},"act.web.api.models.Tasks.TaskListRequest":{"description":"Creates a history when clearing an activity","type":"object","properties":{"tasks":{"description":"List of tasks identifiers.","type":"array","items":{"type":"string"}}}},"act.web.api.models.Tasks.TaskListClearRequest":{"description":"Creates a history when clearing an activity","type":"object","properties":{"result":{"$ref":"#/definitions/act.web.api.models.Tasks.ClearResultType","description":""},"history":{"$ref":"#/definitions/act.web.api.models.Tasks.ClearTaskHistory","description":""},"tasks":{"description":"List of tasks identifiers.","type":"array","items":{"type":"string"}}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Activities.ActivityOccurrence]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Activities.ActivityPriority]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Activities.ActivityPriority":{"description":"","type":"object","properties":{"id":{"format":"int32","description":"Gets the unique identifier","type":"integer"},"name":{"description":"Gets the textual name.","type":"string"},"description":{"description":"Gets brief description of this activity priority.","type":"string"},"isActive":{"description":"Indicates that the priority is active.","type":"boolean"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Activities.AlarmedActivity]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Activities.AlarmedActivity":{"description":"Represents an activity with an active alarm.","type":"object","properties":{"id":{"description":"A composite identifier combining the activity ID and occurrence date (activityId + MMddyyyy).","type":"string"},"activityID":{"description":"The unique identifier of the underlying activity.","type":"string"},"accessorId":{"description":"The unique identifier of the accessor-specific activity instance.","type":"string"},"subject":{"description":"A description of the action to be completed.","type":"string"},"activityTypeId":{"format":"int32","description":"The activity type identifier.","type":"integer"},"activityTypeName":{"description":"The activity type name (e.g. Call, Meeting, To-do).","type":"string"},"bannerColor":{"description":"The banner color associated with the activity type.","type":"string"},"startTime":{"format":"date-time","description":"The activity occurrence time in the server's local timezone.","type":"string"},"alarmTime":{"format":"date-time","description":"The local time at which the alarm is due to fire.","type":"string"},"edited":{"format":"date-time","description":"The last time the activity was updated.","type":"string"},"isRecurring":{"description":"True if activity is recurring, otherwise false.","type":"boolean"},"activityPriorityId":{"format":"int32","description":"The activity priority identifier.","type":"integer"},"isTimeless":{"description":"Indicates whether this activity has no specific time (all-day).","type":"boolean"},"isUnreadSnooze":{"description":"Indicates whether there is an active snooze that has not yet been acknowledged.","type":"boolean"},"canEdit":{"description":"Indicates whether the current user can edit this activity.","type":"boolean"},"canGoTo":{"description":"Indicates whether the current user can navigate to the activity's associated contacts.","type":"boolean"},"companies":{"description":"Display names of companies associated with this activity.","type":"array","items":{"type":"string"}},"contacts":{"description":"Display names of relevant contacts associated with this activity.","type":"array","items":{"type":"string"}}}},"act.web.api.models.Activities.AlarmedActivityChanges":{"description":"Represents the result of a poll for alarm updates: activities whose alarm state\r\n            has changed since the client last checked.","type":"object","properties":{"deletedIds":{"description":"Activity IDs from the client's tracked set that are no longer alarmed\r\n            (cleared, snoozed past expiry, or deleted).","type":"array","items":{"type":"string"}},"alarms":{"description":"The current state of alarmed activities matching the requested IDs.","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Activities.AlarmedActivity"}}}},"act.web.api.models.Tasks.SnoozeAlarmsRequest":{"description":"Request model for snoozing one or more activity alarms.","type":"object","properties":{"activityIds":{"description":"The ActivityID values of the activities whose alarms should be snoozed.\r\n            Corresponds to the ActivityID field returned by the alarm endpoints.","type":"array","items":{"type":"string"}},"snoozeMinutes":{"format":"int32","description":"The number of minutes to snooze the alarms for.","type":"integer"}}},"act.web.api.models.Tasks.AlarmRequest":{"description":"Request model for alarm operations that act on one or more activities.","type":"object","properties":{"activityIds":{"description":"The ActivityID values of the activities to act on.\r\n            Corresponds to the ActivityID field returned by the alarm endpoints.","type":"array","items":{"type":"string"}}}},"act.web.api.models.Tasks.ClearAlarmsRequest":{"description":"Request model for the bulk clear-alarms operation.","type":"object","properties":{"ids":{"description":"IDs of the alarms to clear. Accepts either the 44-character composite format\r\n            (activityId + MMddyyyy, as returned by the alarms endpoint) or a plain 36-character\r\n            GUID (activityId only). When a GUID-only ID is provided, all occurrences of that\r\n            activity within the configured search range are cleared.","type":"array","items":{"type":"string"}}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.TaskTypes.TaskType]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.TaskTypes.TaskType":{"description":"","type":"object","properties":{"id":{"format":"int32","description":"","type":"integer"},"name":{"description":"","type":"string"},"description":{"description":"","type":"string"},"isActive":{"description":"","type":"boolean"},"isCustom":{"description":"","type":"boolean"},"isDeletable":{"description":"Indicate that the task type can be deleted.","type":"boolean"},"taskTypeGuid":{"description":"","type":"string"},"historyTypes":{"description":"","type":"array","items":{"$ref":"#/definitions/act.web.api.models.TaskTypes.TaskTypesHistoryType"}},"defaultPreferences":{"$ref":"#/definitions/act.web.api.models.Preferences.TaskDefaultPreferences","description":""}}},"act.web.api.models.TaskTypes.TaskTypesHistoryType":{"description":"","type":"object","properties":{"id":{"format":"int32","description":"","type":"integer"},"name":{"description":"Gets the name of this history type.","type":"string"},"description":{"description":"Gets brief description of this history type.","type":"string"},"clearType":{"description":"","enum":["OTHER","COMPLETED","NOTCOMPLETED","ERASED"],"type":"string"},"isDefault":{"description":"Indicates that this history type is default.","type":"boolean"}}},"act.web.api.models.Preferences.TaskDefaultPreferences":{"description":"","type":"object","properties":{"priority":{"format":"int32","description":"Tasks type priority.","type":"integer"},"reminder":{"format":"int32","description":"The number of minutes before the tasks starts.","type":"integer"},"duration":{"format":"int32","description":"The number of minutes which the task with exists or lasts.","type":"integer"},"isAllDayEvent":{"description":"All day event.","type":"boolean"},"autoRollover":{"description":"Allow auto roll over to today.","type":"boolean"},"color":{"description":"Calendar hex color for a given task type [Green = #00b19e, Orange = #fe5000, Purple = #566bee, Plum = #9d04b8, Blue = #03b3ff, Yellow = #e5cd48, Raspberry = #be2951, Emerald = #26906f, DarkBlue = #008cc5, Grape = #263690] | <b>GET: api/preferences/task-types/color-palette</b>.","type":"string"},"taskDropDownFields":{"description":"","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Preferences.TaskTypeDropDownFieldPreferences"}}}},"act.web.api.models.Preferences.TaskTypeDropDownFieldPreferences":{"description":"Describe activity type fields preferences.","type":"object","properties":{"code":{"description":"Field type.","type":"string"},"value":{"description":"Display drop-down to this field.","type":"boolean"}}},"act.web.api.models.Users.UserInfo":{"description":"","type":"object","properties":{"id":{"description":"","type":"string"},"username":{"description":"","type":"string"},"role":{"description":"","type":"string"},"displayName":{"description":"","type":"string"},"email":{"description":"","type":"string"},"firstName":{"description":"","type":"string"},"lastLogOnDate":{"format":"date-time","description":"","type":"string"},"lastName":{"description":"","type":"string"},"status":{"description":"","type":"string"}}},"act.web.api.models.Teams.Team":{"description":"","type":"object","properties":{"id":{"description":"","type":"string"},"name":{"description":"","type":"string"},"description":{"description":"","type":"string"},"roster":{"description":"","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Users.UserInfo"}}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Teams.Team]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Teams.TeamRoster":{"description":"","type":"object","properties":{"users":{"description":"","type":"array","items":{"type":"string"}}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Users.UserInfo]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Users.NewUser":{"description":"Create a new user account","type":"object","properties":{"username":{"description":"A unique login id","type":"string"},"password":{"description":"The password used to login","type":"string"},"firstName":{"description":"Represents the first name of a contact name.","type":"string"},"middleName":{"description":"Represents the middle name of a contact name.","type":"string"},"lastName":{"description":"Represents the last name of a contact name.","type":"string"},"namePrefix":{"description":"Represents the first name prefix of a contact name.","type":"string"},"nameSuffix":{"description":"Represents the suffix of a contact name.","type":"string"},"fullName":{"description":"The first name, any middle names, and surname of a contact.  This may also include name prefixes and sufixes that are defined within Act!","type":"string"},"salutation":{"description":"Represents the salutation of the contact name","type":"string"},"roleName":{"description":"","type":"string"},"status":{"description":"","enum":["Active","Inactive","Deleted"],"type":"string"},"mustChangePassword":{"description":"","type":"boolean"},"canChangePassword":{"description":"","type":"boolean"},"passwordExpires":{"description":"","type":"boolean"},"permissions":{"description":"","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Users.Permission"}}}},"act.web.api.models.Users.Permission":{"description":"","type":"object","properties":{"id":{"description":"The unique identitifer for a permission","type":"string"},"alias":{"description":"The display name of a feature.","type":"string"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Users.Accessor]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Users.Permission]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Users.Feature":{"description":"","type":"object","properties":{"id":{"description":"A unique identifier for the user's permission.","type":"string"},"name":{"description":"The static name of a feature (for lookup purposes).","type":"string"},"alias":{"description":"The display name of a feature.","type":"string"},"description":{"description":"The display description of a feature.","type":"string"},"isAllowed":{"description":"Indicates whether the feature is currently allowed.","type":"boolean"},"type":{"description":"Gets or sets the feature type of the feature.","enum":["CreateEdit","DeleteMy","DeleteOther","ManagerOther","Other"],"type":"string"},"category":{"$ref":"#/definitions/act.web.api.models.Users.FeatureSet","description":"The feature set of which this feature is a part."}}},"act.web.api.models.Users.FeatureSet":{"description":"","type":"object","properties":{"id":{"description":"A unique identifier for the featureSet.","type":"string"},"name":{"description":"The static name of a featureSet (for lookup purposes).","type":"string"},"alias":{"description":"The display name of a featureSet.","type":"string"},"description":{"description":"The display description of a featureSet.","type":"string"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.Users.Feature]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}},"act.web.api.models.Users.ConvertContact":{"description":"Create a new user account","type":"object","properties":{"username":{"description":"A unique login id","type":"string"},"password":{"description":"The password used to login","type":"string"},"roleName":{"description":"","type":"string"},"status":{"description":"","enum":["Active","Inactive","Deleted"],"type":"string"},"mustChangePassword":{"description":"","type":"boolean"},"canChangePassword":{"description":"","type":"boolean"},"passwordExpires":{"description":"","type":"boolean"},"permissions":{"description":"","type":"array","items":{"$ref":"#/definitions/act.web.api.models.Users.Permission"}}}},"act.web.api.models.WebHooks.RegistrationViewModel":{"description":"Provides information about the registered webhook.","type":"object","properties":{"id":{"description":"The unique identifier (id) for this webhook.","type":"string"},"name":{"description":"Gets the name of the webhook.","type":"string","readOnly":true},"monitor":{"description":"The entity that the webhook will monitor and raise events for.","enum":["Activities","Companies","Contacts","Fields","Groups","History","Opportunities","Products","Custom"],"type":"string"},"triggerEvent":{"description":"The action that will trigger the webhook.","enum":["Alarms","Created","Updated"],"type":"string"},"monitorName":{"description":"The entity name that the webhook will monitor and raise events for.","type":"string"},"queryOption":{"description":"This defines a composite OData query options that can be used to perform query composition. Currently this only supports $filter, $orderby, $top, $skip, and $count","type":"string"},"userId":{"description":"The unique identifier (id) for the user that this webhooks is registered.","type":"string"},"username":{"description":"The username that this webhook will broadcast triggered events.","type":"string"},"database":{"description":"The database name where the webhook is monitoring for activity.","type":"string"},"server":{"description":"The database server name where the webhook is monitoring for activity.","type":"string"},"authority":{"description":"The address of the authentication server issuing the token.","type":"string"},"resourceUrl":{"description":"The resource URL that the webhook will monitor.","type":"string"},"callbackUrl":{"description":"The callback url that the webhook will send the response.","type":"string"},"callbackId":{"description":"Client defined unique identifier (id) for this webhook.","type":"string"},"created":{"format":"date-time","description":"The date that the webhook was created.","type":"string"},"edited":{"format":"date-time","description":"The date that the webhook was modified.","type":"string"},"suspended":{"format":"date-time","description":"The date that the webhook was suspended.","type":"string"},"failedAttempts":{"format":"int32","description":"The number of failed attempts that has occured.","type":"integer"},"failedRestarts":{"format":"int32","description":"The number of failed restarts that have occured after registration has been suspended.","type":"integer"},"lastNotificationSent":{"format":"date-time","description":"The date of the last notification sent.","type":"string"},"description":{"description":"A brief description of why this webhook is being created.","type":"string"}}},"act.web.api.models.WebHooks.WebhookRequest":{"description":"WebhookRequest URL parameters","type":"object","properties":{"monitor":{"description":"The entity the webhook will monitor.","enum":["Activities","Companies","Contacts","Fields","Groups","History","Opportunities","Products","Custom"],"type":"string"},"triggerEvent":{"description":"WebhookRequest action on the monitored table.","enum":["Alarms","Created","Updated"],"type":"string"},"monitorName":{"description":"The entity name the webhook will monitor (only need to set for custom tables.","type":"string"},"queryOption":{"description":"This defines a composite OData query options that can be used to perform query composition. Currently this only supports $filter, $orderby, $top, $skip, and $count","type":"string"},"callbackUrl":{"description":"The callback url that the webhook will send the response.","type":"string"},"callbackId":{"description":"Client defined unique identifier (id) for this webhook.","type":"string"},"callbackToken":{"description":"The callback client secret.","type":"string"},"certHashString":{"description":"The SHA1 hash value for the X.509v3 certificate as a hexadecimal string to verify https calls to callback URL.","type":"string"},"description":{"description":"A brief description of why this webhook is being created.","type":"string"}}},"Microsoft.AspNet.OData.Query.ODataQueryOptions[act.web.api.models.WebHooks.RegistrationViewModel]":{"type":"object","properties":{"ifMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"ifNoneMatch":{"$ref":"#/definitions/System.Object","readOnly":true},"request":{"$ref":"#/definitions/System.Object","readOnly":true},"context":{"$ref":"#/definitions/Microsoft.AspNet.OData.ODataQueryContext","readOnly":true},"rawValues":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ODataRawQueryOptions","readOnly":true},"selectExpand":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SelectExpandQueryOption","readOnly":true},"apply":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.ApplyQueryOption","readOnly":true},"filter":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.FilterQueryOption","readOnly":true},"orderBy":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.OrderByQueryOption","readOnly":true},"skip":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.SkipQueryOption","readOnly":true},"top":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.TopQueryOption","readOnly":true},"count":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.CountQueryOption","readOnly":true},"validator":{"$ref":"#/definitions/Microsoft.AspNet.OData.Query.Validators.ODataQueryValidator"}}}}}