{"openapi":"3.1.0","info":{"title":"Keap API","description":"Keap Public API Documentation","termsOfService":"https://www.thryv.com/terms-of-use","contact":{"name":"Keap","url":"https://developer.keap.com/get-support","email":"api.keap@thryv.com"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"},"version":"v1"},"servers":[{"url":"https://api.infusionsoft.com/crm"}],"security":[{"oauth2":[]}],"tags":[{"name":"REST Hooks","description":"### _What are REST Hooks?_\n\n_REST Hooks itself is not a specification, it is a collection of patterns that treat webhooks like subscriptions. These subscriptions are manipulated via a REST API just like any other resource._\n\n_With most modern REST APIs, polling is the only way to detect changes. But it doesn't have to be. On average, 98.5% of polls are wasted. There is a better way. REST Hooks enable real-time communication and eliminate polling._ -- [RESTHooks.org](http://RESTHooks.org)\n\nInfusionsoft offers a growing set of REST Hooks to keep you notified of changes in your data. To get started, use [List Hook Event Types](#!/REST_Hooks/list_hook_event_types) to discover event types. Event types are identified using _noun.verb dot syntax_, e.g.: `contact.add` or `invoice.delete`.\n\nAfter you’ve read this documentation, you might be interested in the [REST Hook Event and Retry policies](https://developer.infusionsoft.com/rest-hook-documentation/).\n\nNB: REST Hooks are **not** triggered by legacy action sets.\n\nOnce you've chosen the events you're interested in, subscribe to them via [Create a Hook Subscription](#!/REST_Hooks/create_a_hook_subscription)."},{"name":"Task","description":"Tasks-Endpoint"},{"name":"Contact","description":"Contacts-Endpoint"},{"name":"Email","description":"Emails-Endpoint"},{"name":"Users","description":"Users-Endpoint"},{"name":"Campaign","description":"Campaigns-Endpoint"},{"name":"E-Commerce","description":"E-Commerce-Endpoint"},{"name":"Company","description":"Companies-Endpoint"},{"name":"Note","description":"Notes-Endpoint"},{"name":"Merchant","description":"Merchant-Endpoint"},{"name":"Appointment","description":"Access Appointment objects stored in Keap Max Classic.  Appointment objects stored in Keap Pro or Keap Max are not available via these methods."},{"name":"Contact","description":"Contact-Tag-Endpoint"},{"name":"Setting","description":"Setting-Endpoint"},{"name":"Opportunity","description":"Opportunities-Endpoint"},{"name":"File","description":"File-Endpoint"},{"name":"Affiliate","description":"Affiliates-Endpoint"},{"name":"Product","description":"Products-Endpoint"},{"name":"Locale","description":"Locale-Endpoint"},{"name":"Email Address","description":"Email-Addresses-Endpoint"},{"name":"Tags","description":"Tag-Contact-Endpoint"},{"name":"Account Info","description":"Account Info-Endpoint"},{"name":"Tags","description":"Tag-Company-Endpoint"}],"paths":{"/rest/v1/tasks/{taskId}":{"get":{"tags":["Task"],"summary":"Retrieve a Task","description":"Retrieves a single task","operationId":"getTask","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}}}},"put":{"tags":["Task"],"summary":"Replace a Task","description":"Replaces a task with the values provided in the request. \nThis endpoint does not currently support updating Custom Field values.","operationId":"updateTask","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}}}},"delete":{"tags":["Task"],"summary":"Delete a Task","description":"Permanently deletes a task","operationId":"deleteTask","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"204":{"description":"No Content"}}},"patch":{"tags":["Task"],"summary":"Update a Task","description":"Updates a task with only the values provided in the request. \nThis endpoint does not currently support updating Custom Field values.","operationId":"updatePropertiesOnTask","parameters":[{"name":"taskId","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}}}}},"/rest/v1/orders/{orderId}/paymentPlan":{"put":{"tags":["E-Commerce"],"summary":"Replace an Order Pay Plan","description":"Replaces the order's payment plan with the given values.","operationId":"replacePaymentPlan","parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestPaymentPlan"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestPaymentPlan"}}}}}}},"/rest/v1/opportunities":{"get":{"tags":["Opportunity"],"summary":"List Opportunities","description":"Retrieves a list of all opportunities.\n\nPlease note: the sample response erroneously shows properties, such as _stage reasons_, that are unavailable through the list endpoint. Such properties are only available through the retrieve operation. Future versions of the Opportunity resource will correct the oversight.","operationId":"listOpportunities","parameters":[{"name":"searchCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OpportunitySearchCommand"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpportunityList"}}}}}},"put":{"tags":["Opportunity"],"summary":"Replace an Opportunity","description":"Replaces all values of a given opportunity","operationId":"updateOpportunity","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOpportunityRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Opportunity"}}}}}},"post":{"tags":["Opportunity"],"summary":"Create an Opportunity","description":"Creates a new opportunity as the authenticated user.","operationId":"createOpportunity","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOpportunityRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Opportunity"}}}}}}},"/rest/v1/notes/{noteId}":{"get":{"tags":["Note"],"summary":"Retrieve a Note","description":"Retrieves a single note","operationId":"getNote","parameters":[{"name":"noteId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}}}}},"put":{"tags":["Note"],"summary":"Replace a Note","description":"Replaces all values of a given note","operationId":"updateNote","parameters":[],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestNote"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}}}}},"delete":{"tags":["Note"],"summary":"Delete a Note","description":"Deletes a note","operationId":"deleteNote","parameters":[{"name":"noteId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"204":{"description":"No Content"}}},"patch":{"tags":["Note"],"summary":"Update a Note","description":"Updates a note with only the values provided in the request","operationId":"updatePropertiesOnNote","parameters":[{"name":"noteId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateNote"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}}}}}},"/rest/v1/hooks/{key}":{"get":{"tags":["REST Hooks"],"summary":"Retrieve a Hook Subscription","description":"Retrieves an existing hook subscription and its status.\n\nIf your hook subscription becomes inactive, you may request an activation attempt via [Verify a Hook Subscription](#!/REST_Hooks/verify_a_hook_subscription).","operationId":"retrieve_a_hook_subscription","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestHook"}}}}}},"put":{"tags":["REST Hooks"],"summary":"Update a Hook Subscription","description":"Modify an existing hook subscription using the provided values.","operationId":"update_a_hook_subscription","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestHookRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestHook"}}}}}},"delete":{"tags":["REST Hooks"],"summary":"Delete a Hook Subscription","description":"Stop receiving hooks by deleting an existing hook subscription.","operationId":"delete_a_hook_subscription","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"204":{"description":"No Content"}}}},"/rest/v1/files/{fileId}":{"get":{"tags":["File"],"summary":"Retrieve File","description":"Retrieves metadata about a specific file. Optionally returns the base64 encoded file data.\n\n**Note:** Files larger than 8MB may cause errors when retrieved via the v1 API due to Base64 encoding overhead. For files approaching or exceeding this size, use the [v2 Files endpoint](https://developer.infusionsoft.com/docs/restv2/#tag/Files/operation/getFileDataUsingGET), which returns file data as byte arrays without encoding limitations.","operationId":"getFile","parameters":[{"name":"fileId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"optional_properties","in":"query","description":"Comma-delimited list of File properties to include in the response. (Some fields such as `file_data` aren't included, by default.)","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileInformation"}}}}}},"put":{"tags":["File"],"summary":"Replace File","description":"Upload a base64 encoded file to replace an existing one. `contact_id` is required only when `file_association` is `CONTACT`.","operationId":"updateFile","parameters":[{"name":"fileId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUpload"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileInformation"}}}}}},"delete":{"tags":["File"],"summary":"Delete File","description":"Deletes the specified file","operationId":"deleteFile","parameters":[{"name":"fileId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"204":{"description":"No Content"}}}},"/rest/v1/emailAddresses/{email}":{"put":{"tags":["Email Address"],"summary":"Replace an Email Address","description":"Replaces all of the values of a given email address\n\nYou may opt-in or mark an email address as _Marketable_ by including the following field in the request JSON with an opt-in reason. (This field is also shown in the complete request body sample.) The reason you provide here will help with compliance. Example reasons: \"Customer opted-in through webform\", \"Company gave explicit permission.\"\n\n```json\n\"opt_in_reason\": \"your reason for opt-in\"\n```\nNote that the email address status will only be updated to unconfirmed (marketable) for email addresses that are currently in the following states:\nUnengaged Marketable\nUnengaged Non-Marketable\nNon-Marketable\nOpt-Out: Manual\nAll other existing statuses e.g. List Unsubscribe, Opt-Out System etc will remain non-marketable and in their existing state.","operationId":"replaceEmailAddress","parameters":[{"name":"email","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEmailAddress"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestEmailAddress"}}}}}}},"/rest/v1/contacts":{"get":{"tags":["Contact"],"summary":"List Contacts","description":"Retrieves a list of all contacts","operationId":"listContacts","parameters":[{"name":"contactQueryCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/ContactQueryCommand"}},{"name":"optional_properties","in":"query","description":"Comma-delimited list of Contact properties to include in the response. (Some fields such as `lead_source_id`, `custom_fields`, and `job_title` aren't included, by default.)","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactList"}}}}}},"put":{"tags":["Contact"],"summary":"Create or Update a Contact","description":"Creates a new contact or updates a contact as the authenticated user. NB: New Contacts must contain at least one item in `email_addresses` or `phone_numbers` and `country_code` is required if `region` is specified. Existing Contacts are updated with only the values provided in the request. Accepts a `duplicate_option` which performs duplicate checking by one of the following options: `Email`, `EmailAndName`, if a match is found using the option provided, the existing contact will be updated. If an existing contact was not found using the `duplicate_option` provided, a new contact record will be created.\n\nYou may opt-in or mark a Contact as _Marketable_ by including the following field in the request JSON with an opt-in reason. (This field is also shown in the complete request body sample.) The reason you provide here will help with compliance. Example reasons: \"Customer opted-in through webform\", \"Contact gave explicit permission.\"\n\n```json\n\"opt_in_reason\": \"your reason for opt-in\"\n```\nNote that the email address status will only be updated to unconfirmed (marketable) for email addresses that are currently in the following states:\nUnengaged Marketable\nUnengaged Non-Marketable\nNon-Marketable\nOpt-Out: Manual\nAll other existing statuses e.g. List Unsubscribe, Opt-Out System etc will remain non-marketable and in their existing state.\n\nThis API only supports a subset of valid timezones. A list of the supported timezones can be found [here](https://developer.infusionsoft.com/faqs/what-timezones-do-contact-calls-accept/).","operationId":"createOrUpdateContact","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpsertContact"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullContact"}}}}}},"post":{"tags":["Contact"],"summary":"Create a Contact","description":"Creates a new contact as the authenticated user. NB: Contact must contain at least one item in `email_addresses` or `phone_numbers` and `country_code` is required if `region` is specified.\n\nPlease see the body schema for updates to the postal code field.\n\nYou may opt-in or mark a Contact as _Marketable_ by including the following field in the request JSON with an opt-in reason. (This field is also shown in the complete request body sample.) The reason you provide here will help with compliance. Example reasons: \"Customer opted-in through webform\", \"Contact gave explicit permission.\"\n\n```json\n\"opt_in_reason\": \"your reason for opt-in\"\n```\nNote that the email address status will only be updated to unconfirmed (marketable) for email addresses that are currently in the following states:\nUnengaged Marketable\nUnengaged Non-Marketable\nNon-Marketable\nOpt-Out: Manual\nAll other existing statuses e.g. List Unsubscribe, Opt-Out System etc will remain non-marketable and in their existing state.\n\nThis API only supports a subset of valid timezones. A list of the supported timezones can be found [here](https://developer.infusionsoft.com/faqs/what-timezones-do-contact-calls-accept/).","operationId":"createContact","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrPatchContact"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullContact"}}}}}}},"/rest/v1/appointments/{appointmentId}":{"get":{"tags":["Appointment"],"summary":"Retrieve an Appointment","description":"Retrieves a specific appointment with respect to user permissions. The authenticated user will need the \"can view all records\" permission for Task/Appt/Notes","operationId":"getAppointment","parameters":[{"name":"appointmentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}}}}},"put":{"tags":["Appointment"],"summary":"Replace an Appointment","description":"Replaces all values of a given appointment","operationId":"updateAppointment","parameters":[{"name":"appointmentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}}}}},"delete":{"tags":["Appointment"],"summary":"Delete an Appointment","description":"Deletes the specified appointment","operationId":"deleteAppointment","parameters":[{"name":"appointmentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"204":{"description":"No Content"}}},"patch":{"tags":["Appointment"],"summary":"Update an Appointment","description":"Updates the provided values of a given appointment","operationId":"updatePropertiesOnAppointment","parameters":[{"name":"appointmentId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}}}}}},"/rest/v1/account/profile":{"get":{"tags":["Account Info"],"summary":"Retrieve account profile","description":"Retrieves profile/company info for an account.","operationId":"getAccountProfile","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountProfile"}}}}}},"put":{"tags":["Account Info"],"summary":"Updates an account profile","description":"Updates profile/company info for an account.","operationId":"updateAccountInfo","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountProfile"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountProfile"}}}}}}},"/rest/v1/users":{"get":{"tags":["Users"],"summary":"List Users","description":"Retrieves a list of all users","operationId":"listUsers","parameters":[{"name":"restUserQueryCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RestUserQueryCommand"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users"}}}}}},"post":{"tags":["Users"],"summary":"Create a User","description":"Creates a new user record. NB: Users will be invited to the application and remain in the \"Invited\" status until the user accepts the invite. \"Inactive\" users will not take up a user license.","operationId":"createUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUser"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestUser"}}}}}}},"/rest/v1/tasks/model/customFields":{"post":{"tags":["Task"],"summary":"Create a Custom Field","description":"Creates a custom field of the specified type and options to the Task object","operationId":"createTaskCustomField","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRestCustomField"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldMetaData"}}}}}}},"/rest/v1/tasks":{"get":{"tags":["Task"],"summary":"List Tasks","description":"Retrieves a list of all tasks using the specified search criteria","operationId":"listTasks","parameters":[{"name":"contact_id","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"has_due_date","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"user_id","in":"query","required":false,"schema":{"type":"integer","format":"int64"}},{"name":"taskSearchCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/TaskSearchCommand"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskList"}}}}}},"post":{"tags":["Task"],"summary":"Create a Task","description":"Creates a new task as the authenticated user.  \n*Note:* Contact must contain at least one item in the fields `title` and `due_date`.  \nAll other attributes are optional.  \nThis endpoint does not currently support setting Custom Field values.","operationId":"createTask","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Task"}}}}}}},"/rest/v1/tags/{tagId}/contacts":{"get":{"tags":["Tags"],"summary":"List Tagged Contacts","description":"Retrieves a list of contacts that have the given tag applied","operationId":"listContactsForTagId","parameters":[{"name":"tagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"queryCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RestQueryCommand"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaggedContactList"}}}}}},"post":{"tags":["Tags"],"summary":"Apply Tag to Contacts","description":"Apply a tag to a list of contacts","operationId":"applyTagToContactIds","parameters":[{"name":"tagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetOfIds"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string","enum":["SUCCESS","DUPLICATE","CONTACT_NOT_FOUND","TAG_ID_NOT_FOUND","FAILURE","NO_PERMISSION"]}}}}}}},"delete":{"tags":["Tags"],"summary":"Remove Tag from Contacts","description":"Remove a tag from a list of contacts","operationId":"removeTagFromContactIds","parameters":[{"name":"tagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"ids","in":"query","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"},"uniqueItems":true}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"204":{"description":"No Content"}}}},"/rest/v1/tags/categories":{"post":{"tags":["Tags"],"summary":"Create Tag Category","description":"Create a new tag category","operationId":"createTagCategory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTagCategory"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagCategory"}}}}}}},"/rest/v1/tags":{"get":{"tags":["Tags"],"summary":"List Tags","description":"Retrieve a list of tags defined in the application","operationId":"listTags","parameters":[{"name":"restTagQueryCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RestTagQueryCommand"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tags"}}}}}},"post":{"tags":["Tags"],"summary":"Create Tag","description":"Create a new tag","operationId":"createTag","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTag"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}}}}}},"/rest/v1/subscriptions":{"get":{"tags":["E-Commerce"],"summary":"List Subscriptions","description":"Retrieves a list of all subcriptions using the specified search criteria.","operationId":"listSubscriptions","parameters":[{"name":"subscriptionListCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/SubscriptionListCommand"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionList"}}}}}},"post":{"tags":["E-Commerce"],"summary":"Create Subscription","description":"Creates a subscription with the specified product and product subscription id.","operationId":"createSubscription","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubscription"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Subscription"}}}}}}},"/rest/v1/products/{productId}/subscriptions":{"post":{"tags":["Product"],"summary":"Create a Product Subscription","description":"Creates a new product subscription","operationId":"createProductSubscription","parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProductSubscription"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSubscription"}}}}}}},"/rest/v1/products/{productId}/image":{"post":{"tags":["Product"],"summary":"Upload a product image","description":"Max payload 3 megabytes, the `file_data` is base64 encoded.","operationId":"createProductImage","parameters":[{"name":"httpHeaders","in":"header","required":true,"schema":{"$ref":"#/components/schemas/HttpHeaders"}},{"name":"productId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProductImage"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created"}}},"delete":{"tags":["Product"],"summary":"Delete a product image","operationId":"deleteProductImage","parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"204":{"description":"No Content"}}}},"/rest/v1/products":{"get":{"tags":["Product"],"summary":"List Products","description":"Retrieves a list of all products","operationId":"listProducts","parameters":[{"name":"productSearchCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/ProductSearchCommand"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductList"}}}}},"deprecated":true},"post":{"tags":["Product"],"summary":"Create a Product","description":"Creates a new product","operationId":"createProduct","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProduct"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestProductV1"}}}}}}},"/rest/v1/orders/{orderId}/payments":{"get":{"tags":["E-Commerce"],"summary":"Retrieve Order Payments","description":"Retrieves a list of payments made against a given order, including historical or external payments of cash or credit card.","operationId":"listOrderPayments","parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/InvoicePayment"}}}}}}},"post":{"tags":["E-Commerce"],"summary":"Create a Payment","description":"Creates a payment record that can charge a credit card. Alternatively, adds a record of historical or external payment of cash or credit card.","operationId":"createPaymentOnOrder","parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePayment"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentResult"}}}}}}},"/rest/v1/orders/{orderId}/items":{"post":{"tags":["E-Commerce"],"summary":"Create an Order Item","description":"Creates an order item on an existing order.","operationId":"createOrderItemsOnOrder","parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderItem"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderItem"}}}}}}},"/rest/v1/orders":{"get":{"tags":["E-Commerce"],"summary":"List Orders","description":"Retrieves a list of all orders using the specified search criteria. Each order may or may not have items.\n\nPotential values for order status:`DRAFT`, `SENT`, `VIEWED`, `PAID`","operationId":"listOrders","parameters":[{"name":"orderSearchCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/OrderSearchCommand"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderList"}}}}}},"post":{"tags":["E-Commerce"],"summary":"Create an Order","description":"Create a one time order with order items.","operationId":"createOrder","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrder"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}}}}},"/rest/v1/notes/model/customFields":{"post":{"tags":["Note"],"summary":"Create a Custom Field","description":"Adds a custom field of the specified type and options to the Note object.","operationId":"createNoteCustomField","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRestCustomField"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldMetaData"}}}}}}},"/rest/v1/notes":{"get":{"tags":["Note"],"summary":"List Notes","description":"Retrieves a list of all notes","operationId":"listNotes","parameters":[{"name":"noteQueryCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/NoteQueryCommand"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteList"}}}}}},"post":{"tags":["Note"],"summary":"Create a Note","description":"Creates a new note as the authenticated user. Either a \"title\" or \"body\" is required","operationId":"createNote","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestNote"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}}}}}},"/rest/v1/hooks/{key}/verify":{"post":{"tags":["REST Hooks"],"summary":"Verify a Hook Subscription","description":"This operation is used to verify or reactivate a hook subscription using RESTHooks.org's [Immediate Confirmation](http://resthooks.org/docs/security/) pattern.\n\nTo verify or reactivate a hook subscription, Infusionsoft will make a `POST` request with a temporary secret to the `hookUrl` you provided during creation. The secret is passed as the value of a header named `X-Hook-Secret`. Your response to that `POST` *must* have a status code of `200` and return the same `X-Hook-Secret` header and value pair. Once you've done that, you'll begin receiving hooks. Don't worry if verification fails; you can always [request another verification attempt](#!/REST_Hooks/verify_a_hook_subscription).\n\nNB: You will not receive events until the subscription is verified.\n\nIf the verification process seems confusing, head over to [RESTHooks.org](http://resthooks.org/docs/security/) for more on the concept.","operationId":"verify_a_hook_subscription","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestHook"}}}}}}},"/rest/v1/hooks/{key}/delayedVerify":{"post":{"tags":["REST Hooks"],"summary":"Verify a Hook Subscription, Delayed","description":"This operation is used to verify or reactivate a hook subscription out-of-band using RESTHooks.org's [Delayed Confirmation](http://resthooks.org/docs/security/) pattern.\n\nUse this verification method if you're not able to use the Immediate Confirmation provided through [Create a Hook Subscription](#!/REST_Hooks/create_a_hook_subscription) or [Verify a Hook Subscription](#!/REST_Hooks/verify_a_hook_subscription). This operation allows you to confirm a subscription by manually sending us the `X-Hook-Secret` you received.\n\nNB: **The `X-Hook-Secret` _must_ be passed as a _header_.**\n\nDon't worry if verification fails; you can always [request another verification attempt](#!/REST_Hooks/verify_a_hook_subscription).\n\nNB: You will not receive events until the subscription is verified.\n\nIf the verification process seems confusing, head over to [RESTHooks.org](http://resthooks.org/docs/security/) for more on the concept.","operationId":"verify_a_hook_subscription_delayed","parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string"}},{"name":"X-Hook-Secret","in":"header","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestHook"}}}}}}},"/rest/v1/hooks":{"get":{"tags":["REST Hooks"],"summary":"List Stored Hook Subscriptions","description":"Lists your hook subscriptions.","operationId":"list_stored_hook_subscriptions","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RestHook"}}}}}}},"post":{"tags":["REST Hooks"],"summary":"Create a Hook Subscription","description":"To receive hooks, you'll first need to subscribe to events one at a time *and* individually verify each subscription.\n\nThis operation is used to create hook subscriptions. During this process, Infusionsoft will attempt to verify your subscription. Continue reading to learn how that works.\n\nTo verify or reactivate a hook subscription, Infusionsoft will make a `POST` request with a temporary secret to the `hookUrl` you provided during creation. The secret is passed as the value of a header named `X-Hook-Secret`. Your response to that `POST` *must* have a status code of `200` and return the same `X-Hook-Secret` header and value pair. Once you've done that, you'll begin receiving hooks. Don't worry if verification fails; you can always [request another verification attempt](#!/REST_Hooks/verify_a_hook_subscription).\n\nNB: You will not receive events until the subscription is verified.\n\nIf the verification process seems confusing, head over to [RESTHooks.org](http://resthooks.org/docs/security/) for more on the concept.","operationId":"create_a_hook_subscription","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestHookRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestHook"}}}}}}},"/rest/v1/files":{"get":{"tags":["File"],"summary":"List Files","description":"Retrieves a list of all files","operationId":"listFiles","parameters":[{"name":"fileQueryCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/FileQueryCommand"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileList"}}}}}},"post":{"tags":["File"],"summary":"Upload File","description":"Upload a base64 encoded file. `contact_id` is required only when `file_association` is `CONTACT`.","operationId":"createFile","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUpload"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileInformation"}}}}}}},"/rest/v1/emails/unsync":{"post":{"tags":["Email"],"summary":"Un-sync a batch of Email Records","description":"Un-syncs a batch of email records","operationId":"deleteEmails","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetOfIds"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string"}}}}}}}},"/rest/v1/emails/sync":{"post":{"tags":["Email"],"summary":"Create a set of Email Records","description":"Create a set of records of emails sent to contacts, maximum 1000 per transaction.","operationId":"createEmails","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSentCreateListRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSentCreateListResponse"}}}}}}},"/rest/v1/emails/queue":{"post":{"tags":["Email"],"summary":"Send an Email","description":"Send an Email to a list of Contacts","operationId":"sendEmail","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSendRequest"}}},"required":true},"responses":{"400":{"description":"Bad Request: invalid email parameters or from address domain is not authenticated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"202":{"description":"Accepted"}}}},"/rest/v1/emails":{"get":{"tags":["Email"],"summary":"List Emails","description":"Retrieve a list of emails that have been sent\n\nKeap is currently investigating an issue with degraded performance\nof this endpoint with very large (millions of records) record sets","operationId":"listEmails","parameters":[{"name":"emailSentQueryCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/EmailSentQueryCommand"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSentQueryResultList"}}}}}},"post":{"tags":["Email"],"summary":"Create an Email Record","description":"Create a record of an email sent to a contact","operationId":"createEmail","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSentCreate"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSentCreate"}}}}}}},"/rest/v1/contacts/{contactId}/utm":{"post":{"tags":["Contact"],"summary":"Insert UTMs for a Contact","description":"Inserts UTMs for the contact specified by the contactId. The authenticated user must have permission to modify the contact utm info","operationId":"insertUTMs","parameters":[{"name":"contactId","in":"path","description":"ID of the contact to insert UTMs for","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUtmContact"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullUtm"}}}}}}},"/rest/v1/contacts/{contactId}/tags":{"get":{"tags":["Contact"],"summary":"List Applied Tags","description":"Retrieves a list of tags applied to a given contact","operationId":"listAppliedTags","parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"queryCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RestQueryCommand"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactTagList"}}}}}},"post":{"tags":["Contact"],"summary":"Apply Tags","description":"Apply a list of tags to a given contact record","operationId":"applyTagsToContactId","parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagId"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string","enum":["SUCCESS","DUPLICATE","CONTACT_NOT_FOUND","TAG_ID_NOT_FOUND","FAILURE","NO_PERMISSION"]}}}}}}},"delete":{"tags":["Contact"],"summary":"Remove Applied Tags","description":"Removes a list of tags from the given contact. Provide one or more tag ids in the querystring as a comma-separated URIencoded list (%2C is a comma). E.g. DELETE /contacts/{contact_id}/tags?ids=1%2C2%2C3","operationId":"removeTagsFromContact","parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"ids","in":"query","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"},"uniqueItems":true}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"204":{"description":"No Content"}}}},"/rest/v1/contacts/{contactId}/emails":{"get":{"tags":["Contact"],"summary":"List Emails","description":"List Emails that have been sent to a Contact","operationId":"listEmailsForContact","parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"contactQueryEmailCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/ContactQueryEmailCommand"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSentQueryResultList"}}}}}},"post":{"tags":["Contact"],"summary":"Create an Email Record","description":"Create a record of an email sent to a contact","operationId":"createEmailForContact","parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSentCreate"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSentCreate"}}}}}}},"/rest/v1/contacts/{contactId}/creditCards":{"get":{"tags":["Contact"],"summary":"Retrieve Credit Cards","description":"List all Credit Cards on a contact","operationId":"listCreditCards","parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContactCreditCard"}}}}}}},"post":{"tags":["Contact"],"summary":"Create a Credit Card","description":"Creates a new credit card associated to a contact","operationId":"createCreditCard","parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditCard"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreditCardAdded"}}}}}}},"/rest/v1/contacts/model/customFields":{"post":{"tags":["Contact"],"summary":"Create a Custom Field","description":"Adds a custom field of the specified type and options to the Contact object.","operationId":"createCustomField","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRestCustomField"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldMetaData"}}}}}}},"/rest/v1/companies":{"get":{"tags":["Company"],"summary":"List Companies","description":"Retrieves a list of all companies","operationId":"listCompanies","parameters":[{"name":"companyQueryCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/CompanyQueryCommand"}},{"name":"optional_properties","in":"query","description":"Comma-delimited list of Company properties to include in the response. (Fields such as `notes`, `fax_number` and `custom_fields` aren't included, by default.)","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyList"}}}}}},"post":{"tags":["Company"],"summary":"Create a Company","description":"Creates a new company as the authenticated user. NB: Company must contain at least the company name. The `country_code` is required if `region` is specified.\n\nYou may opt-in or mark a Company as _Marketable_ by including the following field in the request JSON with an opt-in reason. (This field is also shown in the complete request body sample.) The reason you provide here will help with compliance. Example reasons: \"Customer opted-in through webform\", \"Company gave explicit permission.\"\n\n```json\n\"opt_in_reason\": \"your reason for opt-in\"\n```\nNote that the email address status will only be updated to unconfirmed (marketable) for email addresses that are currently in the following states:\nUnengaged Marketable\nUnengaged Non-Marketable\nNon-Marketable\nOpt-Out: Manual\nAll other existing statuses e.g. List Unsubscribe, Opt-Out System etc will remain non-marketable and in their existing state.","operationId":"createCompany","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrPatchCompany"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}}}}},"/rest/v1/campaigns/{campaignId}/sequences/{sequenceId}/contacts/{contactId}":{"post":{"tags":["Campaign"],"summary":"Add to Campaign Sequence","description":"Adds a single contact to a campaign sequence","operationId":"addContactToCampaignSequence","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"sequenceId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"contactId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"204":{"description":"No Content"}}},"delete":{"tags":["Campaign"],"summary":"Remove from Campaign Sequence","description":"Removes a single contact from a campaign sequence","operationId":"removeContactFromCampaignSequence","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"sequenceId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"contactId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"204":{"description":"No Content"}}}},"/rest/v1/campaigns/{campaignId}/sequences/{sequenceId}/contacts":{"post":{"tags":["Campaign"],"summary":"Add Multiple to Campaign Sequence","description":"Adds a list of contacts to a campaign sequence\nResponse contains a map of the provided list of Contact Ids related to their individual result.","operationId":"addContactsToCampaignSequence","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"sequenceId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetOfIds"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"object","additionalProperties":{"type":"string","enum":["SUCCESS","ALREADY_IN_SEQUENCE","CONTACT_DOES_NOT_EXIST","FAILED"]}}}}}}},"delete":{"tags":["Campaign"],"summary":"Remove Multiple from Campaign Sequence","description":"Removes a list of contacts from a campaign sequence","operationId":"removeContactsFromCampaignSequence","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"sequenceId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetOfIds"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"204":{"description":"No Content"}}}},"/rest/v1/campaigns/goals/{integration}/{callName}":{"post":{"tags":["Campaign"],"summary":"Achieve API Goal","description":"Achieves API goal for campaigns with matching integration, callName for a given contactId","operationId":"createAchieveApiGoalEvent","parameters":[{"name":"integration","in":"path","required":true,"schema":{"type":"string"}},{"name":"callName","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AchieveApiGoalEvent"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GoalEventResultDTO"}}}}}}}},"/rest/v1/appointments/model/customFields":{"post":{"tags":["Appointment"],"summary":"Create a Custom Field","description":"Adds a custom field of the specified type and options to the Appointment object.","operationId":"createAppointmentCustomField","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRestCustomField"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomFieldMetaData"}}}}}}},"/rest/v1/appointments":{"get":{"tags":["Appointment"],"summary":"List Appointments","description":"Retrieves all appointments for the authenticated user","operationId":"listAppointments","parameters":[{"name":"appointmentSearchCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/AppointmentSearchCommand"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AppointmentList"}}}}}},"post":{"tags":["Appointment"],"summary":"Create an Appointment","description":"Creates a new appointment as the authenticated user","operationId":"createAppointment","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Appointment"}}}}}}},"/rest/v1/affiliates":{"get":{"tags":["Affiliate"],"summary":"List Affiliates","description":"Retrieves a list of all affiliates","operationId":"listAffiliates","parameters":[{"name":"name","in":"query","description":"Optional affiliate name to query on","required":false,"schema":{"type":"string"}},{"name":"code","in":"query","description":"Optional affiliate parent ID to query on","required":false,"schema":{"type":"string"}},{"name":"parent_id","in":"query","description":"Optional affiliate code to query on","required":false,"schema":{"type":"string"}},{"name":"contact_id","in":"query","description":"Optional contact ID to query on","required":false,"schema":{"type":"string"}},{"name":"program_id","in":"query","description":"Optional affiliate program ID to query on","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Optional affiliate status to query on","required":false,"schema":{"type":"string","enum":["active","inactive"]}},{"name":"order","in":"query","description":"Attribute to order items by","required":false,"schema":{"type":"string","enum":["id","name"]}},{"name":"order_direction","in":"query","description":"How to order the data i.e. ascending (A-Z) or descending (Z-A)","required":false,"schema":{"type":"string","enum":["ASCENDING","DESCENDING"]}},{"name":"offset","in":"query","description":"Count to offset the returned results by","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"limit","in":"query","description":"Sets a beginning range of items to return","required":false,"schema":{"type":"integer","format":"int32"},"example":0}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateList"}}}}}},"post":{"tags":["Affiliate"],"summary":"Create an affiliate","description":"Create a single affiliate","operationId":"createAffiliate","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAffiliate"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Affiliate"}}}}}}},"/rest/v1/products/{productId}":{"get":{"tags":["Product"],"summary":"Retrieve a Product","operationId":"retrieveProduct","parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestProductV1"}}}}}},"delete":{"tags":["Product"],"summary":"Delete a Product","description":"Deletes a product and its subscriptions","operationId":"deleteProduct","parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"204":{"description":"No Content"}}},"patch":{"tags":["Product"],"summary":"Update a Product","description":"Updates a Product with only the values provided in the request.","operationId":"updateProduct","parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProduct"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestProductV1"}}}}}}},"/rest/v1/opportunities/{opportunityId}":{"get":{"tags":["Opportunity"],"summary":"Retrieve an Opportunity","description":"Retrives a single opportunity","operationId":"getOpportunity","parameters":[{"name":"opportunityId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"optional_properties","in":"query","description":"Comma-delimited list of Opportunity properties to include in the response. (Some fields such as `custom_fields` aren't included, by default.)","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Opportunity"}}}}}},"patch":{"tags":["Opportunity"],"summary":"Update an Opportunity","description":"Updates an opportunity with only the values provided in the request.  \n  \n*Note:* The POST payload for this request is identical to ['Replace an Opportunity'](https://developer.infusionsoft.com/docs/rest/#operation/updateOpportunityUsingPUT) operation.","operationId":"updatePropertiesOnOpportunity","parameters":[{"name":"opportunityId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Opportunity"}}}}}}},"/rest/v1/contacts/{contactId}":{"delete":{"tags":["Contact"],"summary":"Delete a Contact","description":"Deletes the specified contact.","operationId":"deleteContact","parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"204":{"description":"No Content"}}},"patch":{"tags":["Contact"],"summary":"Update a Contact","description":"Updates a contact with only the values provided in the request.\n\nYou may opt-in or mark a Contact as _Marketable_ by including the following field in the request JSON with an opt-in reason. (This field is also shown in the complete request body sample.) The reason you provide here will help with compliance. Example reasons: \"Customer opted-in through webform\", \"Contact gave explicit permission.\"\n\n```json\n\"opt_in_reason\": \"your reason for opt-in\"\n```\nNote that the email address status will only be updated to unconfirmed (marketable) for email addresses that are currently in the following states:\nUnengaged Marketable\nUnengaged Non-Marketable\nNon-Marketable\nOpt-Out: Manual\nAll other existing statuses e.g. List Unsubscribe, Opt-Out System etc will remain non-marketable and in their existing state.","operationId":"updatePropertiesOnContact","parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"update_mask","in":"query","description":"An optional list of properties to be updated. If set, only the provided properties will be updated and others will be skipped.","required":false,"schema":{"type":"string","enum":["addresses,anniversary,birthday,company,contact_type,custom_fields,email_addresses,family_name,fax_numbers,given_name,job_title,lead_source_id,middle_name,notes,opt_in_reason,origin,owner_id,phone_numbers,preferred_locale,preferred_name,prefix,social_accounts,source_type,spouse_name,suffix,time_zone,website"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrPatchContact"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullContact"}}}}}}},"/rest/v1/companies/{companyId}":{"get":{"tags":["Company"],"summary":"Retrieve a Company","description":"Retrieves a single company","operationId":"getCompany","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"optional_properties","in":"query","description":"Comma-delimited list of Company properties to include in the response. (Fields such as `notes`, `fax_number` and `custom_fields` aren't included, by default.)","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}}}},"patch":{"tags":["Company"],"summary":"Update a Company","description":"Updates a company with only the values provided in the request.\n\nYou may opt-in or mark a Company as _Marketable_ by including the following field in the request JSON with an opt-in reason. (This field is also shown in the complete request body sample.) The reason you provide here will help with compliance. Example reasons: \"Customer opted-in through webform\", \"Company gave explicit permission.\"\n\n```json\n\"opt_in_reason\": \"your reason for opt-in\"\n```\nNote that the email address status will only be updated to unconfirmed (marketable) for email addresses that are currently in the following states:\nUnengaged Marketable\nUnengaged Non-Marketable\nNon-Marketable\nOpt-Out: Manual\nAll other existing statuses e.g. List Unsubscribe, Opt-Out System etc will remain non-marketable and in their existing state.","operationId":"updateCompany","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrPatchCompany"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}}}}},"/rest/v1/company/{companyId}":{"patch":{"tags":["Company"],"summary":"Update a Company","description":"Updates a company with only the values provided in the request.\n\nYou may opt-in or mark a Company as _Marketable_ by including the following field in the request JSON with an opt-in reason. (This field is also shown in the complete request body sample.) The reason you provide here will help with compliance. Example reasons: \"Customer opted-in through webform\", \"Company gave explicit permission.\"\n\n```json\n\"opt_in_reason\": \"your reason for opt-in\"\n```\nNote that the email address status will only be updated to unconfirmed (marketable) for email addresses that are currently in the following states:\nUnengaged Marketable\nUnengaged Non-Marketable\nNon-Marketable\nOpt-Out: Manual\nAll other existing statuses e.g. List Unsubscribe, Opt-Out System etc will remain non-marketable and in their existing state.","operationId":"updateCompany_1","parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrPatchCompany"}}},"required":true},"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}}}}}},"/rest/v1/users/{userId}/signature":{"get":{"tags":["Users"],"summary":"Get User email signature","description":"Retrieves a HTML snippet that contains the user's email signature.","operationId":"getUserSignature","parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/rest/v1/transactions/{transactionId}":{"get":{"tags":["E-Commerce"],"summary":"Retrieve a Transaction","description":"Retrieves a single transaction","operationId":"getTransaction","parameters":[{"name":"transactionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EcommerceReportingTransaction"}}}}},"deprecated":true}},"/rest/v1/transactions":{"get":{"tags":["E-Commerce"],"summary":"List Transactions","description":"Retrieves a list transactions for a given contact","operationId":"listTransactions","parameters":[{"name":"transactionSearchCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/TransactionSearchCommand"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionList"}}}}},"deprecated":true}},"/rest/v1/tasks/search":{"get":{"tags":["Task"],"summary":"Search Tasks","description":"Retrieves Tasks belonging to the authenticated user using the specified search criteria","operationId":"listTasksForCurrentUser","parameters":[{"name":"contact_id","in":"query","description":"Returns tasks for the provided contact id","required":false,"schema":{"type":"integer","format":"int64"},"example":0},{"name":"has_due_date","in":"query","description":"Returns tasks that have an 'action date' when set to true","required":false,"schema":{"type":"boolean"}},{"name":"user_id","in":"query","description":"Returns tasks for the provided user id","required":false,"schema":{"type":"integer","format":"int64"},"example":0},{"name":"taskSearchCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/TaskSearchCommand"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskList"}}}}}}},"/rest/v1/tasks/model":{"get":{"tags":["Task"],"summary":"Retrieve Task Model","description":"Get the custom fields for the Task object","operationId":"retrieveTaskModel","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectModel"}}}}}}},"/rest/v1/tags/{tagId}/companies":{"get":{"tags":["Tags"],"summary":"List Tagged Companies","description":"Retrieves a list of companies that have the given tag applied","operationId":"listCompaniesForTagId","parameters":[{"name":"tagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"queryCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RestQueryCommand"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaggedCompanyList"}}}}}}},"/rest/v1/tags/{id}":{"get":{"tags":["Tags"],"summary":"Retrieve a Tag","description":"Retrieves a single tag","operationId":"getTag","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}}}}}},"/rest/v1/subscriptions/model":{"get":{"tags":["E-Commerce"],"summary":"Retrieve Subscription Model","description":"Get the custom fields for the Subscription object","operationId":"retrieveSubscriptionModel","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectModel"}}}}}}},"/rest/v1/setting/contact/optionTypes":{"get":{"tags":["Setting"],"summary":"List Contact types","description":"Lists the Contact types in a comma-separated list.  \n*Note:* This is now provided by GET /setting/application/configuration","operationId":"getContactOptionTypes","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Setting"}}}}},"deprecated":true}},"/rest/v1/setting/application/enabled":{"get":{"tags":["Setting"],"summary":"Retrieve application status","description":"Retrieves whether the application is enabled","operationId":"getApplicationEnabled","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Setting"}}}}}}},"/rest/v1/setting/application/configuration":{"get":{"tags":["Setting"],"summary":"Retrieve application configuration","description":"Get the properties for the current application's configuration","operationId":"getConfiguration","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestApplicationConfiguration"}}}}}}},"/rest/v1/products/{productId}/subscriptions/{subscriptionId}":{"get":{"tags":["Product"],"summary":"Retrieve a Product Subscription","operationId":"retrieveProductSubscription","parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"subscriptionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSubscription"}}}}}},"delete":{"tags":["Product"],"summary":"Delete a Product Subscription","description":"Deletes a product subscription","operationId":"deleteProductSubscription","parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"subscriptionId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"204":{"description":"No Content"}}}},"/rest/v1/products/sync":{"get":{"tags":["Product"],"summary":"Retrieve Synced Products","description":"The Sync endpoint returns a set of products that have been updated or created since the last result set was retrieved, minus any products that have been deleted.","operationId":"listProductsFromSyncToken","parameters":[{"name":"sync_token","in":"query","required":false,"schema":{"type":"string"}},{"name":"syncCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/SyncCommand"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductStatusList"}}}}},"deprecated":true}},"/rest/v1/orders/{orderId}/transactions":{"get":{"tags":["E-Commerce"],"summary":"Retrieve Order Transactions","description":"Retrieves a list of all transactions on a given order using the specified search criteria","operationId":"listTransactionsForOrder","parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"transactionSearchCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/TransactionSearchCommand"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionList"}}}}}}},"/rest/v1/orders/{orderId}":{"get":{"tags":["E-Commerce"],"summary":"Retrieve an Order","description":"Retrieves a single order. The order may or may not have items.\n\nPotential values for order status:`DRAFT`, `SENT`, `VIEWED`, `PAID`","operationId":"getOrder","parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EcommerceReportingOrder"}}}}}},"delete":{"tags":["E-Commerce"],"summary":"Delete an Order","description":"Delete an order that does not have a payment","operationId":"deleteOrder","parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"204":{"description":"No Content"}}}},"/rest/v1/orders/model":{"get":{"tags":["E-Commerce"],"summary":"Retrieve Custom Order Model","description":"Get the custom fields for the Order object","operationId":"retrieveOrderModel","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectModel"}}}}}}},"/rest/v1/opportunity/stage_pipeline":{"get":{"tags":["Opportunity"],"summary":"List Opportunity Stage Pipeline","description":"Retrieves a list of all opportunity stages with pipeline details","operationId":"listOpportunityStagePipelines","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SalesPipeline"}}}}}}}},"/rest/v1/opportunities/model":{"get":{"tags":["Opportunity"],"summary":"Retrieve Opportunity Model","description":"Get the custom fields for the Opportunity object","operationId":"retrieveOpportunityModel","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectModel"}}}}}}},"/rest/v1/notes/model":{"get":{"tags":["Note"],"summary":"Retrieve Note Model","description":"Get the custom fields for the Note object","operationId":"retrieveNoteModel","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectModel"}}}}}}},"/rest/v1/merchants":{"get":{"tags":["Merchant"],"summary":"List Merchants","description":"Retrieves a list of all merchant accounts","operationId":"getMerchantAccounts","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestMerchantAccountResponse"}}}}}}},"/rest/v1/locales/defaultOptions":{"get":{"tags":["Locale"],"summary":"List dropdown default options","operationId":"defaultOptions","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestDefaultOptionsResponse"}}}}}}},"/rest/v1/locales/countries/{countryCode}/provinces":{"get":{"tags":["Locale"],"summary":"List a Country's Provinces","operationId":"listCountries","parameters":[{"name":"countryCode","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProvincesByCode"}}}}}}},"/rest/v1/locales/countries":{"get":{"tags":["Locale"],"summary":"List Countries","operationId":"listCountries_1","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountriesByCode"}}}}}}},"/rest/v1/hooks/event_keys":{"get":{"tags":["REST Hooks"],"summary":"List Hook Event Types","description":"List the available types of Events that can be listened to","operationId":"list_hook_event_types","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"}}}}}}}},"/rest/v1/emails/{id}":{"get":{"tags":["Email"],"summary":"Retrieve an Email","description":"Retrieves a single email that has been sent","operationId":"getEmail","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSentQueryResultWithContent"}}}}}},"delete":{"tags":["Email"],"summary":"Delete an Email Record","description":"Delete a specific email record","operationId":"deleteEmail","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"204":{"description":"No Content"}}}},"/rest/v1/contacts/{id}":{"get":{"tags":["Contact"],"summary":"Retrieve a Contact","description":"Retrieves a single contact\n\nThe v1 call with optional property i.e. social_accounts[e.g. Instagram, Snapchat, YouTube, or Pinterest]does not return social accounts in response.Documenting it as we are migrating from v1 to v2.Working as expected in v2 call.","operationId":"getContact","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"optional_properties","in":"query","description":"Comma-delimited list of Contact properties to include in the response. (Some fields such as `lead_source_id`, `custom_fields`, and `job_title` aren't included, by default.)","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FullContact"}}}}}}},"/rest/v1/contacts/model":{"get":{"tags":["Contact"],"summary":"Retrieve Contact Model","description":"Get the custom fields and optional properties for the Contact object","operationId":"retrieveContactModel","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectModel"}}}}}}},"/rest/v1/companies/model":{"get":{"tags":["Company"],"summary":"Retrieve Company Model","description":"Get the custom fields and optional properties for the Company object","operationId":"retrieveCompanyModel","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectModel"}}}}}}},"/rest/v1/campaigns/{campaignId}":{"get":{"tags":["Campaign"],"summary":"Retrieve a Campaign","description":"Retrieves a single campaign","operationId":"getCampaign","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"optional_properties","in":"query","description":"Comma-delimited list of Campaign properties to include in the response. (The fields `goals` and `sequences` aren't included, by default.)","schema":{"type":"string"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignWithStats"}}}}}}},"/rest/v1/campaigns":{"get":{"tags":["Campaign"],"summary":"List Campaigns","description":"Retrieves all campaigns for the authenticated user","operationId":"listCampaigns","parameters":[{"name":"restQueryCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/CampaignQueryCommand"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignList"}}}}}}},"/rest/v1/appointments/model":{"get":{"tags":["Appointment"],"summary":"Retrieve Appointment Model","description":"Get the custom fields for the Appointment object","operationId":"retrieveAppointmentModel","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectModel"}}}}}}},"/rest/v1/affiliates/{id}":{"get":{"tags":["Affiliate"],"summary":"Retrieve an affiliate","description":"Retrieve a single affiliate","operationId":"getAffiliate","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Affiliate"}}}}}}},"/rest/v1/affiliates/{affiliateId}/payments":{"get":{"tags":["Affiliate"],"summary":"List Affiliate payments","description":"Retrieves a list of all affiliate payments","operationId":"listPayments","parameters":[{"name":"affiliateId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"queryCommand","in":"query","required":true,"schema":{"$ref":"#/components/schemas/RestAffiliatePaymentQueryCommand"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliatePaymentList"}}}}}}},"/rest/v1/affiliates/{affiliateId}/clawbacks":{"get":{"tags":["Affiliate"],"summary":"List Affiliate clawbacks","description":"Retrieves a list of all affiliate clawbacks","operationId":"listAffiliateClawbacks","parameters":[{"name":"affiliateId","in":"path","required":true,"schema":{"type":"string"}},{"name":"since","in":"query","description":"Optional inclusive start date","required":false,"schema":{"type":"string"}},{"name":"until","in":"query","description":"Optional inclusive end date","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Attribute to order items by","required":false,"schema":{"type":"string","enum":["DATE_EARNED"]}},{"name":"order_direction","in":"query","description":"How to order the data i.e. ascending (A-Z) or descending (Z-A)","required":false,"schema":{"type":"string","enum":["ASCENDING","DESCENDING"]}},{"name":"offset","in":"query","description":"Count to offset the returned results by","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"limit","in":"query","description":"Sets a beginning range of items to return","required":false,"schema":{"type":"integer","format":"int32"},"example":0}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateClawbackList"}}}}}}},"/rest/v1/affiliates/summaries":{"get":{"tags":["Affiliate"],"summary":"List affiliate summaries","description":"Retrieves a list of affiliate summaries","operationId":"listSummaries","parameters":[{"name":"affiliate_ids","in":"query","description":"Ids of the affiliates you would like a summary for","required":true,"schema":{"type":"array","items":{"type":"integer","format":"int64"}}},{"name":"order","in":"query","description":"Attribute to order items by","required":false,"schema":{"type":"string","enum":["affiliate_id","amount_earned","balance","clawbacks"]}},{"name":"order_direction","in":"query","description":"How to order the data i.e. ascending (A-Z) or descending (Z-A)","required":false,"schema":{"type":"string","enum":["ASCENDING","DESCENDING"]}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateSummaryList"}}}}}}},"/rest/v1/affiliates/redirectlinks":{"get":{"tags":["Affiliate"],"summary":"List Affiliate Redirects","description":"Retrieves a list of all affiliate redirects","operationId":"listAffiliateRedirectLinks","parameters":[{"name":"affiliate_id","in":"query","description":"Affiliate ID to search by","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Attribute to order items by","required":false,"schema":{"type":"string","enum":["id","name"]}},{"name":"order_direction","in":"query","description":"How to order the data i.e. ascending (A-Z) or descending (Z-A)","required":false,"schema":{"type":"string","enum":["ASCENDING","DESCENDING"]}},{"name":"offset","in":"query","description":"Count to offset the returned results by","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"limit","in":"query","description":"Sets a beginning range of items to return","required":false,"schema":{"type":"integer","format":"int32"},"example":0}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedirectList"}}}}}}},"/rest/v1/affiliates/programs":{"get":{"tags":["Affiliate"],"summary":"List Commission Programs","description":"Retrieve a list of Commission Programs","operationId":"listPrograms","parameters":[{"name":"affiliate_id","in":"query","description":"Id of the affiliate you would like programs for","required":false,"schema":{"type":"integer","format":"int64"},"example":0},{"name":"order","in":"query","description":"Attribute to order items by","required":false,"schema":{"type":"string","enum":["id","name","priority"]}},{"name":"order_direction","in":"query","description":"How to order the data i.e. ascending (A-Z) or descending (Z-A)","required":false,"schema":{"type":"string","enum":["ASCENDING","DESCENDING"]}},{"name":"offset","in":"query","description":"Count to offset the returned results by","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"limit","in":"query","description":"Sets a beginning range of items to return","required":false,"schema":{"type":"integer","format":"int32"},"example":0}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateProgramList"}}}}}}},"/rest/v1/affiliates/model":{"get":{"tags":["Affiliate"],"summary":"Retrieve Affiliate Model","description":"Get the custom fields for the Affiliate object","operationId":"retrieveAffiliateModel","responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ObjectModel"}}}}}}},"/rest/v1/affiliates/commissions":{"get":{"tags":["Affiliate"],"summary":"List Commissions","description":"Retrieve a list of Commissions based on Affiliate or Date Range","operationId":"listCommissions","parameters":[{"name":"since","in":"query","description":"Date to start searching from ex. `2017-01-01T22:17:59.039Z`","required":false,"schema":{"type":"string"}},{"name":"until","in":"query","description":"Date to search to ex. `2017-01-01T22:17:59.039Z`","required":false,"schema":{"type":"string"}},{"name":"order","in":"query","description":"Attribute to order items by","required":false,"schema":{"type":"string","enum":["DATE_EARNED"]}},{"name":"order_direction","in":"query","description":"How to order the data i.e. ascending (A-Z) or descending (Z-A)","required":false,"schema":{"type":"string","enum":["ASCENDING","DESCENDING"]}},{"name":"limit","in":"query","description":"Sets a total of items to return","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"offset","in":"query","description":"Sets a beginning range of items to return","required":false,"schema":{"type":"integer","format":"int32"},"example":0},{"name":"affiliateId","in":"query","description":"Affiliate to retrieve commissions for","required":false,"schema":{"type":"integer","format":"int64"},"example":0}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateCommissionList"}}}}}}},"/rest/v1/tags/{tagId}/contacts/{contactId}":{"delete":{"tags":["Tags"],"summary":"Remove Tag from Contact","description":"Remove a tag from a Contact","operationId":"removeTagFromContactId","parameters":[{"name":"tagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"contactId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"204":{"description":"No Content"}}}},"/rest/v1/orders/{orderId}/items/{orderItemId}":{"delete":{"tags":["E-Commerce"],"summary":"Delete an Order Item","description":"Delete an order Item on specified Order","operationId":"deleteOrderOrderItem","parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"orderItemId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"204":{"description":"No Content"}}}},"/rest/v1/contacts/{contactId}/tags/{tagId}":{"delete":{"tags":["Contact"],"summary":"Remove Applied Tag","description":"Removes a tag from the given contact","operationId":"removeTagsFromContact_1","parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}},{"name":"tagId","in":"path","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"406":{"description":"Not Acceptable","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"412":{"description":"Precondition Failed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModelAndView"}}}},"204":{"description":"No Content"}}}}},"components":{"schemas":{"DefaultHttpStatusCode":{"allOf":[{"$ref":"#/components/schemas/HttpStatusCode"}]},"HttpStatus":{"allOf":[{"$ref":"#/components/schemas/HttpStatusCode"}],"enum":["100 CONTINUE","101 SWITCHING_PROTOCOLS","102 PROCESSING","103 EARLY_HINTS","200 OK","201 CREATED","202 ACCEPTED","203 NON_AUTHORITATIVE_INFORMATION","204 NO_CONTENT","205 RESET_CONTENT","206 PARTIAL_CONTENT","207 MULTI_STATUS","208 ALREADY_REPORTED","226 IM_USED","300 MULTIPLE_CHOICES","301 MOVED_PERMANENTLY","302 FOUND","303 SEE_OTHER","304 NOT_MODIFIED","307 TEMPORARY_REDIRECT","308 PERMANENT_REDIRECT","400 BAD_REQUEST","401 UNAUTHORIZED","402 PAYMENT_REQUIRED","403 FORBIDDEN","404 NOT_FOUND","405 METHOD_NOT_ALLOWED","406 NOT_ACCEPTABLE","407 PROXY_AUTHENTICATION_REQUIRED","408 REQUEST_TIMEOUT","409 CONFLICT","410 GONE","411 LENGTH_REQUIRED","412 PRECONDITION_FAILED","413 CONTENT_TOO_LARGE","413 PAYLOAD_TOO_LARGE","414 URI_TOO_LONG","415 UNSUPPORTED_MEDIA_TYPE","416 REQUESTED_RANGE_NOT_SATISFIABLE","417 EXPECTATION_FAILED","418 I_AM_A_TEAPOT","421 MISDIRECTED_REQUEST","422 UNPROCESSABLE_CONTENT","422 UNPROCESSABLE_ENTITY","423 LOCKED","424 FAILED_DEPENDENCY","425 TOO_EARLY","426 UPGRADE_REQUIRED","428 PRECONDITION_REQUIRED","429 TOO_MANY_REQUESTS","431 REQUEST_HEADER_FIELDS_TOO_LARGE","451 UNAVAILABLE_FOR_LEGAL_REASONS","500 INTERNAL_SERVER_ERROR","501 NOT_IMPLEMENTED","502 BAD_GATEWAY","503 SERVICE_UNAVAILABLE","504 GATEWAY_TIMEOUT","505 HTTP_VERSION_NOT_SUPPORTED","506 VARIANT_ALSO_NEGOTIATES","507 INSUFFICIENT_STORAGE","508 LOOP_DETECTED","509 BANDWIDTH_LIMIT_EXCEEDED","510 NOT_EXTENDED","511 NETWORK_AUTHENTICATION_REQUIRED"]},"HttpStatusCode":{"type":"object","properties":{"error":{"type":"boolean"},"is1xxInformational":{"type":"boolean"},"is2xxSuccessful":{"type":"boolean"},"is3xxRedirection":{"type":"boolean"},"is4xxClientError":{"type":"boolean"},"is5xxServerError":{"type":"boolean"}}},"ModelAndView":{"type":"object","properties":{"view":{"$ref":"#/components/schemas/View"},"model":{"type":"object","additionalProperties":{}},"status":{"oneOf":[{"$ref":"#/components/schemas/DefaultHttpStatusCode"},{"$ref":"#/components/schemas/HttpStatus"}]},"modelMap":{"type":"object","additionalProperties":{},"properties":{"empty":{"type":"boolean"}}},"reference":{"type":"boolean"},"empty":{"type":"boolean"},"viewName":{"type":"string"}}},"View":{"type":"object","properties":{"contentType":{"type":"string"}}},"BasicContact":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}}},"Task":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"priority":{"type":"integer","format":"int32"},"completed":{"type":"boolean"},"contact":{"$ref":"#/components/schemas/BasicContact"},"url":{"type":"string"},"due_date":{"type":"string","format":"date-time"},"creation_date":{"type":"string","format":"date-time"},"modification_date":{"type":"string","format":"date-time"},"completion_date":{"type":"string","format":"date-time"},"remind_time":{"type":"integer","format":"int32","description":"Value in minutes before start_date to show pop-up reminder.  \nAcceptable values are in [`5`,`10`,`15`,`30`,`60`,`120`,`240`,`480`,`1440`,`2880`]"},"user_id":{"type":"integer","format":"int64"},"funnel_id":{"type":"integer","format":"int64"},"jgraph_id":{"type":"integer","format":"int64"}}},"PaymentGatewayV1":{"type":"object","properties":{"merchant_account_id":{"type":"integer","format":"int64"},"use_default":{"type":"boolean"}}},"RestPaymentPlan":{"type":"object","properties":{"auto_charge":{"type":"boolean"},"credit_card_id":{"type":"integer","format":"int64"},"payment_gateway":{"$ref":"#/components/schemas/PaymentGatewayV1"},"initial_payment_amount":{"type":"number","format":"double"},"initial_payment_date":{"type":"string","format":"date"},"plan_start_date":{"type":"string","format":"date"},"number_of_payments":{"type":"integer","format":"int32"},"days_between_payments":{"type":"integer","format":"int32"}},"required":["days_between_payments","number_of_payments","plan_start_date"]},"CheckListItemDetails":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"description":{"type":"string"},"required":{"type":"boolean"},"instance_id":{"type":"integer","format":"int64"},"item_order":{"type":"integer","format":"int32"},"done_date":{"type":"string","format":"date-time"}}},"CustomFieldValue":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"content":{}}},"OpportunityContact":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":0},"email":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"company_name":{"type":"string"},"job_title":{"type":"string"},"phone_number":{"type":"string"}},"required":["id"]},"SimpleOpportunityStage":{"type":"object","properties":{"id":{"type":"integer","format":"int64","example":0},"name":{"type":"string"},"details":{"$ref":"#/components/schemas/StageDetails"},"reasons":{"type":"array","items":{"type":"string"}}},"required":["id"]},"SimpleUser":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"first_name":{"type":"string"},"last_name":{"type":"string"}}},"StageDetails":{"type":"object","properties":{"probability":{"type":"integer","format":"int32"},"stage_order":{"type":"integer","format":"int32"},"target_num_days":{"type":"integer","format":"int32"},"check_list_items":{"type":"array","items":{"$ref":"#/components/schemas/CheckListItemDetails"}}}},"UpdateOpportunityRequest":{"type":"object","description":"opportunity","properties":{"id":{"type":"integer","format":"int64"},"contact":{"$ref":"#/components/schemas/OpportunityContact"},"stage":{"$ref":"#/components/schemas/SimpleOpportunityStage"},"user":{"$ref":"#/components/schemas/SimpleUser"},"opportunity_title":{"type":"string"},"next_action_date":{"type":"string"},"next_action_notes":{"type":"string"},"opportunity_notes":{"type":"string"},"estimated_close_date":{"type":"string"},"include_in_forecast":{"type":"integer","format":"int32"},"projected_revenue_low":{"type":"number","format":"double"},"projected_revenue_high":{"type":"number","format":"double"},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldValue"}},"date_created":{"type":"string","format":"date-time"},"last_updated":{"type":"string","format":"date-time"},"affiliate_id":{"type":"integer","format":"int64"}},"required":["contact","opportunity_title","stage"]},"Opportunity":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"contact":{"$ref":"#/components/schemas/OpportunityContact"},"stage":{"$ref":"#/components/schemas/SimpleOpportunityStage"},"user":{"$ref":"#/components/schemas/SimpleUser"},"opportunity_title":{"type":"string"},"next_action_date":{"type":"string","format":"date-time"},"next_action_notes":{"type":"string"},"opportunity_notes":{"type":"string"},"estimated_close_date":{"type":"string","format":"date-time"},"include_in_forecast":{"type":"integer","format":"int32"},"projected_revenue_low":{"type":"number","format":"double"},"projected_revenue_high":{"type":"number","format":"double"},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldValue"}},"date_created":{"type":"string","format":"date-time"},"last_updated":{"type":"string","format":"date-time"},"affiliate_id":{"type":"integer","format":"int64"}},"required":["contact","opportunity_title","stage"]},"RequestNote":{"type":"object","properties":{"title":{"type":"string"},"body":{"type":"string"},"type":{"type":"string","enum":["Appointment, Call, Email, Fax, Letter, Other"]},"contact_id":{"type":"integer","format":"int64"},"user_id":{"type":"integer","format":"int64"}},"required":["contact_id"]},"Note":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"title":{"type":"string"},"body":{"type":"string"},"type":{"type":"string","enum":["Appointment, Call, Email, Fax, Letter, Other"]},"contact_id":{"type":"integer","format":"int64"},"user_id":{"type":"integer","format":"int64"},"last_updated_by":{"$ref":"#/components/schemas/NoteUser"},"date_created":{"type":"string","format":"date-time"},"last_updated":{"type":"string","format":"date-time"}}},"NoteUser":{"type":"object","properties":{"user_id":{"type":"integer","format":"int64"},"given_name":{"type":"string"},"family_name":{"type":"string"}}},"RestHookRequest":{"type":"object","properties":{"eventKey":{"type":"string"},"hookUrl":{"type":"string"}}},"RestHook":{"type":"object","properties":{"key":{"type":"string"},"eventKey":{"type":"string"},"hookUrl":{"type":"string"},"status":{"type":"string","enum":["Unverified","Verified","Inactive"]}}},"FileUpload":{"type":"object","description":"fileUpload","properties":{"file_name":{"type":"string","writeOnly":true},"file_data":{"type":"string","writeOnly":true},"contact_id":{"type":"integer","format":"int64","writeOnly":true},"is_public":{"type":"boolean","writeOnly":true},"file_association":{"type":"string","enum":["CONTACT","USER","COMPANY"],"writeOnly":true},"public":{"type":"boolean"}}},"FileDescriptor":{"type":"object","properties":{"category":{"type":"string","enum":["Attachments","Cart","Documents","Hidden","Invoice","Logo","Tickets","WebForm","Funnel"]},"date_created":{"type":"string","format":"date-time"},"last_updated":{"type":"string","format":"date-time"},"file_name":{"type":"string"},"file_size":{"type":"integer","format":"int64"},"created_by":{"type":"integer","format":"int64"},"public":{"type":"boolean"},"contact_id":{"type":"integer","format":"int64"},"remote_file_key":{"type":"string"},"file_box_type":{"type":"string","enum":["Application","Image","Fax","Attachment","Ticket","Contact","DigitalProduct","Import","Hidden","WebForm","StyledCart","ReSampledImage","TemplateThumbnail","Funnel","LogoThumbnail","Unlayer","BrandingCenterLogo"]},"download_url":{"type":"string"}}},"FileInformation":{"type":"object","properties":{"file_descriptor":{"$ref":"#/components/schemas/FileDescriptor"},"file_data":{"type":"string"}}},"UpdateEmailAddress":{"type":"object","properties":{"reason":{"type":"string"},"opted_in":{"type":"boolean"}},"required":["opted_in","reason"]},"RestEmailAddress":{"type":"object","properties":{"email":{"type":"string"},"opted_in":{"type":"boolean"},"status":{"type":"string","enum":["Unengaged Marketable","Unconfirmed","Confirmed (Legacy)","Confirmed","Unengaged NonMarketable","Non-marketable","Lockdown","Soft Bounce","Hard Bounce","Opt-Out","Opt-Out: Admin","Opt-Out: System","List Unsubscribe","Provided Feedback","Reported Spam","Invalid Email","Deactivated/Delinquent Mailbox"]}},"required":["email","opted_in","status"]},"CompanyReference":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"company_name":{"type":"string"}}},"ContactAddress":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"locality":{"type":"string"},"region":{"type":"string"},"field":{"type":"string","enum":["BILLING","SHIPPING","OTHER"]},"postal_code":{"type":"string","description":"Field used to store postal codes containing a combination of letters and numbers ex. 'EC1A', 'S1 2HE', '75000'"},"zip_code":{"type":"string","description":"Mainly used in the United States, this is typically numeric. ex. '85001', '90002' Note: this is to be used instead of 'postal_code', not in addition to."},"zip_four":{"type":"string","description":"Last four of a full zip code ex. '8244', '4320'. This field is supplemental to the zip_code field, otherwise will be ignored."},"country_code":{"type":"string"}},"required":["field"]},"ContactOrigin":{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"ip_address":{"type":"string"}},"required":["date","ip_address"]},"CreateContactOrigin":{"type":"object","properties":{"ip_address":{"type":"string"}},"required":["ip_address"]},"CreateOrPatchContact":{"allOf":[{"$ref":"#/components/schemas/RestContactBase"},{"type":"object","properties":{"company":{"$ref":"#/components/schemas/RequestCompanyReference"},"origin":{"$ref":"#/components/schemas/CreateContactOrigin"},"opt_in_reason":{"type":"string"}}}],"description":"contact"},"EmailAddress":{"type":"object","properties":{"email":{"type":"string"},"field":{"type":"string","enum":["EMAIL1","EMAIL2","EMAIL3"]}},"required":["field"]},"FaxNumber":{"type":"object","properties":{"number":{"type":"string"},"field":{"type":"string","enum":["FAX1","FAX2"]},"type":{"type":"string"}},"required":["field"]},"FullContact":{"allOf":[{"$ref":"#/components/schemas/RestContact"},{"type":"object","properties":{"origin":{"$ref":"#/components/schemas/ContactOrigin"},"relationships":{"type":"array","items":{"$ref":"#/components/schemas/Relationship"}},"company_name":{"type":"string"},"opt_in_reason":{"type":"string"},"tag_ids":{"type":"array","items":{"type":"integer","format":"int64"}}}}]},"PhoneNumber":{"type":"object","properties":{"number":{"type":"string"},"extension":{"type":"string"},"field":{"type":"string","enum":["PHONE1","PHONE2","PHONE3","PHONE4","PHONE5"]},"type":{"type":"string"},"number_e164":{"type":"string"}},"required":["field"]},"Relationship":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"linked_contact_id":{"type":"integer","format":"int64"},"relationship_type_id":{"type":"integer","format":"int64"}}},"RequestCompanyReference":{"type":"object","properties":{"id":{"type":"integer","format":"int64"}}},"RestContact":{"allOf":[{"$ref":"#/components/schemas/RestContactBase"}]},"RestContactBase":{"type":"object","properties":{"addresses":{"type":"array","items":{"$ref":"#/components/schemas/ContactAddress"}},"birthday":{"type":"string","format":"date-time"},"prefix":{"type":"string"},"suffix":{"type":"string"},"website":{"type":"string"},"anniversary":{"type":"string","format":"date-time"},"email_addresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddress"}},"phone_numbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"}},"fax_numbers":{"type":"array","items":{"$ref":"#/components/schemas/FaxNumber"}},"social_accounts":{"type":"array","items":{"$ref":"#/components/schemas/SocialAccount"}},"contact_type":{"type":"string"},"lead_source_id":{"type":"integer","format":"int64"},"given_name":{"type":"string"},"family_name":{"type":"string"},"middle_name":{"type":"string"},"preferred_name":{"type":"string"},"time_zone":{"type":"string"},"owner_id":{"type":"integer","format":"int64"},"job_title":{"type":"string"},"preferred_locale":{"type":"string","example":"en_US"},"source_type":{"type":"string","enum":["APPOINTMENT","FORMAPIHOSTED","FORMAPIINTERNAL","WEBFORM","INTERNALFORM","LANDINGPAGE","IMPORT","MANUAL","API","OTHER","UNKNOWN"]},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldValue"}},"spouse_name":{"type":"string"}}},"RestPartialContact":{"allOf":[{"$ref":"#/components/schemas/RestContact"},{"type":"object","properties":{"addresses":{"type":"array","items":{"$ref":"#/components/schemas/ContactAddress"}},"birthday":{"type":"string","format":"date-time"},"prefix":{"type":"string"},"suffix":{"type":"string"},"website":{"type":"string"},"anniversary":{"type":"string","format":"date-time"},"id":{"type":"integer","format":"int64"},"company":{"$ref":"#/components/schemas/CompanyReference"},"email_addresses":{"type":"array","items":{"$ref":"#/components/schemas/EmailAddress"}},"phone_numbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"}},"fax_numbers":{"type":"array","items":{"$ref":"#/components/schemas/FaxNumber"}},"social_accounts":{"type":"array","items":{"$ref":"#/components/schemas/SocialAccount"}},"contact_type":{"type":"string"},"lead_source_id":{"type":"integer","format":"int64"},"given_name":{"type":"string"},"family_name":{"type":"string"},"middle_name":{"type":"string"},"preferred_name":{"type":"string"},"time_zone":{"type":"string"},"owner_id":{"type":"integer","format":"int64"},"job_title":{"type":"string"},"preferred_locale":{"type":"string","example":"en_US"},"source_type":{"type":"string","enum":["APPOINTMENT","FORMAPIHOSTED","FORMAPIINTERNAL","WEBFORM","INTERNALFORM","LANDINGPAGE","IMPORT","MANUAL","API","OTHER","UNKNOWN"]},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldValue"}},"spouse_name":{"type":"string"},"email_opted_in":{"type":"boolean"},"email_status":{"type":"string","enum":["UnengagedMarketable","SingleOptIn","DoubleOptin","Confirmed","UnengagedNonMarketable","NonMarketable","Lockdown","Bounce","HardBounce","Manual","Admin","System","ListUnsubscribe","Feedback","Spam","Invalid","Deactivated"]},"date_created":{"type":"string","format":"date-time"},"last_updated":{"type":"string","format":"date-time"},"ScoreValue":{"type":"string"},"company_name":{"type":"string"}}}]},"SocialAccount":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","enum":["Facebook","Twitter","LinkedIn","Instagram","Snapchat","YouTube","Pinterest"]}}},"UpsertContact":{"allOf":[{"$ref":"#/components/schemas/CreateOrPatchContact"}]},"Appointment":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"user":{"type":"integer","format":"int64","description":"Required only for pop-up reminders"},"location":{"type":"string"},"contact_id":{"type":"integer","format":"int64","description":"Required for pop-up reminders"},"start_date":{"type":"string","format":"date-time","example":"2024-01-15T09:00:00.000Z"},"end_date":{"type":"string","format":"date-time","example":"2024-01-15T10:00:00.000Z"},"remind_time":{"type":"integer","format":"int32","description":"Value in minutes before start_date to show pop-up reminder.","enum":["5","10","15","30","60","120","240","480","1440","2880"],"example":30}},"required":["end_date","start_date","title"]},"AccountProfile":{"type":"object","description":"Information about the company that owns/uses this account","properties":{"name":{"type":"string"},"email":{"type":"string"},"website":{"type":"string"},"phone":{"type":"string"},"address":{"$ref":"#/components/schemas/ContactAddress"},"phone_ext":{"type":"string"},"time_zone":{"type":"string"},"logo_url":{"type":"string"},"currency_code":{"type":"string"},"language_tag":{"type":"string"},"business_type":{"type":"string","description":"The type of business"},"business_goals":{"type":"array","description":"The goals of this business, ie. Grow Business, Convert more leads","items":{"type":"string"}},"business_primary_color":{"type":"string"},"business_secondary_color":{"type":"string"}}},"CreateUser":{"type":"object","description":"user","properties":{"email":{"type":"string"},"partner":{"type":"boolean"},"admin":{"type":"boolean"},"given_name":{"type":"string"}},"required":["email","given_name"]},"Address":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"locality":{"type":"string"},"region":{"type":"string"},"zip_code":{"type":"string"},"zip_four":{"type":"string"},"country_code":{"type":"string"}}},"RestUser":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"website":{"type":"string"},"partner":{"type":"boolean"},"status":{"type":"string","enum":["Active","Invited","Inactive"]},"company_name":{"type":"string"},"email_address":{"type":"string"},"phone_numbers":{"type":"array","items":{"$ref":"#/components/schemas/PhoneNumber"}},"fax_numbers":{"type":"array","items":{"$ref":"#/components/schemas/FaxNumber"}},"given_name":{"type":"string"},"family_name":{"type":"string"},"middle_name":{"type":"string"},"preferred_name":{"type":"string"},"time_zone":{"type":"string"},"job_title":{"type":"string"},"infusionsoft_id":{"type":"string"},"date_created":{"type":"string","format":"date-time"},"created_by":{"type":"integer","format":"int64"},"last_updated":{"type":"string","format":"date-time"},"last_updated_by":{"type":"integer","format":"int64"},"global_user_id":{"type":"integer","format":"int64"},"id":{"type":"integer","format":"int64"}},"required":["id"]},"CreateRestCustomField":{"type":"object","properties":{"label":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/CreateRestCustomFieldOption"}},"field_type":{"type":"string","enum":["Currency","Date","DateTime","DayOfWeek","Drilldown","Email","Month","ListBox","Name","WholeNumber","DecimalNumber","Percent","PhoneNumber","Radio","Dropdown","SocialSecurityNumber","State","Text","TextArea","User","UserListBox","Website","Year","YesNo"]},"group_id":{"type":"integer","format":"int64","description":"An optional tab group to place the field under in the interface.  If not specified, will default to the 'Custom Fields' tab."},"user_group_id":{"type":"integer","format":"int64","description":"An optional user group to choose from when selecting values for User or UserListBox fields."}},"required":["field_type","label"]},"CreateRestCustomFieldOption":{"type":"object","properties":{"label":{"type":"string"}}},"CustomFieldMetaData":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"label":{"type":"string"},"options":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldOption"}},"record_type":{"type":"string","enum":["CONTACT","REFERRAL_PARTNER","OPPORTUNITY","TASK_NOTE_APPOINTMENT","COMPANY","ORDER","SUBSCRIPTION"]},"field_type":{"type":"string","enum":["Currency","Date","DateTime","DayOfWeek","Drilldown","Email","Month","ListBox","Name","WholeNumber","DecimalNumber","Percent","PhoneNumber","Radio","Dropdown","SocialSecurityNumber","State","Text","TextArea","User","UserListBox","Website","Year","YesNo"]},"field_name":{"type":"string"},"default_value":{"type":"string"}}},"CustomFieldOption":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"}}},"SetOfIds":{"type":"object","properties":{"ids":{"type":"array","items":{"type":"integer","format":"int64"},"properties":{"empty":{"type":"boolean"}},"uniqueItems":true}},"required":["ids"]},"CreateTagCategory":{"type":"object","properties":{"name":{"type":"string","description":"The category name"},"description":{"type":"string","description":"The category description"}},"required":["name"]},"TagCategory":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The id for the tag category"},"name":{"type":"string","description":"The category name"},"description":{"type":"string","description":"The category description"}},"required":["id","name"]},"CategoryReference":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The id for the tag category"}},"required":["id"]},"CreateTag":{"type":"object","properties":{"name":{"type":"string","description":"The tag name"},"description":{"type":"string","description":"The tag description"},"category":{"$ref":"#/components/schemas/CategoryReference","description":"The tag category reference"}},"required":["name"]},"Tag":{"type":"object","properties":{"id":{"type":"integer","format":"int64","description":"The id for the tag"},"name":{"type":"string","description":"The tag name"},"description":{"type":"string","description":"The tag description"},"category":{"$ref":"#/components/schemas/TagCategory","description":"The tag category reference"}},"required":["id","name"]},"CreateSubscription":{"type":"object","properties":{"quantity":{"type":"integer","format":"int32","description":"Must be greater than 0. Default is 1."},"contact_id":{"type":"integer","format":"int64"},"subscription_plan_id":{"type":"integer","format":"int64","description":"Id of the product subscription."},"allow_duplicate":{"type":"boolean","description":"If true, it will disable the check to see if there is already an identical subscription for the contact. Default is false."},"billing_amount":{"type":"number","format":"double","description":"Must be 0 or greater. Default is the price in the product subscription."},"first_bill_date":{"type":"string","format":"date","description":"The first day the subscription will bill, in EST. Must not be in the past. Default is today."},"auto_charge":{"type":"boolean","description":"Defaults to true."},"credit_card_id":{"type":"integer","format":"int64","description":"Default is the contact's most recently used card, if auto charge is true. Default is 0 otherwise."},"payment_gateway_id":{"type":"integer","format":"int64","description":"Default is the app's default merchant."},"allow_tax":{"type":"boolean","description":"Only works if the product the product subscription is for is taxable. Default is false."},"sale_affiliate_id":{"type":"integer","format":"int64"}},"required":["contact_id","subscription_plan_id"]},"Subscription":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"quantity":{"type":"integer","format":"int64"},"active":{"type":"boolean"},"contact_id":{"type":"integer","format":"int64"},"product_id":{"type":"integer","format":"int64"},"subscription_plan_id":{"type":"integer","format":"int64"},"billing_amount":{"type":"number","format":"double"},"auto_charge":{"type":"boolean"},"billing_frequency":{"type":"integer","format":"int32"},"billing_cycle":{"type":"string","enum":["YEAR","MONTH","WEEK","DAY"]},"start_date":{"type":"string","format":"date"},"next_bill_date":{"type":"string","format":"date"},"end_date":{"type":"string","format":"date"},"payment_gateway_id":{"type":"integer","format":"int64"},"credit_card_id":{"type":"integer","format":"int64"},"use_default_payment_gateway":{"type":"boolean"},"allow_tax":{"type":"boolean"},"sale_affiliate_id":{"type":"integer","format":"int64"}}},"CreateProductSubscription":{"type":"object","properties":{"frequency":{"type":"integer","format":"int32"},"active":{"type":"boolean"},"cycle_type":{"type":"string","enum":["YEAR","MONTH","WEEK","DAY"]},"plan_price":{"type":"number","format":"double"},"number_of_cycles":{"type":"integer","format":"int32"},"subscription_plan_index":{"type":"integer","format":"int32"}},"required":["cycle_type","plan_price"]},"ProductSubscription":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"frequency":{"type":"integer","format":"int32"},"active":{"type":"boolean"},"url":{"type":"string"},"cycle_type":{"type":"string","enum":["YEAR","MONTH","WEEK","DAY"]},"plan_price":{"type":"number","format":"double"},"subscription_plan_name":{"type":"string"},"number_of_cycles":{"type":"integer","format":"int32"},"subscription_plan_index":{"type":"integer","format":"int32"}},"required":["cycle_type","id","plan_price"]},"ContentDisposition":{"type":"object","properties":{"type":{"type":"string"},"name":{"type":"string"},"filename":{"type":"string"},"charset":{"type":"string"},"inline":{"type":"boolean"},"formData":{"type":"boolean"},"attachment":{"type":"boolean"}}},"HttpHeaders":{"type":"object","properties":{"accept":{"type":"array","items":{"$ref":"#/components/schemas/MediaType"}},"bearerAuth":{"type":"string","writeOnly":true},"basicAuth":{"type":"string","writeOnly":true},"allow":{"type":"array","items":{"$ref":"#/components/schemas/HttpMethod"},"uniqueItems":true},"cacheControl":{"type":"string"},"acceptLanguage":{"type":"array","items":{"type":"object","properties":{"range":{"type":"string"},"weight":{"type":"number","format":"double"}}}},"acceptLanguageAsLocales":{"type":"array","items":{"type":"string"}},"acceptPatch":{"type":"array","items":{"$ref":"#/components/schemas/MediaType"}},"accessControlAllowCredentials":{"type":"boolean"},"accessControlAllowHeaders":{"type":"array","items":{"type":"string"}},"accessControlAllowMethods":{"type":"array","items":{"$ref":"#/components/schemas/HttpMethod"}},"accessControlAllowOrigin":{"type":"string"},"accessControlExposeHeaders":{"type":"array","items":{"type":"string"}},"accessControlMaxAge":{"type":"integer","format":"int64"},"accessControlRequestHeaders":{"type":"array","items":{"type":"string"}},"accessControlRequestMethod":{"$ref":"#/components/schemas/HttpMethod"},"acceptCharset":{"type":"array","items":{"type":"string"}},"contentDisposition":{"$ref":"#/components/schemas/ContentDisposition"},"contentLanguage":{"type":"string"},"etag":{"type":"string"},"expires":{"type":"integer","format":"int64"},"ifMatch":{"type":"array","items":{"type":"string"}},"ifNoneMatch":{"type":"array","items":{"type":"string"}},"ifUnmodifiedSince":{"type":"integer","format":"int64"},"pragma":{"type":"string"},"upgrade":{"type":"string"},"vary":{"type":"array","items":{"type":"string"}},"host":{"type":"object","properties":{"hostString":{"type":"string"},"address":{"type":"object","properties":{"hostAddress":{"type":"string"},"address":{"type":"string","format":"byte"},"hostName":{"type":"string"},"linkLocalAddress":{"type":"boolean"},"multicastAddress":{"type":"boolean"},"anyLocalAddress":{"type":"boolean"},"loopbackAddress":{"type":"boolean"},"siteLocalAddress":{"type":"boolean"},"mcglobal":{"type":"boolean"},"mcnodeLocal":{"type":"boolean"},"mclinkLocal":{"type":"boolean"},"mcsiteLocal":{"type":"boolean"},"mcorgLocal":{"type":"boolean"},"canonicalHostName":{"type":"string"}}},"port":{"type":"integer","format":"int32"},"unresolved":{"type":"boolean"},"hostName":{"type":"string"}}},"empty":{"type":"boolean"},"location":{"type":"string","format":"uri"},"all":{"type":"object","additionalProperties":{"type":"string"},"writeOnly":true},"lastModified":{"type":"integer","format":"int64"},"date":{"type":"integer","format":"int64"},"contentLength":{"type":"integer","format":"int64"},"contentType":{"$ref":"#/components/schemas/MediaType"},"ifModifiedSince":{"type":"integer","format":"int64"},"range":{"type":"array","items":{"$ref":"#/components/schemas/HttpRange"}},"connection":{"type":"array","items":{"type":"string"}},"origin":{"type":"string"}}},"HttpMethod":{},"HttpRange":{},"MediaType":{"type":"object","properties":{"type":{"type":"string"},"subtype":{"type":"string"},"parameters":{"type":"object","additionalProperties":{"type":"string"}},"qualityValue":{"type":"number","format":"double"},"wildcardType":{"type":"boolean"},"wildcardSubtype":{"type":"boolean"},"subtypeSuffix":{"type":"string"},"charset":{"type":"string"},"concrete":{"type":"boolean"}}},"CreateProductImage":{"type":"object","properties":{"file_name":{"type":"string","description":"The name of the file with extension, must match file data.  Acceptable file types:  [.png, .gif, .jpg, .jpeg]."},"file_data":{"type":"string","description":"The image data, base64 encoded."},"checksum":{"type":"string","description":"SHA256 checksum of image in Hex."}},"required":["file_data","file_name"]},"CreateProduct":{"type":"object","properties":{"sku":{"type":"string"},"active":{"type":"boolean"},"product_name":{"type":"string"},"product_desc":{"type":"string"},"product_price":{"type":"number","format":"double"},"product_short_desc":{"type":"string"},"subscription_only":{"type":"boolean"}},"required":["product_name"]},"RestProductV1":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"sku":{"type":"string"},"active":{"type":"boolean"},"url":{"type":"string"},"product_name":{"type":"string"},"product_desc":{"type":"string"},"product_price":{"type":"number","format":"double"},"product_short_desc":{"type":"string"},"subscription_only":{"type":"boolean"},"subscription_plans":{"type":"array","items":{"$ref":"#/components/schemas/ProductSubscription"}}},"required":["id","product_name"]},"CreatePayment":{"type":"object","properties":{"date":{"type":"string","format":"date-time","description":"Used when charge_now:false or inserting historical data. ex `2017-01-01T22:17:59.039Z`"},"notes":{"type":"string"},"apply_to_commissions":{"type":"boolean"},"charge_now":{"type":"boolean"},"credit_card_id":{"type":"integer","format":"int64"},"payment_amount":{"type":"string"},"payment_method_type":{"type":"string","enum":["CREDIT_CARD","CASH","CHECK","TOKEN"]},"payment_gateway_id":{"type":"string"}}},"PaymentResult":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"invoice_id":{"type":"integer","format":"int64"},"payment_amount":{"type":"number","format":"double"},"payment_status":{"type":"string"},"transaction_id":{"type":"integer","format":"int64"}}},"CreateOrderItem":{"type":"object","properties":{"description":{"type":"string"},"price":{"type":"string","description":"Overridable price of the product, if not specified, the default will be used. Must be greater than or equal to 0."},"quantity":{"type":"integer","format":"int32","description":"Quantity must be greater than or equal to 1"},"product_id":{"type":"integer","format":"int64","description":"The id of the product to be added to the order."},"item_type":{"type":"string","enum":["UNKNOWN","SHIPPING","TAX","SERVICE","PRODUCT","UPSELL","FINANCE_CHARGE","SPECIAL","PROGRAM","SUBSCRIPTION","SPECIAL_FREE_TRIAL_DAYS","SPECIAL_ORDER_TOTAL","SPECIAL_PRODUCT","SPECIAL_CATEGORY","SPECIAL_SHIPPING","TIP","OTHER","FEE"]}},"required":["product_id","quantity"]},"OrderItem":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"notes":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"cost":{"type":"number","format":"double"},"price":{"type":"number","format":"double"},"discount":{"type":"number","format":"double"},"product":{"$ref":"#/components/schemas/Product_"},"specialId":{"type":"integer","format":"int64"},"specialAmount":{"type":"number","format":"double"},"specialPctOrAmt":{"type":"integer","format":"int32"},"orderItemTaxes":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemTax"}},"recurringBilling":{"type":"boolean"},"frequency":{"type":"integer","format":"int32"},"billingCycle":{"type":"integer","format":"int32"},"numberOfPayments":{"type":"integer","format":"int32"},"jobRecurringId":{"type":"integer","format":"int64"},"recurringStartDate":{"type":"string"},"recurringNextBillDate":{"type":"string"},"recurringEndDate":{"type":"string"},"recurringCyclesCompleted":{"type":"integer","format":"int32"},"recurringInactive":{"type":"boolean"}}},"OrderItemTax":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"orderItemId":{"type":"integer","format":"int64"},"name":{"type":"string"},"rate":{"type":"number","format":"double"},"taxTemplateId":{"type":"integer","format":"int64"},"amount":{"type":"number","format":"double"}}},"ProductOption":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"label":{"type":"string"},"required":{"type":"boolean"},"type":{"type":"string","enum":["FixedList","Variable"]},"values":{"type":"array","items":{"$ref":"#/components/schemas/ProductOptionValue"}},"min_chars":{"type":"integer","format":"int32"},"max_chars":{"type":"integer","format":"int32"},"allow_spaces":{"type":"boolean"},"can_end_with_character":{"type":"boolean"},"can_end_with_number":{"type":"boolean"},"can_contain_character":{"type":"boolean"},"can_contain_number":{"type":"boolean"},"can_start_with_character":{"type":"boolean"},"can_start_with_number":{"type":"boolean"},"text_message":{"type":"string"},"display_index":{"type":"integer","format":"int32"}}},"ProductOptionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"label":{"type":"string"},"sku":{"type":"string"},"index":{"type":"integer","format":"int64"},"is_default":{"type":"boolean"},"price_adjustment":{"type":"number","format":"double"}}},"Product_":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"sku":{"type":"string"},"url":{"type":"string"},"status":{"type":"integer","format":"int32"},"product_name":{"type":"string"},"product_desc":{"type":"string"},"product_price":{"type":"number","format":"double"},"product_short_desc":{"type":"string"},"subscription_only":{"type":"boolean"},"product_options":{"type":"array","items":{"$ref":"#/components/schemas/ProductOption"}},"subscription_plans":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionPlan_"}}}},"SubscriptionPlan_":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"cycle":{"type":"integer","format":"int32"},"frequency":{"type":"integer","format":"int32"},"url":{"type":"string"},"active":{"type":"boolean"},"subscription_plan_name":{"type":"string"},"number_of_cycles":{"type":"integer","format":"int32"},"plan_price":{"type":"number","format":"double"},"subscription_plan_index":{"type":"integer","format":"int32"}}},"CreateOrder":{"type":"object","properties":{"contact_id":{"type":"integer","format":"int64"},"order_items":{"type":"array","items":{"$ref":"#/components/schemas/CreateOrderItem"}},"order_title":{"type":"string"},"order_date":{"type":"string","format":"date-time"},"order_type":{"type":"string","enum":["Offline","Online"]},"promo_codes":{"type":"array","description":"Uses multiple strings as promo codes. The corresponding discount will be applied to the order.","items":{"type":"string"}},"lead_affiliate_id":{"type":"integer","format":"int64"},"sales_affiliate_id":{"type":"integer","format":"int64"},"shipping_address":{"$ref":"#/components/schemas/RestV1AddressInformation"}},"required":["contact_id","order_date","order_items","order_title","order_type"]},"RestV1AddressInformation":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"locality":{"type":"string"},"region":{"type":"string"},"company":{"type":"string"},"phone":{"type":"string"},"zip_code":{"type":"string"},"zip_four":{"type":"string"},"country_code":{"type":"string"},"first_name":{"type":"string"},"middle_name":{"type":"string"},"last_name":{"type":"string"},"is_invoice_to_company":{"type":"boolean"}}},"EcommerceReportingOrderContactDetails":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"company_name":{"type":"string"},"job_title":{"type":"string"}}},"Order":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"title":{"type":"string"},"status":{"type":"string"},"total":{"type":"number","format":"double"},"contact":{"$ref":"#/components/schemas/EcommerceReportingOrderContactDetails"},"notes":{"type":"string"},"creation_date":{"type":"string"},"modification_date":{"type":"string"},"order_date":{"type":"string"},"lead_affiliate_id":{"type":"integer","format":"int64"},"sales_affiliate_id":{"type":"integer","format":"int64"},"total_due":{"type":"number","format":"double"},"total_paid":{"type":"number","format":"double"},"shipping_information":{"$ref":"#/components/schemas/RestV1AddressInformation"},"refund_total":{"type":"number","format":"double"},"order_items":{"type":"array","items":{"$ref":"#/components/schemas/OrderItem"}},"payment_plan":{"$ref":"#/components/schemas/RestPaymentPlan"}}},"EmailSentCreate":{"type":"object","description":"Email records to persist, with content.","properties":{"id":{"type":"integer","format":"int64"},"subject":{"type":"string"},"headers":{"type":"string"},"contact_id":{"type":"integer","format":"int64"},"sent_to_address":{"type":"string"},"sent_to_cc_addresses":{"type":"string"},"sent_to_bcc_addresses":{"type":"string"},"sent_from_address":{"type":"string"},"sent_from_reply_address":{"type":"string"},"sent_date":{"type":"string","format":"date-time"},"received_date":{"type":"string","format":"date-time"},"opened_date":{"type":"string","format":"date-time"},"clicked_date":{"type":"string","format":"date-time"},"plain_content":{"type":"string","description":"Base64 encoded text"},"html_content":{"type":"string","description":"Base64 encoded HTML"},"original_provider":{"type":"string","description":"Provider that sent the email case insensitive, must be in list [GOOGLE, INFUSIONSOFT].  If omitted gets mapped to UNKNOWN.","enum":["UNKNOWN","INFUSIONSOFT","MICROSOFT","GOOGLE"]},"original_provider_id":{"type":"string","description":"Provider id that sent the email, must be unique when combined with provider.  If omitted a UUID without dashes is autogenerated for the record."},"provider_source_id":{"type":"string","description":"The email address of the synced email account that generated this message."}},"required":["sent_to_address"]},"EmailSentCreateListRequest":{"type":"object","description":"Email records to persist, with content.","properties":{"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailSentCreate"}}}},"EmailSentCreateError":{"type":"object","properties":{"error_message":{"type":"string"},"email":{"$ref":"#/components/schemas/EmailSentCreate"}}},"EmailSentCreateListResponse":{"type":"object","properties":{"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailSentCreate"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/EmailSentCreateError"}}}},"EmailSendRequest":{"type":"object","properties":{"contacts":{"type":"array","description":"An array of Contact Ids to receive the email","items":{"type":"integer","format":"int64"}},"subject":{"type":"string","description":"The subject line of the email"},"attachments":{"type":"array","description":"Attachments to be sent with each copy of the email, maximum of 10 with size of 1MB each","items":{"$ref":"#/components/schemas/EmailSendRequestAttachment"},"uniqueItems":true},"user_id":{"type":"integer","format":"int64","description":"The infusionsoft user to send the email on behalf of"},"html_content":{"type":"string","description":"The HTML-formatted content of the email, encoded in Base64"},"plain_content":{"type":"string","description":"The plain-text content of the email, encoded in Base64"},"address_field":{"type":"string","description":"Email field of each Contact record to address the email to, such as 'Email', 'EmailAddress2', 'EmailAddress3' or '_CustomFieldName', defaulting to the contact's primary email"}},"required":["contacts","subject","user_id"]},"EmailSendRequestAttachment":{"type":"object","properties":{"file_name":{"type":"string","description":"The filename of the attached file, including extension"},"file_data":{"type":"string","description":"The content of the attachment, encoded in Base64"}}},"CreateUtmContact":{"type":"object","description":"UTM parameters to insert","properties":{"keapSourceId":{"type":"string","description":"The formId","example":6088383224687662},"utmSource":{"type":"string","description":"UTM source information","example":"google"},"utmMedium":{"type":"string","description":"UTM medium information","example":"cpc"},"utmTerm":{"type":"string","description":"UTM term information","example":"financial_consulting"},"utmCampaign":{"type":"string","description":"UTM campaign information","example":"spring_sale"},"utmContent":{"type":"string","description":"UTM content information","example":"textlink"}},"required":["keapSourceId"]},"FullUtm":{"type":"object","properties":{"contactUtmId":{"type":"integer","format":"int64","description":"The contactUtmId identifier","example":12},"keapSourceId":{"type":"string","description":"The formId","example":6088383224687662},"utmSource":{"type":"string","description":"UTM source information","example":"google"},"utmMedium":{"type":"string","description":"UTM medium information","example":"cpc"},"utmTerm":{"type":"string","description":"UTM term information","example":"financial_consulting"},"utmCampaign":{"type":"string","description":"UTM campaign information","example":"spring_sale"},"utmContent":{"type":"string","description":"UTM content information","example":"textlink"}},"required":["contactUtmId","keapSourceId"]},"TagId":{"type":"object","properties":{"tagIds":{"type":"array","items":{"type":"integer","format":"int64"},"uniqueItems":true}}},"CreditCard":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/ContactAddress"},"card_number":{"type":"string"},"card_type":{"type":"string"},"email_address":{"type":"string"},"expiration_month":{"type":"string"},"expiration_year":{"type":"string"},"maestro_issue_number":{"type":"string"},"maestro_start_date_month":{"type":"string"},"maestro_start_date_year":{"type":"string"},"name_on_card":{"type":"string"},"verification_code":{"type":"string"},"consent_type":{"type":"string","enum":["RECURRING_CONSENT","IMPLICIT_CONSENT","EXPLICIT_CONSENT","NO_CONSENT"]}}},"CreditCardAdded":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/ContactAddress"},"id":{"type":"integer","format":"int64"},"card_type":{"type":"string"},"contact_id":{"type":"integer","format":"int64"},"email_address":{"type":"string"},"expiration_month":{"type":"string"},"expiration_year":{"type":"string"},"maestro_issue_number":{"type":"string"},"maestro_start_date_month":{"type":"string"},"maestro_start_date_year":{"type":"string"},"name_on_card":{"type":"string"},"validation_message":{"type":"string"},"validation_status":{"type":"string"}}},"CompanyAddress":{"type":"object","properties":{"line1":{"type":"string"},"line2":{"type":"string"},"locality":{"type":"string"},"region":{"type":"string"},"zip_code":{"type":"string"},"zip_four":{"type":"string"},"country_code":{"type":"string"}}},"CompanyFaxNumber":{"type":"object","properties":{"number":{"type":"string"},"type":{"type":"string"}}},"CompanyPhoneNumber":{"type":"object","properties":{"number":{"type":"string"},"extension":{"type":"string"},"type":{"type":"string"}}},"CreateOrPatchCompany":{"type":"object","description":"company","properties":{"website":{"type":"string"},"address":{"$ref":"#/components/schemas/CompanyAddress"},"notes":{"type":"string"},"company_name":{"type":"string"},"phone_number":{"$ref":"#/components/schemas/CompanyPhoneNumber"},"fax_number":{"$ref":"#/components/schemas/CompanyFaxNumber"},"email_address":{"type":"string"},"opt_in_reason":{"type":"string"},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldValue"}}},"required":["company_name"]},"Company":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"website":{"type":"string"},"address":{"$ref":"#/components/schemas/CompanyAddress"},"notes":{"type":"string"},"company_name":{"type":"string"},"phone_number":{"$ref":"#/components/schemas/CompanyPhoneNumber"},"fax_number":{"$ref":"#/components/schemas/CompanyFaxNumber"},"email_address":{"type":"string"},"email_status":{"type":"string","enum":["UnengagedMarketable","SingleOptIn","DoubleOptin","Confirmed","UnengagedNonMarketable","NonMarketable","Lockdown","Bounce","HardBounce","Manual","Admin","System","ListUnsubscribe","Feedback","Spam","Invalid","Deactivated"]},"email_opted_in":{"type":"boolean"},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldValue"}}}},"AchieveApiGoalEvent":{"type":"object","properties":{"contact_id":{"type":"integer","format":"int64"}},"required":["contact_id"]},"GoalEventResultDTO":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"},"campaign_id":{"type":"integer","format":"int64"},"goal_id":{"type":"integer","format":"int64"}}},"CreateAffiliate":{"type":"object","description":"affiliate","properties":{"contact_id":{"type":"integer","format":"int64","example":0},"code":{"type":"string"},"password":{"type":"string"},"parent_id":{"type":"integer","format":"int64"},"status":{"type":"string","enum":["active","inactive"]},"notify_on_lead":{"type":"boolean"},"notify_on_sale":{"type":"boolean"},"track_leads_for":{"type":"integer","format":"int32"},"name":{"type":"string"}},"required":["code","contact_id","password"]},"Affiliate":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"contact_id":{"type":"integer","format":"int64"},"parent_id":{"type":"integer","format":"int64"},"code":{"type":"string"},"name":{"type":"string"},"status":{"type":"string"},"notify_on_lead":{"type":"boolean"},"notify_on_sale":{"type":"boolean"},"track_leads_for":{"type":"integer","format":"int32"}}},"UpdateNote":{"type":"object","description":"note","properties":{"title":{"type":"string"},"body":{"type":"string"},"type":{"type":"string","enum":["Appointment, Call, Email, Fax, Letter, Other"]},"contact_id":{"type":"integer","format":"int64"},"user_id":{"type":"integer","format":"int64"}}},"RestUserQueryCommand":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"include_inactive":{"type":"boolean"},"include_partners":{"type":"boolean"},"includeInactive":{"type":"boolean"},"includePartners":{"type":"boolean"}}},"Users":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/RestUser"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"}}},"EcommerceReportingOrder":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"title":{"type":"string"},"status":{"type":"string"},"recurring":{"type":"boolean"},"total":{"type":"number","format":"double"},"contact":{"$ref":"#/components/schemas/EcommerceReportingOrderContactDetails"},"notes":{"type":"string"},"terms":{"type":"string"},"order_type":{"type":"string"},"source_type":{"type":"string","enum":["INVOICE","API","CHECKOUT_FORM","MANUAL_PAYMENT","UNKNOWN","QBO_SYNC"]},"creation_date":{"type":"string"},"modification_date":{"type":"string"},"order_date":{"type":"string"},"lead_affiliate_id":{"type":"integer","format":"int64"},"sales_affiliate_id":{"type":"integer","format":"int64"},"total_paid":{"type":"number","format":"double"},"total_due":{"type":"number","format":"double"},"shipping_information":{"$ref":"#/components/schemas/EcommerceReportingShippingInformation"},"refund_total":{"type":"number","format":"double"},"allow_payment":{"type":"boolean"},"allow_paypal":{"type":"boolean"},"order_items":{"type":"array","items":{"$ref":"#/components/schemas/EcommerceReportingOrderItem"}},"payment_plan":{"$ref":"#/components/schemas/EcommerceReportingPaymentPlan"},"invoice_number":{"type":"integer","format":"int64"},"contact_id":{"type":"string"},"product_id":{"type":"string"}}},"EcommerceReportingOrderItem":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"jobRecurringId":{"type":"integer","format":"int64"},"name":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"notes":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"cost":{"type":"number","format":"double"},"price":{"type":"number","format":"double"},"discount":{"type":"number","format":"double"},"specialId":{"type":"integer","format":"int64"},"specialAmount":{"type":"number","format":"double"},"specialPctOrAmt":{"type":"integer","format":"int32"},"product":{"$ref":"#/components/schemas/EcommerceReportingSimpleProduct"},"subscriptionPlan":{"$ref":"#/components/schemas/SubscriptionPlan"}}},"EcommerceReportingPaymentGateway":{"type":"object","properties":{"merchant_account_id":{"type":"integer","format":"int64"},"use_default":{"type":"boolean"},"merchant_account_name":{"type":"string"}}},"EcommerceReportingPaymentPlan":{"type":"object","properties":{"auto_charge":{"type":"boolean"},"credit_card_id":{"type":"integer","format":"int64"},"days_between_payments":{"type":"integer","format":"int64"},"initial_payment_amount":{"type":"number","format":"double"},"initial_payment_percent":{"type":"number","format":"double"},"initial_payment_date":{"type":"string"},"number_of_payments":{"type":"integer","format":"int64"},"payment_gateway":{"$ref":"#/components/schemas/EcommerceReportingPaymentGateway"},"plan_start_date":{"type":"string"},"payment_method_id":{"type":"string"},"max_charge_attempts":{"type":"integer","format":"int64"},"days_between_retries":{"type":"integer","format":"int64"}}},"EcommerceReportingShippingInformation":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"first_name":{"type":"string"},"middle_name":{"type":"string"},"last_name":{"type":"string"},"company":{"type":"string"},"phone":{"type":"string"},"street1":{"type":"string"},"street2":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"country":{"type":"string"},"invoiceToCompany":{"type":"boolean"}}},"EcommerceReportingSimpleProduct":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"sku":{"type":"string"},"description":{"type":"string"},"shippable":{"type":"boolean"},"taxable":{"type":"boolean"}}},"EcommerceReportingTransaction":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"test":{"type":"boolean"},"amount":{"type":"number","format":"double"},"currency":{"type":"string"},"gateway":{"type":"string"},"paymentDate":{"type":"string"},"type":{"type":"string"},"status":{"type":"string"},"errors":{"type":"string"},"orders":{"type":"array","items":{"$ref":"#/components/schemas/EcommerceReportingOrder"}},"contact_id":{"type":"integer","format":"int64"},"transaction_date":{"type":"string"},"gateway_account_name":{"type":"string"},"order_ids":{"type":"string"},"collection_method":{"type":"string"}}},"SubscriptionPlan":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"cycle":{"type":"integer","format":"int32"},"frequency":{"type":"integer","format":"int32"},"active":{"type":"boolean"},"prorate":{"type":"boolean"},"subscription_plan_name":{"type":"string"},"number_of_cycles":{"type":"integer","format":"int32"},"plan_price":{"type":"number","format":"double"},"subscription_plan_index":{"type":"integer","format":"int32"}}},"TransactionSearchCommand":{"type":"object","properties":{"since":{"type":"string"},"until":{"type":"string"},"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"contact_id":{"type":"integer","format":"int64"},"sinceAsDate":{"type":"string","format":"date-time"},"untilAsDate":{"type":"string","format":"date-time"}}},"TransactionList":{"type":"object","properties":{"transactions":{"type":"array","items":{"$ref":"#/components/schemas/EcommerceReportingTransaction"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"}}},"TaskSearchCommand":{"type":"object","properties":{"since":{"type":"string"},"until":{"type":"string"},"completed":{"type":"boolean"},"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"order":{"type":"string"},"sinceAsDate":{"type":"string","format":"date-time"},"untilAsDate":{"type":"string","format":"date-time"}}},"TaskList":{"type":"object","properties":{"tasks":{"type":"array","items":{"$ref":"#/components/schemas/Task"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"},"sync_token":{"type":"string"}}},"ObjectModel":{"type":"object","properties":{"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldMetaData"}},"optional_properties":{"type":"array","items":{"type":"string"},"uniqueItems":true}}},"RestQueryCommand":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"}}},"TaggedContact":{"type":"object","properties":{"contact":{"$ref":"#/components/schemas/BasicContact"},"date_applied":{"type":"string","format":"date-time"}}},"TaggedContactList":{"type":"object","properties":{"contacts":{"type":"array","items":{"$ref":"#/components/schemas/TaggedContact"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"}}},"BasicCompany":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"email":{"type":"string"},"company_name":{"type":"string"}}},"TaggedCompany":{"type":"object","properties":{"company":{"$ref":"#/components/schemas/BasicCompany"},"date_applied":{"type":"string","format":"date-time"}}},"TaggedCompanyList":{"type":"object","properties":{"companies":{"type":"array","items":{"$ref":"#/components/schemas/TaggedCompany"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"}}},"RestTagQueryCommand":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"category":{"type":"integer","format":"int64"},"name":{"type":"string"}}},"Tags":{"type":"object","properties":{"tags":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"}}},"SubscriptionListCommand":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"contact_id":{"type":"integer","format":"int64"}}},"SubscriptionList":{"type":"object","properties":{"subscriptions":{"type":"array","items":{"$ref":"#/components/schemas/Subscription"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"}}},"Setting":{"type":"object","properties":{"value":{"type":"string"}}},"RestApplicationConfiguration":{"type":"object","properties":{"affiliate":{"$ref":"#/components/schemas/RestApplicationConfigurationModuleAffiliate"},"appointment":{"$ref":"#/components/schemas/RestApplicationConfigurationModuleAppointment"},"application":{"$ref":"#/components/schemas/RestApplicationConfigurationModuleApplication"},"contact":{"$ref":"#/components/schemas/RestApplicationConfigurationModuleContact"},"ecommerce":{"$ref":"#/components/schemas/RestApplicationConfigurationModuleECommerce"},"email":{"$ref":"#/components/schemas/RestApplicationConfigurationModuleEMail"},"forms":{"$ref":"#/components/schemas/RestApplicationConfigurationModuleForms"},"fulfillment":{"$ref":"#/components/schemas/RestApplicationConfigurationModuleFulfillment"},"invoice":{"$ref":"#/components/schemas/RestApplicationConfigurationModuleInvoice"},"note":{"$ref":"#/components/schemas/RestApplicationConfigurationModuleNote"},"opportunity":{"$ref":"#/components/schemas/RestApplicationConfigurationModuleOpportunity"},"task":{"$ref":"#/components/schemas/RestApplicationConfigurationModuleTask"},"template":{"$ref":"#/components/schemas/RestApplicationConfigurationModuleTemplate"}}},"RestApplicationConfigurationModuleAffiliate":{"type":"object","properties":{"commission":{"$ref":"#/components/schemas/RestApplicationConfigurationModuleAffiliateCommission"},"choose_affiliate":{"type":"boolean"},"custom_affiliate_url":{"type":"string"},"display_affiliate_ip_address":{"type":"boolean"},"do_not_notify_affiliate":{"type":"boolean"},"use_referral_history_if_no_tracking_cookie":{"type":"boolean"},"skip_pay_if_unused":{"type":"boolean"}}},"RestApplicationConfigurationModuleAffiliateCommission":{"type":"object","properties":{"levels":{"type":"integer","format":"int32"},"calculation_type":{"type":"string"},"participant_types":{"type":"string"}}},"RestApplicationConfigurationModuleApplication":{"type":"object","properties":{"company":{"$ref":"#/components/schemas/RestApplicationConfigurationModuleApplicationCompany"},"time_zone":{"type":"string"},"default_view_locale":{"type":"string"},"features_enabled":{"$ref":"#/components/schemas/RestApplicationConfigurationModuleApplicationFeaturesEnabled"}}},"RestApplicationConfigurationModuleApplicationCompany":{"type":"object","properties":{"name":{"type":"string"},"country":{"type":"string"},"email":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"},"phone":{"type":"string"},"website":{"type":"string"},"street_address_1":{"type":"string"},"street_address_2":{"type":"string"},"phone_ext":{"type":"string"},"caller_id_number":{"type":"string"},"web_logo_url":{"type":"string"}}},"RestApplicationConfigurationModuleApplicationFeaturesEnabled":{"type":"object","properties":{"marketing":{"type":"boolean"}}},"RestApplicationConfigurationModuleAppointment":{"type":"object","properties":{"appointment_types":{"type":"string"},"share_opportunity_with_related_user":{"type":"boolean"}}},"RestApplicationConfigurationModuleContact":{"type":"object","properties":{"title_types":{"type":"string"},"suffix_types":{"type":"string"},"contact_types":{"type":"string"},"phone_types":{"type":"string"},"fax_types":{"type":"string"},"address_labels":{"$ref":"#/components/schemas/RestApplicationConfigurationModuleContactAddressLabels"},"disable_contact_edit_in_client_login":{"type":"boolean"},"default_new_contact_form":{"type":"string"}}},"RestApplicationConfigurationModuleContactAddressLabels":{"type":"object","properties":{"line_1":{"type":"string"},"line_2":{"type":"string"},"line_3":{"type":"string"}}},"RestApplicationConfigurationModuleECommerce":{"type":"object","properties":{"currency":{"type":"string"},"default_country":{"type":"string"},"default_merchant":{"type":"string"},"credit_card_types":{"type":"string"},"default_tax":{"type":"string"},"payment_types":{"type":"string"},"default_to_auto_charge":{"type":"boolean"},"default_charge_max_retry_attempts":{"type":"integer","format":"int32"},"default_number_of_days_between_charge_attempts":{"type":"integer","format":"int32"},"merchant_account_max_retry_attempts":{"type":"integer","format":"int32"},"promo_codes":{"type":"string"},"track_cost_per_unit":{"type":"boolean"},"track_inventory":{"type":"boolean"}}},"RestApplicationConfigurationModuleEMail":{"type":"object","properties":{"default_opt_in_link":{"type":"string"},"default_opt_out_link":{"type":"string"},"whitelisted_domains":{"type":"string"},"hide_emails_to_and_from_domains":{"type":"string"},"append_contact_key_to_links":{"type":"boolean"}}},"RestApplicationConfigurationModuleForms":{"type":"object","properties":{"spam_filters_enabled":{"type":"boolean"}}},"RestApplicationConfigurationModuleFulfillment":{"type":"object","properties":{"default_message_to":{"type":"string"},"default_message_fields":{"type":"string"}}},"RestApplicationConfigurationModuleInvoice":{"type":"object","properties":{"tax_label":{"type":"string"}}},"RestApplicationConfigurationModuleNote":{"type":"object","properties":{"appointment_types":{"type":"string"},"share_opportunity_with_related_user":{"type":"boolean"}}},"RestApplicationConfigurationModuleOpportunity":{"type":"object","properties":{"states":{"$ref":"#/components/schemas/RestApplicationConfigurationModuleOpportunityStates"},"default_stage":{"type":"string"}}},"RestApplicationConfigurationModuleOpportunityStates":{"type":"object","properties":{"active":{"$ref":"#/components/schemas/RestApplicationConfigurationModuleOpportunityStatesActive"},"win":{"$ref":"#/components/schemas/RestApplicationConfigurationModuleOpportunityStatesWin"},"loss":{"$ref":"#/components/schemas/RestApplicationConfigurationModuleOpportunityStatesLoss"}}},"RestApplicationConfigurationModuleOpportunityStatesActive":{"type":"object","properties":{"stages":{"type":"string"}}},"RestApplicationConfigurationModuleOpportunityStatesLoss":{"type":"object","properties":{"reasons":{"type":"string"},"stage":{"type":"string"}}},"RestApplicationConfigurationModuleOpportunityStatesWin":{"type":"object","properties":{"reasons":{"type":"string"},"stage":{"type":"string"}}},"RestApplicationConfigurationModuleTask":{"type":"object","properties":{"appointment_types":{"type":"string"},"share_opportunity_with_related_user":{"type":"boolean"}}},"RestApplicationConfigurationModuleTemplate":{"type":"object","properties":{"default_country_code":{"type":"integer","format":"int32"},"default_user_id":{"type":"integer","format":"int64"}}},"SyncCommand":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"}}},"ProductStatus":{"type":"object","properties":{"status":{"type":"string","enum":["CREATED","UPDATED","DELETED"]},"product":{"$ref":"#/components/schemas/Product_"}}},"ProductStatusList":{"type":"object","properties":{"product_statuses":{"type":"array","items":{"$ref":"#/components/schemas/ProductStatus"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"},"sync_token":{"type":"string"}}},"ProductSearchCommand":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"active":{"type":"boolean"}}},"ProductList":{"type":"object","properties":{"products":{"type":"array","items":{"$ref":"#/components/schemas/Product_"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"},"sync_token":{"type":"string"}}},"InvoicePayment":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"amount":{"type":"number"},"note":{"type":"string"},"disputed":{"type":"boolean"},"invoice_id":{"type":"integer","format":"int64"},"payment_id":{"type":"integer","format":"int64"},"pay_date":{"type":"string","format":"date-time"},"pay_status":{"type":"string"},"last_updated":{"type":"string","format":"date-time"},"skip_commission":{"type":"boolean"},"refund_invoice_payment_id":{"type":"integer","format":"int64"}}},"OrderSearchCommand":{"type":"object","properties":{"since":{"type":"string"},"until":{"type":"string"},"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"paid":{"type":"boolean"},"order":{"type":"string"},"contact_id":{"type":"integer","format":"int64"},"product_id":{"type":"integer","format":"int64"},"sinceAsDate":{"type":"string","format":"date-time"},"untilAsDate":{"type":"string","format":"date-time"}}},"OrderList":{"type":"object","properties":{"orders":{"type":"array","items":{"$ref":"#/components/schemas/EcommerceReportingOrder"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"}}},"SalesPipeline":{"type":"object","properties":{"stage_id":{"type":"integer","format":"int64"},"stage_name":{"type":"string"},"stage_count":{"type":"integer","format":"int32"},"stage_order":{"type":"integer","format":"int32"},"end_stage":{"type":"boolean"},"is_default":{"type":"boolean"}}},"OpportunitySearchCommand":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"user_id":{"type":"integer","format":"int64"},"stage_id":{"type":"integer","format":"int64"},"search_term":{"type":"string"},"order":{"type":"string","enum":["next_action","opportunity_name","contact_name","date_created"]}}},"OpportunityList":{"type":"object","properties":{"opportunities":{"type":"array","items":{"$ref":"#/components/schemas/Opportunity"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"}}},"NoteQueryCommand":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"user_id":{"type":"integer","format":"int64"},"contact_id":{"type":"integer","format":"int64"}}},"NoteList":{"type":"object","properties":{"notes":{"type":"array","items":{"$ref":"#/components/schemas/Note"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"}}},"Merchant":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"type":{"type":"string"},"account_name":{"type":"string"},"is_test":{"type":"boolean"}}},"RestMerchantAccountResponse":{"type":"object","properties":{"default_merchant_account":{"type":"integer","format":"int64"},"merchant_accounts":{"type":"array","items":{"$ref":"#/components/schemas/Merchant"}}}},"RestDefaultOptionsResponse":{"type":"object","properties":{"contact_types":{"type":"array","items":{"type":"string"}},"title_types":{"type":"array","items":{"type":"string"}},"suffix_types":{"type":"array","items":{"type":"string"}},"phone_types":{"type":"array","items":{"type":"string"}},"fax_types":{"type":"array","items":{"type":"string"}}}},"ProvincesByCode":{"type":"object","properties":{"provinces":{"type":"object","additionalProperties":{"type":"string"},"description":"A key-value pair of province code and province name."}},"required":["provinces"]},"CountriesByCode":{"type":"object","properties":{"countries":{"type":"object","additionalProperties":{"type":"string"},"description":"A key-value pair of country code and country name."}},"required":["countries"]},"FileQueryCommand":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"viewable":{"type":"string","enum":["PUBLIC","PRIVATE","BOTH"]},"permission":{"type":"string","enum":["USER","COMPANY","BOTH"]},"type":{"type":"string","enum":["Application","Image","Fax","Attachment","Ticket","Contact","DigitalProduct","Import","Hidden","WebForm","StyledCart","ReSampledImage","TemplateThumbnail","Funnel","LogoThumbnail","Unlayer","BrandingCenterLogo"]},"name":{"type":"string"},"contact_id":{"type":"integer","format":"int64"},"contactId":{"type":"integer","format":"int64"}}},"FileList":{"type":"object","properties":{"files":{"type":"array","items":{"$ref":"#/components/schemas/FileDescriptor"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"}}},"EmailSentQueryResultWithContent":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"subject":{"type":"string"},"headers":{"type":"string"},"contact_id":{"type":"integer","format":"int64"},"sent_to_address":{"type":"string"},"sent_to_cc_addresses":{"type":"string"},"sent_to_bcc_addresses":{"type":"string"},"sent_from_address":{"type":"string"},"sent_from_reply_address":{"type":"string"},"sent_date":{"type":"string","format":"date-time"},"received_date":{"type":"string","format":"date-time"},"opened_date":{"type":"string","format":"date-time"},"clicked_date":{"type":"string","format":"date-time"},"original_provider":{"type":"string","enum":["UNKNOWN","INFUSIONSOFT","MICROSOFT","GOOGLE"]},"original_provider_id":{"type":"string"},"plain_content":{"type":"string","description":"Base64 encoded plain text"},"html_content":{"type":"string","description":"Base64 encoded HTML"}}},"EmailSentQueryCommand":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"email":{"type":"string"},"ordered":{"type":"boolean"},"contact_id":{"type":"integer","format":"int64"},"since_sent_date":{"type":"string"},"until_sent_date":{"type":"string"}}},"EmailSentQueryResult":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"subject":{"type":"string"},"headers":{"type":"string"},"contact_id":{"type":"integer","format":"int64"},"sent_to_address":{"type":"string"},"sent_to_cc_addresses":{"type":"string"},"sent_to_bcc_addresses":{"type":"string"},"sent_from_address":{"type":"string"},"sent_from_reply_address":{"type":"string"},"sent_date":{"type":"string","format":"date-time"},"received_date":{"type":"string","format":"date-time"},"opened_date":{"type":"string","format":"date-time"},"clicked_date":{"type":"string","format":"date-time"},"original_provider":{"type":"string","enum":["UNKNOWN","INFUSIONSOFT","MICROSOFT","GOOGLE"]},"original_provider_id":{"type":"string"}}},"EmailSentQueryResultList":{"type":"object","properties":{"emails":{"type":"array","items":{"$ref":"#/components/schemas/EmailSentQueryResult"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"}}},"ContactTag":{"type":"object","properties":{"tag":{"$ref":"#/components/schemas/SimpleTag"},"date_applied":{"type":"string","format":"date-time"}}},"ContactTagList":{"type":"object","properties":{"tags":{"type":"array","items":{"$ref":"#/components/schemas/ContactTag"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"}}},"SimpleTag":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"category":{"type":"string"}}},"ContactQueryEmailCommand":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"email":{"type":"string"}}},"ContactCreditCard":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"card_type":{"type":"string"},"card_number":{"type":"string"},"validation_status":{"type":"string"},"payment_method_id":{"type":"string"}}},"ContactQueryCommand":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"email":{"type":"string"},"given_name":{"type":"string"},"family_name":{"type":"string"},"order":{"type":"string","enum":["id","date_created","last_updated","name","firstName","email"]},"order_direction":{"type":"string","enum":["ASCENDING","DESCENDING"]},"since":{"type":"string"},"until":{"type":"string"},"sinceAsDate":{"type":"string","format":"date-time"},"untilAsDate":{"type":"string","format":"date-time"}}},"ContactList":{"type":"object","properties":{"contacts":{"type":"array","items":{"$ref":"#/components/schemas/RestPartialContact"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"}}},"CompanyQueryCommand":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"company_name":{"type":"string"},"order":{"type":"string","enum":["id","date_created","name","email"]},"order_direction":{"type":"string","enum":["ASCENDING","DESCENDING"]}}},"CompanyList":{"type":"object","properties":{"companies":{"type":"array","items":{"$ref":"#/components/schemas/Company"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"}}},"CampaignWithStats":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"locked":{"type":"boolean"},"goals":{"type":"array","items":{"$ref":"#/components/schemas/Goal"}},"sequences":{"type":"array","items":{"$ref":"#/components/schemas/Sequence"}},"date_created":{"type":"string","format":"date-time"},"published_date":{"type":"string","format":"date-time"},"published_status":{"type":"boolean"},"error_message":{"type":"string"},"time_zone":{"type":"string"},"published_time_zone":{"type":"string"},"created_by_global_id":{"type":"integer","format":"int64"},"active_contact_count":{"type":"integer","format":"int32"},"completed_contact_count":{"type":"integer","format":"int32"}}},"Goal":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string","enum":["WebForm","LandingPage","Survey","LinkClick","EmailOpened","Score","Purchase","FailedPurchase","Quote","WebsiteTrigger","InternalForm","SmartForm","AppointmentEvent","Task","StageMove","Note","Tag","PipelineStageMove","UnlayerLandingPage","GroSocial","TwitterForm","API","WordPress","NewLandingPage","IntegrationTrigger"]},"historical_contact_counts":{"$ref":"#/components/schemas/HistoricalCounts"},"next_sequence_ids":{"type":"array","items":{"type":"integer","format":"int64"},"uniqueItems":true},"previous_sequence_ids":{"type":"array","items":{"type":"integer","format":"int64"},"uniqueItems":true}}},"HistoricalCounts":{"type":"object","properties":{"24_hours":{"type":"integer","format":"int32"},"30_days":{"type":"integer","format":"int32"}}},"Item":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"type":{"type":"string","enum":["NULL","Start","Wait","DelayTimer","ContactTimer","DateTimer","AppointmentTimer","Email","BardEmail","UnlayerEmail","EmailConfirm","Voice","Fax","Letter","AutomatedSms","UnlayerEmailConfirm","Tag","Opportunity","Note","Task","CompleteTasks","Appointment","AssignOwner","FieldValue","Fulfillment","CreateOrder","Deal","AddToSequence","CancelSubscription","MoveOpportunity","Http","CustomerHub","HttpRequest","IntegrationAction","ActionSet"]},"next_item_id":{"type":"integer","format":"int64"},"previous_item_id":{"type":"integer","format":"int64"}}},"Sequence":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"paths":{"type":"array","items":{"$ref":"#/components/schemas/SequencePath"}},"active_contact_count":{"type":"integer","format":"int32"},"active_contact_count_completed":{"type":"integer","format":"int32"},"historical_contact_count":{"$ref":"#/components/schemas/HistoricalCounts"}}},"SequencePath":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Item"}}}},"CampaignQueryCommand":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"search_text":{"type":"string"},"order":{"type":"string","enum":["id","name","published_date","completed_contact_count","active_contact_count","date_created","last_updated","category","status"]},"order_direction":{"type":"string","enum":["ASCENDING","DESCENDING"]},"stats":{"type":"boolean"}}},"Campaign":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"locked":{"type":"boolean"},"goals":{"type":"array","items":{"$ref":"#/components/schemas/Goal"}},"sequences":{"type":"array","items":{"$ref":"#/components/schemas/Sequence"}},"date_created":{"type":"string","format":"date-time"},"published_date":{"type":"string","format":"date-time"},"published_status":{"type":"boolean"},"error_message":{"type":"string"},"time_zone":{"type":"string"},"published_time_zone":{"type":"string"},"created_by_global_id":{"type":"integer","format":"int64"}}},"CampaignList":{"type":"object","properties":{"campaigns":{"type":"array","items":{"$ref":"#/components/schemas/Campaign"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"}}},"AppointmentSearchCommand":{"type":"object","properties":{"since":{"type":"string"},"until":{"type":"string"},"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"contact_id":{"type":"integer","format":"int64"},"sinceAsDate":{"type":"string","format":"date-time"},"untilAsDate":{"type":"string","format":"date-time"}}},"AppointmentList":{"type":"object","properties":{"appointments":{"type":"array","items":{"$ref":"#/components/schemas/Appointment"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"},"sync_token":{"type":"string"}}},"RestAffiliatePaymentQueryCommand":{"type":"object","properties":{"limit":{"type":"integer","format":"int32"},"offset":{"type":"integer","format":"int32"},"since":{"type":"string"},"until":{"type":"string"},"order":{"type":"string","enum":["ID","DATE","AMOUNT"]},"order_direction":{"type":"string","enum":["ASCENDING","DESCENDING"]},"sinceAsDate":{"type":"string","format":"date-time"},"untilAsDate":{"type":"string","format":"date-time"},"orderDirection":{"type":"string","enum":["ASCENDING","DESCENDING"]}}},"AffiliatePaymentList":{"type":"object","properties":{"payments":{"type":"array","items":{"$ref":"#/components/schemas/RestAffiliatePayment"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"}}},"RestAffiliatePayment":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"date":{"type":"string"},"notes":{"type":"string"},"amount":{"type":"number","format":"double"},"type":{"type":"string"}}},"AffiliateClawbackList":{"type":"object","properties":{"clawbacks":{"type":"array","items":{"$ref":"#/components/schemas/RestAffiliateClawback"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"}}},"RestAffiliateClawback":{"type":"object","properties":{"sale_affiliate_id":{"type":"integer","format":"int64"},"amount":{"type":"number","format":"double"},"contact_id":{"type":"integer","format":"int64"},"given_name":{"type":"string"},"family_name":{"type":"string"},"invoice_id":{"type":"integer","format":"int64"},"date_earned":{"type":"string"},"sold_by_given_name":{"type":"string"},"sold_by_family_name":{"type":"string"},"product_name":{"type":"string"},"description":{"type":"string"},"subscription_plan_name":{"type":"string"}}},"AffiliateSummary":{"type":"object","properties":{"clawbacks":{"type":"number","format":"double"},"balance":{"type":"number","format":"double"},"affiliate_id":{"type":"integer","format":"int64"},"amount_earned":{"type":"number","format":"double"}}},"AffiliateSummaryList":{"type":"object","properties":{"summaries":{"type":"array","items":{"$ref":"#/components/schemas/AffiliateSummary"}},"count":{"type":"integer","format":"int32"}}},"AffiliateRedirect":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"affiliate_id":{"type":"integer","format":"int64"},"local_url_code":{"type":"string"},"redirect_url":{"type":"string"},"program_ids":{"type":"array","items":{"type":"integer","format":"int64"}}}},"RedirectList":{"type":"object","properties":{"redirects":{"type":"array","items":{"$ref":"#/components/schemas/AffiliateRedirect"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"}}},"AffiliateProgram":{"type":"object","properties":{"id":{"type":"integer","format":"int64"},"name":{"type":"string"},"priority":{"type":"integer","format":"int32"},"notes":{"type":"string"},"affiliate_id":{"type":"integer","format":"int64"}}},"AffiliateProgramList":{"type":"object","properties":{"programs":{"type":"array","items":{"$ref":"#/components/schemas/AffiliateProgram"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"}}},"AffiliateCommission":{"type":"object","properties":{"description":{"type":"string"},"amount_earned":{"type":"number","format":"double"},"contact_first_name":{"type":"string"},"contact_last_name":{"type":"string"},"invoice_id":{"type":"integer","format":"int64"},"date_earned":{"type":"string","format":"date-time"},"contact_id":{"type":"integer","format":"int64"},"sales_affiliate_id":{"type":"integer","format":"int64"},"sold_by_first_name":{"type":"string"},"sold_by_last_name":{"type":"string"},"product_name":{"type":"string"}}},"AffiliateCommissionList":{"type":"object","properties":{"commissions":{"type":"array","items":{"$ref":"#/components/schemas/AffiliateCommission"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"}}},"AffiliateList":{"type":"object","properties":{"affiliates":{"type":"array","items":{"$ref":"#/components/schemas/Affiliate"}},"count":{"type":"integer","format":"int32"},"next":{"type":"string"},"previous":{"type":"string"}}}},"securitySchemes":{"oauth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://accounts.infusionsoft.com/app/oauth/authorize","tokenUrl":"https://api.infusionsoft.com/token","scopes":{}}}}}}}