{"openapi":"3.0.3","servers":[{"description":"Production","url":"https://unify.apideck.com"}],"info":{"contact":{"email":"hello@apideck.com","url":"https://developers.apideck.com"},"description":"Welcome to the CRM API.\n\nYou can use this API to access all CRM API endpoints.\n\n## Base URL\n\nThe base URL for all API requests is `https://unify.apideck.com`\n\n## Headers\n\nCustom headers that are expected as part of the request. Note that [RFC7230](https://tools.ietf.org/html/rfc7230) states header names are case insensitive.\n\n| Name                  | Type    | Required | Description                                                                                                                                                    |\n| --------------------- | ------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| x-apideck-consumer-id | String  | Yes      | The id of the customer stored inside Apideck Vault. This can be a user id, account id, device id or whatever entity that can have integration within your app. |\n| x-apideck-service-id  | String  | No       | Describe the service you want to call (e.g., pipedrive). Only needed when a customer has activated multiple integrations for the same Unified API.             |\n| x-apideck-raw         | Boolean | No       | Include raw response. Mostly used for debugging purposes.                                                                                                      |\n| x-apideck-app-id      | String  | Yes      | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys.                                                             |\n| Authorization         | String  | Yes      | Bearer API KEY                                                                                                                                                 |\n\n## Authorization\n\nYou can interact with the API through the authorization methods below.\n\n<!-- ReDoc-Inject: <security-definitions> -->\n\n## Pagination\n\nAll API resources have support for bulk retrieval via list APIs.  Apideck uses cursor-based pagination via the optional `cursor` and `limit` parameters.\n\nTo fetch the first page of results, call the list API without a `cursor` parameter. Afterwards you can fetch subsequent pages by providing a cursor parameter. You will find the next cursor in the response body in `meta.cursors.next`. If `meta.cursors.next` is `null` you're at the end of the list.\n\nIn the REST API you can also use the `links` from the response for added convenience. Simply call the URL in `links.next` to get the next page of results.\n\n### Query Parameters\n\n| Name   | Type   | Required | Description                                                                                                        |\n| ------ | ------ | -------- | ------------------------------------------------------------------------------------------------------------------ |\n| cursor | String | No       | Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response. |\n| limit  | Number | No       | Number of results to return. Minimum 1, Maximum 200, Default 20                                                    |\n\n### Response Body\n\n| Name                  | Type   | Description                                                        |\n| --------------------- | ------ | ------------------------------------------------------------------ |\n| meta.cursors.previous | String | Cursor to navigate to the previous page of results through the API |\n| meta.cursors.current  | String | Cursor to navigate to the current page of results through the API  |\n| meta.cursors.next     | String | Cursor to navigate to the next page of results through the API     |\n| meta.items_on_page    | Number | Number of items returned in the data property of the response      |\n| links.previous        | String | Link to navigate to the previous page of results through the API   |\n| links.current         | String | Link to navigate to the current page of results through the API    |\n| links.next            | String | Link to navigate to the next page of results through the API       |\n\n⚠️ `meta.cursors.previous`/`links.previous` is not available for all connectors.\n\n## SDKs and API Clients\n\nWe currently offer a [Node.js](https://developers.apideck.com/sdks/node), [PHP](https://developers.apideck.com/sdks/php) and [.NET](https://developers.apideck.com/sdks/dot-net) SDK.\nNeed another SDK? [Request the SDK of your choice](https://integrations.apideck.com/request).\n\n## Debugging\n\nBecause of the nature of the abstraction we do in Apideck Unify we still provide the option to the receive raw requests and responses being handled underlying. By including the raw flag `?raw=true` in your requests you can still receive the full request. Please note that this increases the response size and can introduce extra latency.\n\n## Errors\n\nThe API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below.\n\n| Code | Title                | Description                                                                                                                                                                                              |\n| ---- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| 200  | OK                   | The request message has been successfully processed, and it has produced a response. The response message varies, depending on the request method and the requested data.                                |\n| 201  | Created              | The request has been fulfilled and has resulted in one or more new resources being created.                                                                                                              |\n| 204  | No Content           | The server has successfully fulfilled the request and that there is no additional content to send in the response payload body.                                                                          |\n| 400  | Bad Request          | The receiving server cannot understand the request because of malformed syntax. Do not repeat the request without first modifying it; check the request for errors, fix them and then retry the request. |\n| 401  | Unauthorized         | The request has not been applied because it lacks valid authentication credentials for the target resource.                                                                                              |\n| 402  | Payment Required     | Subscription data is incomplete or out of date. You'll need to provide payment details to continue.                                                                                                      |\n| 403  | Forbidden            | You do not have the appropriate user rights to access the request. Do not repeat the request.                                                                                                            |\n| 404  | Not Found            | The origin server did not find a current representation for the target resource or is not willing to disclose that one exists.                                                                           |\n| 409  | Conflict             | The request could not be completed due to a conflict with the current state of the target resource.                                                                                                      |\n| 422  | Unprocessable Entity | The server understands the content type of the request entity, and the syntax of the request entity is correct but was unable to process the contained instructions.                                     |\n| 429  | Too Many Requests    | You sent too many requests in a given amount of time (\"rate limit\"). Try again later                                                                                                                     |\n| 5xx  | Server Errors        | Something went wrong with the Unify API. These errors are logged on our side. You can contact our team to resolve the issue.                                                                             |\n\n### Handling errors\n\nThe Unify API and SDKs can produce errors for many reasons, such as a failed requests due to misconfigured integrations, invalid parameters, authentication errors, and network unavailability.\n\n### Error Types\n\n#### RequestValidationError\n\nRequest is not valid for the current endpoint. The response body will include details on the validation error. Check the spelling and types of your attributes, and ensure you are not passing data that is outside of the specification.\n\n#### UnsupportedFiltersError\n\nFilters in the request are valid, but not supported by the connector. Remove the unsupported filter(s) to get a successful response.\n\n#### UnsupportedSortFieldError\n\nSort field (`sort[by]`) in the request is valid, but not supported by the connector. Replace or remove the sort field to get a successful response.\n\n#### InvalidCursorError\n\nPagination cursor in the request is not valid for the current connector. Make sure to use a cursor returned from the API, for the same connector.\n\n#### ConnectorExecutionError\n\nA Unified API request made via one of our downstream connectors returned an unexpected error. The `status_code` returned is proxied through to error response along with their original response via the error detail.\n\n#### UnauthorizedError\n\nWe were unable to authorize the request as made. This can happen for a number of reasons, from missing header params to passing an incorrect authorization token. Verify your Api Key is being set correctly in the authorization header. ie: `Authorization: 'Bearer sk_live_***'`\n\n#### ConnectorCredentialsError\n\nA request using a given connector has not been authorized. Ensure the connector you are trying to use has been configured correctly and been authorized for use.\n\n#### ConnectorDisabledError\n\nA request has been made to a connector that has since been disabled. This may be temporary - You can contact our team to resolve the issue.\n\n#### ConnectorRateLimitError\n\nYou sent too many request to a connector. These rate limits vary from connector to connector. You will need to try again later.\n\n#### RequestLimitError\n\nYou have reached the number of requests included in your Free Tier Subscription. You will no be able to make further requests until this limit resets at the end of the month, or talk to us about upgrading your subscription to continue immediately.\n\n#### EntityNotFoundError\n\nYou've made a request for a resource or route that does not exist. Verify your path parameters or any identifiers used to fetch this resource.\n\n#### OAuthCredentialsNotFoundError\n\nWhen adding a connector integration that implements OAuth, both a `client_id` and `client_secret` must be provided before any authorizations can be performed. Verify the integration has been configured properly before continuing.\n\n#### IntegrationNotFoundError\n\nThe requested connector integration could not be found associated to your `application_id`. Verify your `application_id` is correct, and that this connector has been added and configured for your application.\n\n#### ConnectionNotFoundError\n\nA valid connection could not be found associated to your `application_id`. Something _may_ have interrupted the authorization flow. You may need to start the connector authorization process again.\n\n#### ConnectionSettingsError\n\nThe connector has required settings that were not supplied. Verify `connection.settings` contains all required settings for the connector to be callable.\n\n#### ConnectorNotFoundError\n\nA request was made for an unknown connector. Verify your `service_id` is spelled correctly, and that this connector is enabled for your provided `unified_api`.\n\n#### OAuthRedirectUriError\n\nA request was made either in a connector authorization flow, or attempting to revoke connector access without a valid `redirect_uri`. This is the url the user should be returned to on completion of process.\n\n#### OAuthInvalidStateError\n\nThe state param is required and is used to ensure the outgoing authorization state has not been altered before the user is redirected back. It also contains required params needed to identify the connector being used. If this has been altered, the authorization will not succeed.\n\n#### OAuthCodeExchangeError\n\nWhen attempting to exchange the authorization code for an `access_token` during an OAuth flow, an error occurred. This may be temporary. You can reattempt authorization or contact our team to resolve the issue.\n\n#### OAuthConnectorError\n\nIt seems something went wrong on the connector side. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n#### MappingError\n\nThere was an error attempting to retrieve the mapping for a given attribute. We've been notified and are working to fix this issue.\n\n#### ConnectorMappingNotFoundError\n\nIt seems the implementation for this connector is incomplete. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n#### ConnectorResponseMappingNotFoundError\n\nWe were unable to retrieve the response mapping for this connector. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n#### ConnectorOperationMappingNotFoundError\n\nConnector mapping has not been implemented for the requested operation. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n#### ConnectorWorkflowMappingError\n\nThe composite api calls required for this operation have not been mapped entirely. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n#### ConnectorOperationUnsupportedError\n\nYou're attempting a call that is not supported by the connector. It's likely this operation is supported by another connector, but we're unable to implement for this one.\n\n#### PaginationNotSupportedError\n\nPagination is not yet supported for this connector, try removing limit and/or cursor from the query. It's possible this connector is in `beta` or still under development. We've been notified and are working to fix this issue.\n\n## API Design\n\n### API Styles and data formats\n\n#### REST API\n\nThe API is organized around [REST](https://restfulapi.net/), providing simple and predictable URIs to access and modify objects. Requests support standard HTTP methods like GET, PUT, POST, and DELETE and standard status codes. JSON is returned by all API responses, including errors. In all API requests, you must set the content-type HTTP header to application/json. All API requests must be made over HTTPS. Calls made over HTTP will fail.\n\n##### Available HTTP methods\n\nThe Apideck API uses HTTP verbs to understand if you want to read (GET), delete (DELETE) or create (POST) an object. When your web application cannot do a POST or DELETE, we provide the ability to set the method through the query parameter \\_method.\n\n```\nPOST /messages\nGET /messages\nGET /messages/{messageId}\nPATCH /messages/{messageId}\nDELETE /messages/{messageId}\n```\n\nResponse bodies are always UTF-8 encoded JSON objects, unless explicitly documented otherwise. For some endpoints and use cases we divert from REST to provide a better developer experience.\n\n### Schema\n\nAll API requests and response bodies adhere to a common JSON format representing individual items, collections of items, links to related items and additional meta data.\n\n### Meta\n\nMeta data can be represented as a top level member named “meta”. Any information may be provided in the meta data. It’s most common use is to return the total number of records when requesting a collection of resources.\n\n### Idempotence (upcoming)\n\nTo prevent the creation of duplicate resources, every POST method (such as one that creates a consumer record) must specify a unique value for the X-Unique-Transaction-ID header name. Uniquely identifying each unique POST request ensures that the API processes a given request once and only once.\n\nUniquely identifying new resource-creation POSTs is especially important when the outcome of a response is ambiguous because of a transient service interruption, such as a server-side timeout or network disruption. If a service interruption occurs, then the client application can safely retry the uniquely identified request without creating duplicate operations. (API endpoints that guarantee that every uniquely identified request is processed only once no matter how many times that uniquely identifiable request is made are described as idempotent.)\n\n### Request IDs\n\nEach API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.\n\n### Fixed field types\n\n#### Dates\n\nThe dates returned by the API are all represented in UTC (ISO8601 format).\n\nThis example `2019-11-14T00:55:31.820Z` is defined by the ISO 8601 standard. The T in the middle separates the year-month-day portion from the hour-minute-second portion. The Z on the end means UTC, that is, an offset-from-UTC of zero hours-minutes-seconds. The Z is pronounced \"Zulu\" per military/aviation tradition.\n\nThe ISO 8601 standard is more modern. The formats are wisely designed to be easy to parse by machine as well as easy to read by humans across cultures.\n\n#### Prices and Currencies\n\nAll prices returned by the API are represented as integer amounts in a currency’s smallest unit. For example, $5 USD would be returned as 500 (i.e, 500 cents).\n\nFor zero-decimal currencies, amounts will still be provided as an integer but without the need to divide by 100. For example, an amount of ¥5 (JPY) would be returned as 5.\n\nAll currency codes conform to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).\n\n## Support\n\nIf you have problems or need help with your case, you can always reach out to our Support.\n\n","license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"},"title":"CRM API","version":"10.0.0","x-apideck-api":"crm","x-apideck-sdk-support":true,"x-apisguru-categories":["developer_tools"],"x-logo":{"url":"https://developers.apideck.com/icon.png"},"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/apideck-libraries/openapi-specs/master/crm.yml","version":"3.0"}],"x-providerName":"apideck.com","x-serviceName":"crm","x-tags":["partner"]},"externalDocs":{"description":"Apideck Developer Docs","url":"https://developers.apideck.com"},"security":[{"apiKey":[],"applicationId":[],"consumerId":[]}],"tags":[{"description":"","name":"Companies","x-apideck-model":{"$ref":"#/components/schemas/Company"},"x-apideck-resource-id":"companies"},{"description":"","name":"Opportunities","x-apideck-model":{"$ref":"#/components/schemas/Opportunity"},"x-apideck-resource-id":"opportunities"},{"description":"","name":"Leads","x-apideck-model":{"$ref":"#/components/schemas/Lead"},"x-apideck-resource-id":"leads"},{"description":"","name":"Contacts","x-apideck-model":{"$ref":"#/components/schemas/Contact"},"x-apideck-resource-id":"contacts"},{"description":"","name":"Pipelines","x-apideck-model":{"$ref":"#/components/schemas/Pipeline"},"x-apideck-resource-id":"pipelines"},{"description":"","name":"Notes","x-apideck-model":{"$ref":"#/components/schemas/Note"},"x-apideck-resource-id":"notes"},{"description":"","name":"Users","x-apideck-model":{"$ref":"#/components/schemas/User"},"x-apideck-resource-id":"users"},{"description":"","name":"Activities","x-apideck-model":{"$ref":"#/components/schemas/Activity"},"x-apideck-resource-id":"activities"}],"paths":{"/crm/activities":{"get":{"description":"List activities","operationId":"activitiesAll","parameters":[{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/activitiesFilter"},{"$ref":"#/components/parameters/passThrough"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/GetActivitiesResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"List activities","tags":["Activities"],"x-apideck-api":"crm","x-apideck-gotchas":[{"connector":"hubspot","description":"Hubspot will only return activities from the last 30 days when using the `filter[updated_since]` parameter, with a maximum of 10.000 records. More info [here](https://legacydocs.hubspot.com/docs/methods/engagements/get-recent-engagements)."},{"connector":"salesforce","description":"If you set the limit below 200, Salesforce will only return a maximum of 2.000 activities. To retrieve more than 2.000 activities, it is recommended to fetch 200 items per page."}],"x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.activitiesAll({})\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"post":{"description":"Create activity","operationId":"activitiesAdd","parameters":[{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Activity"}}},"required":true},"responses":{"201":{"$ref":"#/components/responses/CreateActivityResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Create activity","tags":["Activities"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\nconst params = {\n  activity: {\n    activity_datetime: '2021-05-01T12:00:00.000Z',\n    duration_seconds: 1800,\n    user_id: '12345',\n    account_id: '12345',\n    contact_id: '12345',\n    company_id: '12345',\n    opportunity_id: '12345',\n    lead_id: '12345',\n    owner_id: '12345',\n    campaign_id: '12345',\n    case_id: '12345',\n    asset_id: '12345',\n    contract_id: '12345',\n    product_id: '12345',\n    solution_id: '12345',\n    custom_object_id: '12345',\n    type: 'meeting',\n    title: 'Meeting',\n    description: 'More info about the meeting',\n    note: 'An internal note about the meeting',\n    location: 'Space',\n    location_address: {\n      id: '123',\n      type: 'primary',\n      string: '25 Spring Street, Blackburn, VIC 3130',\n      name: 'HQ US',\n      line1: 'Main street',\n      line2: 'apt #',\n      line3: 'Suite #',\n      line4: 'delivery instructions',\n      street_number: '25',\n      city: 'San Francisco',\n      state: 'CA',\n      postal_code: '94104',\n      country: 'US',\n      latitude: '40.759211',\n      longitude: '-73.984638',\n      county: 'Santa Clara',\n      contact_name: 'Elon Musk',\n      salutation: 'Mr',\n      phone_number: '111-111-1111',\n      fax: '122-111-1111',\n      email: 'elon@musk.com',\n      website: 'https://elonmusk.com',\n      notes: 'Address notes or delivery instructions.',\n      row_version: '1-12345'\n    },\n    all_day_event: false,\n    private: true,\n    group_event: true,\n    event_sub_type: 'debrief',\n    group_event_type: 'Proposed',\n    child: false,\n    archived: false,\n    deleted: false,\n    show_as: 'busy',\n    done: false,\n    start_datetime: '2021-05-01T12:00:00.000Z',\n    end_datetime: '2021-05-01T12:30:00.000Z',\n    activity_date: '2021-05-01',\n    end_date: '2021-05-01',\n    recurrent: false,\n    reminder_datetime: '2021-05-01T17:00:00.000Z',\n    reminder_set: false,\n    video_conference_url: 'https://us02web.zoom.us/j/88120759396',\n    video_conference_id: 'zoom:88120759396',\n    custom_fields: [\n      {\n        id: '2389328923893298',\n        name: 'employee_level',\n        description: 'Employee Level',\n        value: 'Uses Salesforce and Marketo'\n      }\n    ],\n    attendees: [\n      {\n        name: 'Elon Musk',\n        first_name: 'Elon',\n        middle_name: 'D.',\n        last_name: 'Musk',\n        prefix: 'Mr.',\n        suffix: 'PhD',\n        email_address: 'elon@musk.com',\n        is_organizer: true,\n        status: 'accepted'\n      }\n    ],\n    custom_mappings: {}\n  }\n}\n\ntry {\n  const { data } = await apideck.crm.activitiesAdd(params)\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]}},"/crm/activities/{id}":{"delete":{"description":"Delete activity","operationId":"activitiesDelete","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/raw"}],"responses":{"200":{"$ref":"#/components/responses/DeleteActivityResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Delete activity","tags":["Activities"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.activitiesDelete({\n    id: 'id_example'\n  })\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"get":{"description":"Get activity","operationId":"activitiesOne","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/GetActivityResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Get activity","tags":["Activities"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.activitiesOne({\n    id: 'id_example'\n  })\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"patch":{"description":"Update activity","operationId":"activitiesUpdate","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/raw"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Activity"}}},"required":true},"responses":{"200":{"$ref":"#/components/responses/UpdateActivityResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Update activity","tags":["Activities"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\nconst params = {\n  id: 'id_example',\n  activity: {\n    activity_datetime: '2021-05-01T12:00:00.000Z',\n    duration_seconds: 1800,\n    user_id: '12345',\n    account_id: '12345',\n    contact_id: '12345',\n    company_id: '12345',\n    opportunity_id: '12345',\n    lead_id: '12345',\n    owner_id: '12345',\n    campaign_id: '12345',\n    case_id: '12345',\n    asset_id: '12345',\n    contract_id: '12345',\n    product_id: '12345',\n    solution_id: '12345',\n    custom_object_id: '12345',\n    type: 'meeting',\n    title: 'Meeting',\n    description: 'More info about the meeting',\n    note: 'An internal note about the meeting',\n    location: 'Space',\n    location_address: {\n      id: '123',\n      type: 'primary',\n      string: '25 Spring Street, Blackburn, VIC 3130',\n      name: 'HQ US',\n      line1: 'Main street',\n      line2: 'apt #',\n      line3: 'Suite #',\n      line4: 'delivery instructions',\n      street_number: '25',\n      city: 'San Francisco',\n      state: 'CA',\n      postal_code: '94104',\n      country: 'US',\n      latitude: '40.759211',\n      longitude: '-73.984638',\n      county: 'Santa Clara',\n      contact_name: 'Elon Musk',\n      salutation: 'Mr',\n      phone_number: '111-111-1111',\n      fax: '122-111-1111',\n      email: 'elon@musk.com',\n      website: 'https://elonmusk.com',\n      notes: 'Address notes or delivery instructions.',\n      row_version: '1-12345'\n    },\n    all_day_event: false,\n    private: true,\n    group_event: true,\n    event_sub_type: 'debrief',\n    group_event_type: 'Proposed',\n    child: false,\n    archived: false,\n    deleted: false,\n    show_as: 'busy',\n    done: false,\n    start_datetime: '2021-05-01T12:00:00.000Z',\n    end_datetime: '2021-05-01T12:30:00.000Z',\n    activity_date: '2021-05-01',\n    end_date: '2021-05-01',\n    recurrent: false,\n    reminder_datetime: '2021-05-01T17:00:00.000Z',\n    reminder_set: false,\n    video_conference_url: 'https://us02web.zoom.us/j/88120759396',\n    video_conference_id: 'zoom:88120759396',\n    custom_fields: [\n      {\n        id: '2389328923893298',\n        name: 'employee_level',\n        description: 'Employee Level',\n        value: 'Uses Salesforce and Marketo'\n      }\n    ],\n    attendees: [\n      {\n        name: 'Elon Musk',\n        first_name: 'Elon',\n        middle_name: 'D.',\n        last_name: 'Musk',\n        prefix: 'Mr.',\n        suffix: 'PhD',\n        email_address: 'elon@musk.com',\n        is_organizer: true,\n        status: 'accepted'\n      }\n    ],\n    custom_mappings: {}\n  }\n}\n\ntry {\n  const { data } = await apideck.crm.activitiesUpdate(params)\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]}},"/crm/companies":{"get":{"description":"List companies","operationId":"companiesAll","parameters":[{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/companiesFilter"},{"$ref":"#/components/parameters/companiesSort"},{"$ref":"#/components/parameters/passThrough"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/GetCompaniesResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"List companies","tags":["Companies"],"x-apideck-api":"crm","x-apideck-gotchas":[{"connector":"hubspot","description":"When using a filter or sorting for companies, Hubspot will only return a maximum of 10.000 companies."},{"connector":"salesforce","description":"If you set the limit below 200, Salesforce will only return a maximum of 2.000 companies. To retrieve more than 2.000 companies, it is recommended to fetch 200 items per page."}],"x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.companiesAll({})\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"post":{"description":"Create company","operationId":"companiesAdd","parameters":[{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}},"required":true},"responses":{"201":{"$ref":"#/components/responses/CreateCompanyResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Create company","tags":["Companies"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\nconst params = {\n  company: {\n    name: 'SpaceX',\n    owner_id: '12345',\n    image: 'https://www.spacex.com/static/images/share.jpg',\n    description:\n      'Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.',\n    vat_number: 'BE0689615164',\n    currency: 'USD',\n    status: 'Open',\n    fax: '+12129876543',\n    annual_revenue: '+$35m',\n    number_of_employees: '500-1000',\n    industry: 'Apparel',\n    ownership: 'Public',\n    sales_tax_number: '12456EN',\n    payee_number: '78932EN',\n    abn_or_tfn: '46 115 614 695',\n    abn_branch: '123',\n    acn: 'XXX XXX XXX',\n    first_name: 'Elon',\n    last_name: 'Musk',\n    bank_accounts: [\n      {\n        bank_name: 'Monzo',\n        account_number: '123465',\n        account_name: 'SPACEX LLC',\n        account_type: 'credit_card',\n        iban: 'CH2989144532982975332',\n        bic: 'AUDSCHGGXXX',\n        routing_number: '012345678',\n        bsb_number: '062-001',\n        branch_identifier: '001',\n        bank_code: 'BNH',\n        currency: 'USD'\n      }\n    ],\n    websites: [\n      {\n        id: '12345',\n        url: 'http://example.com',\n        type: 'primary'\n      }\n    ],\n    addresses: [\n      {\n        id: '123',\n        type: 'primary',\n        string: '25 Spring Street, Blackburn, VIC 3130',\n        name: 'HQ US',\n        line1: 'Main street',\n        line2: 'apt #',\n        line3: 'Suite #',\n        line4: 'delivery instructions',\n        street_number: '25',\n        city: 'San Francisco',\n        state: 'CA',\n        postal_code: '94104',\n        country: 'US',\n        latitude: '40.759211',\n        longitude: '-73.984638',\n        county: 'Santa Clara',\n        contact_name: 'Elon Musk',\n        salutation: 'Mr',\n        phone_number: '111-111-1111',\n        fax: '122-111-1111',\n        email: 'elon@musk.com',\n        website: 'https://elonmusk.com',\n        notes: 'Address notes or delivery instructions.',\n        row_version: '1-12345'\n      }\n    ],\n    social_links: [\n      {\n        id: '12345',\n        url: 'https://www.twitter.com/apideck',\n        type: 'twitter'\n      }\n    ],\n    phone_numbers: [\n      {\n        id: '12345',\n        country_code: '1',\n        area_code: '323',\n        number: '111-111-1111',\n        extension: '105',\n        type: 'primary'\n      }\n    ],\n    emails: [\n      {\n        id: '123',\n        email: 'elon@musk.com',\n        type: 'primary'\n      }\n    ],\n    row_type: {\n      id: '12345',\n      name: 'Customer Account'\n    },\n    custom_fields: [\n      {\n        id: '2389328923893298',\n        name: 'employee_level',\n        description: 'Employee Level',\n        value: 'Uses Salesforce and Marketo'\n      }\n    ],\n    tags: ['New'],\n    read_only: false,\n    salutation: 'Mr',\n    birthday: '2000-08-12',\n    custom_mappings: {}\n  }\n}\n\ntry {\n  const { data } = await apideck.crm.companiesAdd(params)\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]}},"/crm/companies/{id}":{"delete":{"description":"Delete company","operationId":"companiesDelete","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"}],"responses":{"200":{"$ref":"#/components/responses/DeleteCompanyResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Delete company","tags":["Companies"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.companiesDelete({\n    id: 'id_example'\n  })\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"get":{"description":"Get company","operationId":"companiesOne","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/GetCompanyResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Get company","tags":["Companies"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.companiesOne({\n    id: 'id_example'\n  })\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"patch":{"description":"Update company","operationId":"companiesUpdate","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Company"}}},"required":true},"responses":{"200":{"$ref":"#/components/responses/UpdateCompanyResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Update company","tags":["Companies"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\nconst params = {\n  id: 'id_example',\n  company: {\n    name: 'SpaceX',\n    owner_id: '12345',\n    image: 'https://www.spacex.com/static/images/share.jpg',\n    description:\n      'Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.',\n    vat_number: 'BE0689615164',\n    currency: 'USD',\n    status: 'Open',\n    fax: '+12129876543',\n    annual_revenue: '+$35m',\n    number_of_employees: '500-1000',\n    industry: 'Apparel',\n    ownership: 'Public',\n    sales_tax_number: '12456EN',\n    payee_number: '78932EN',\n    abn_or_tfn: '46 115 614 695',\n    abn_branch: '123',\n    acn: 'XXX XXX XXX',\n    first_name: 'Elon',\n    last_name: 'Musk',\n    bank_accounts: [\n      {\n        bank_name: 'Monzo',\n        account_number: '123465',\n        account_name: 'SPACEX LLC',\n        account_type: 'credit_card',\n        iban: 'CH2989144532982975332',\n        bic: 'AUDSCHGGXXX',\n        routing_number: '012345678',\n        bsb_number: '062-001',\n        branch_identifier: '001',\n        bank_code: 'BNH',\n        currency: 'USD'\n      }\n    ],\n    websites: [\n      {\n        id: '12345',\n        url: 'http://example.com',\n        type: 'primary'\n      }\n    ],\n    addresses: [\n      {\n        id: '123',\n        type: 'primary',\n        string: '25 Spring Street, Blackburn, VIC 3130',\n        name: 'HQ US',\n        line1: 'Main street',\n        line2: 'apt #',\n        line3: 'Suite #',\n        line4: 'delivery instructions',\n        street_number: '25',\n        city: 'San Francisco',\n        state: 'CA',\n        postal_code: '94104',\n        country: 'US',\n        latitude: '40.759211',\n        longitude: '-73.984638',\n        county: 'Santa Clara',\n        contact_name: 'Elon Musk',\n        salutation: 'Mr',\n        phone_number: '111-111-1111',\n        fax: '122-111-1111',\n        email: 'elon@musk.com',\n        website: 'https://elonmusk.com',\n        notes: 'Address notes or delivery instructions.',\n        row_version: '1-12345'\n      }\n    ],\n    social_links: [\n      {\n        id: '12345',\n        url: 'https://www.twitter.com/apideck',\n        type: 'twitter'\n      }\n    ],\n    phone_numbers: [\n      {\n        id: '12345',\n        country_code: '1',\n        area_code: '323',\n        number: '111-111-1111',\n        extension: '105',\n        type: 'primary'\n      }\n    ],\n    emails: [\n      {\n        id: '123',\n        email: 'elon@musk.com',\n        type: 'primary'\n      }\n    ],\n    row_type: {\n      id: '12345',\n      name: 'Customer Account'\n    },\n    custom_fields: [\n      {\n        id: '2389328923893298',\n        name: 'employee_level',\n        description: 'Employee Level',\n        value: 'Uses Salesforce and Marketo'\n      }\n    ],\n    tags: ['New'],\n    read_only: false,\n    salutation: 'Mr',\n    birthday: '2000-08-12',\n    custom_mappings: {}\n  }\n}\n\ntry {\n  const { data } = await apideck.crm.companiesUpdate(params)\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]}},"/crm/contacts":{"get":{"description":"List contacts","operationId":"contactsAll","parameters":[{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/contactsFilter"},{"$ref":"#/components/parameters/contactsSort"},{"$ref":"#/components/parameters/passThrough"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/GetContactsResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"List contacts","tags":["Contacts"],"x-apideck-api":"crm","x-apideck-gotchas":[{"connector":"hubspot","description":"When using a filter or sorting for contacts, Hubspot will only return a maximum of 10.000 contacts."},{"connector":"salesforce","description":"If you set the limit below 200, Salesforce will only return a maximum of 2.000 contacts. To retrieve more than 2.000 contacts, it is recommended to fetch 200 items per page."}],"x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.contactsAll({})\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"post":{"description":"Create contact","operationId":"contactsAdd","parameters":[{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}},"required":true},"responses":{"201":{"$ref":"#/components/responses/CreateContactResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Create contact","tags":["Contacts"],"x-apideck-api":"crm","x-apideck-gotchas":[{"connector":"hubspot","description":"When creating a contact, it is advised to always include an unique email address since Hubspot uses it to prevent duplicate contacts in HubSpot. More info on the [Hubspot developer docs](https://developers.hubspot.com/docs/api/crm/contacts)."}],"x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\nconst params = {\n  contact: {\n    name: 'Elon Musk',\n    owner_id: '54321',\n    type: 'personal',\n    company_id: '23456',\n    company_name: '23456',\n    lead_id: '34567',\n    first_name: 'Elon',\n    middle_name: 'D.',\n    last_name: 'Musk',\n    prefix: 'Mr.',\n    suffix: 'PhD',\n    title: 'CEO',\n    department: 'Engineering',\n    language: 'EN',\n    gender: 'female',\n    birthday: '2000-08-12',\n    image: 'https://unavatar.io/elon-musk',\n    photo_url: 'https://unavatar.io/elon-musk',\n    lead_source: 'Cold Call',\n    fax: '+12129876543',\n    description: 'Internal champion',\n    current_balance: 10.5,\n    status: 'open',\n    active: true,\n    websites: [\n      {\n        id: '12345',\n        url: 'http://example.com',\n        type: 'primary'\n      }\n    ],\n    addresses: [\n      {\n        id: '123',\n        type: 'primary',\n        string: '25 Spring Street, Blackburn, VIC 3130',\n        name: 'HQ US',\n        line1: 'Main street',\n        line2: 'apt #',\n        line3: 'Suite #',\n        line4: 'delivery instructions',\n        street_number: '25',\n        city: 'San Francisco',\n        state: 'CA',\n        postal_code: '94104',\n        country: 'US',\n        latitude: '40.759211',\n        longitude: '-73.984638',\n        county: 'Santa Clara',\n        contact_name: 'Elon Musk',\n        salutation: 'Mr',\n        phone_number: '111-111-1111',\n        fax: '122-111-1111',\n        email: 'elon@musk.com',\n        website: 'https://elonmusk.com',\n        notes: 'Address notes or delivery instructions.',\n        row_version: '1-12345'\n      }\n    ],\n    social_links: [\n      {\n        id: '12345',\n        url: 'https://www.twitter.com/apideck',\n        type: 'twitter'\n      }\n    ],\n    phone_numbers: [\n      {\n        id: '12345',\n        country_code: '1',\n        area_code: '323',\n        number: '111-111-1111',\n        extension: '105',\n        type: 'primary'\n      }\n    ],\n    emails: [\n      {\n        id: '123',\n        email: 'elon@musk.com',\n        type: 'primary'\n      }\n    ],\n    email_domain: 'gmail.com',\n    custom_fields: [\n      {\n        id: '2389328923893298',\n        name: 'employee_level',\n        description: 'Employee Level',\n        value: 'Uses Salesforce and Marketo'\n      }\n    ],\n    tags: ['New'],\n    custom_mappings: {}\n  }\n}\n\ntry {\n  const { data } = await apideck.crm.contactsAdd(params)\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]}},"/crm/contacts/{id}":{"delete":{"description":"Delete contact","operationId":"contactsDelete","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/raw"}],"responses":{"200":{"$ref":"#/components/responses/DeleteContactResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Delete contact","tags":["Contacts"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.contactsDelete({\n    id: 'id_example'\n  })\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"get":{"description":"Get contact","operationId":"contactsOne","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/GetContactResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Get contact","tags":["Contacts"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.contactsOne({\n    id: 'id_example'\n  })\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"patch":{"description":"Update contact","operationId":"contactsUpdate","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/raw"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}},"required":true},"responses":{"200":{"$ref":"#/components/responses/UpdateContactResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Update contact","tags":["Contacts"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\nconst params = {\n  id: 'id_example',\n  contact: {\n    name: 'Elon Musk',\n    owner_id: '54321',\n    type: 'personal',\n    company_id: '23456',\n    company_name: '23456',\n    lead_id: '34567',\n    first_name: 'Elon',\n    middle_name: 'D.',\n    last_name: 'Musk',\n    prefix: 'Mr.',\n    suffix: 'PhD',\n    title: 'CEO',\n    department: 'Engineering',\n    language: 'EN',\n    gender: 'female',\n    birthday: '2000-08-12',\n    image: 'https://unavatar.io/elon-musk',\n    photo_url: 'https://unavatar.io/elon-musk',\n    lead_source: 'Cold Call',\n    fax: '+12129876543',\n    description: 'Internal champion',\n    current_balance: 10.5,\n    status: 'open',\n    active: true,\n    websites: [\n      {\n        id: '12345',\n        url: 'http://example.com',\n        type: 'primary'\n      }\n    ],\n    addresses: [\n      {\n        id: '123',\n        type: 'primary',\n        string: '25 Spring Street, Blackburn, VIC 3130',\n        name: 'HQ US',\n        line1: 'Main street',\n        line2: 'apt #',\n        line3: 'Suite #',\n        line4: 'delivery instructions',\n        street_number: '25',\n        city: 'San Francisco',\n        state: 'CA',\n        postal_code: '94104',\n        country: 'US',\n        latitude: '40.759211',\n        longitude: '-73.984638',\n        county: 'Santa Clara',\n        contact_name: 'Elon Musk',\n        salutation: 'Mr',\n        phone_number: '111-111-1111',\n        fax: '122-111-1111',\n        email: 'elon@musk.com',\n        website: 'https://elonmusk.com',\n        notes: 'Address notes or delivery instructions.',\n        row_version: '1-12345'\n      }\n    ],\n    social_links: [\n      {\n        id: '12345',\n        url: 'https://www.twitter.com/apideck',\n        type: 'twitter'\n      }\n    ],\n    phone_numbers: [\n      {\n        id: '12345',\n        country_code: '1',\n        area_code: '323',\n        number: '111-111-1111',\n        extension: '105',\n        type: 'primary'\n      }\n    ],\n    emails: [\n      {\n        id: '123',\n        email: 'elon@musk.com',\n        type: 'primary'\n      }\n    ],\n    email_domain: 'gmail.com',\n    custom_fields: [\n      {\n        id: '2389328923893298',\n        name: 'employee_level',\n        description: 'Employee Level',\n        value: 'Uses Salesforce and Marketo'\n      }\n    ],\n    tags: ['New'],\n    custom_mappings: {}\n  }\n}\n\ntry {\n  const { data } = await apideck.crm.contactsUpdate(params)\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]}},"/crm/leads":{"get":{"description":"List leads","operationId":"leadsAll","parameters":[{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/leadsFilter"},{"$ref":"#/components/parameters/leadsSort"},{"$ref":"#/components/parameters/passThrough"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/GetLeadsResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"List leads","tags":["Leads"],"x-apideck-api":"crm","x-apideck-gotchas":[{"connector":"hubspot","description":"When using a filter or sorting for leads, Hubspot will only return a maximum of 10.000 leads."},{"connector":"salesforce","description":"If you set the limit below 200, Salesforce will only return a maximum of 2.000 leads. To retrieve more than 2.000 leads, it is recommended to fetch 200 items per page."}],"x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.leadsAll({})\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"post":{"description":"Create lead","operationId":"leadsAdd","parameters":[{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lead"}}},"required":true},"responses":{"201":{"$ref":"#/components/responses/CreateLeadResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Create lead","tags":["Leads"],"x-apideck-api":"crm","x-apideck-gotchas":[{"connector":"hubspot","description":"When creating a lead, it is advised to always include an unique email address since Hubspot uses it to prevent duplicate contacts in HubSpot. More info on the [Hubspot developer docs](https://developers.hubspot.com/docs/api/crm/contacts)."},{"connector":"pipedrive","description":"When creating a lead, it is required to include an existing `company_id`. More info on the [Pipedrive developer docs](https://pipedrive.readme.io/docs/adding-a-lead)."}],"x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\nconst params = {\n  lead: {\n    name: 'Elon Musk',\n    company_name: 'Spacex',\n    owner_id: '54321',\n    company_id: '2',\n    lead_id: '2',\n    lead_source: 'Cold Call',\n    first_name: 'Elon',\n    last_name: 'Musk',\n    description: 'A thinker',\n    prefix: 'Sir',\n    title: 'CEO',\n    language: 'EN',\n    status: 'New',\n    monetary_amount: 75000,\n    currency: 'USD',\n    fax: '+12129876543',\n    websites: [\n      {\n        id: '12345',\n        url: 'http://example.com',\n        type: 'primary'\n      }\n    ],\n    addresses: [\n      {\n        id: '123',\n        type: 'primary',\n        string: '25 Spring Street, Blackburn, VIC 3130',\n        name: 'HQ US',\n        line1: 'Main street',\n        line2: 'apt #',\n        line3: 'Suite #',\n        line4: 'delivery instructions',\n        street_number: '25',\n        city: 'San Francisco',\n        state: 'CA',\n        postal_code: '94104',\n        country: 'US',\n        latitude: '40.759211',\n        longitude: '-73.984638',\n        county: 'Santa Clara',\n        contact_name: 'Elon Musk',\n        salutation: 'Mr',\n        phone_number: '111-111-1111',\n        fax: '122-111-1111',\n        email: 'elon@musk.com',\n        website: 'https://elonmusk.com',\n        notes: 'Address notes or delivery instructions.',\n        row_version: '1-12345'\n      }\n    ],\n    social_links: [\n      {\n        id: '12345',\n        url: 'https://www.twitter.com/apideck',\n        type: 'twitter'\n      }\n    ],\n    phone_numbers: [\n      {\n        id: '12345',\n        country_code: '1',\n        area_code: '323',\n        number: '111-111-1111',\n        extension: '105',\n        type: 'primary'\n      }\n    ],\n    emails: [\n      {\n        id: '123',\n        email: 'elon@musk.com',\n        type: 'primary'\n      }\n    ],\n    custom_fields: [\n      {\n        id: '2389328923893298',\n        name: 'employee_level',\n        description: 'Employee Level',\n        value: 'Uses Salesforce and Marketo'\n      }\n    ],\n    tags: ['New'],\n    custom_mappings: {}\n  }\n}\n\ntry {\n  const { data } = await apideck.crm.leadsAdd(params)\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]}},"/crm/leads/{id}":{"delete":{"description":"Delete lead","operationId":"leadsDelete","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/raw"}],"responses":{"200":{"$ref":"#/components/responses/DeleteLeadResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Delete lead","tags":["Leads"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.leadsDelete({\n    id: 'id_example'\n  })\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"get":{"description":"Get lead","operationId":"leadsOne","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/GetCrmLeadResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Get lead","tags":["Leads"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.leadsOne({\n    id: 'id_example'\n  })\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"patch":{"description":"Update lead","operationId":"leadsUpdate","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/raw"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Lead"}}},"required":true},"responses":{"200":{"$ref":"#/components/responses/UpdateLeadResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Update lead","tags":["Leads"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\nconst params = {\n  id: 'id_example',\n  lead: {\n    name: 'Elon Musk',\n    company_name: 'Spacex',\n    owner_id: '54321',\n    company_id: '2',\n    lead_id: '2',\n    lead_source: 'Cold Call',\n    first_name: 'Elon',\n    last_name: 'Musk',\n    description: 'A thinker',\n    prefix: 'Sir',\n    title: 'CEO',\n    language: 'EN',\n    status: 'New',\n    monetary_amount: 75000,\n    currency: 'USD',\n    fax: '+12129876543',\n    websites: [\n      {\n        id: '12345',\n        url: 'http://example.com',\n        type: 'primary'\n      }\n    ],\n    addresses: [\n      {\n        id: '123',\n        type: 'primary',\n        string: '25 Spring Street, Blackburn, VIC 3130',\n        name: 'HQ US',\n        line1: 'Main street',\n        line2: 'apt #',\n        line3: 'Suite #',\n        line4: 'delivery instructions',\n        street_number: '25',\n        city: 'San Francisco',\n        state: 'CA',\n        postal_code: '94104',\n        country: 'US',\n        latitude: '40.759211',\n        longitude: '-73.984638',\n        county: 'Santa Clara',\n        contact_name: 'Elon Musk',\n        salutation: 'Mr',\n        phone_number: '111-111-1111',\n        fax: '122-111-1111',\n        email: 'elon@musk.com',\n        website: 'https://elonmusk.com',\n        notes: 'Address notes or delivery instructions.',\n        row_version: '1-12345'\n      }\n    ],\n    social_links: [\n      {\n        id: '12345',\n        url: 'https://www.twitter.com/apideck',\n        type: 'twitter'\n      }\n    ],\n    phone_numbers: [\n      {\n        id: '12345',\n        country_code: '1',\n        area_code: '323',\n        number: '111-111-1111',\n        extension: '105',\n        type: 'primary'\n      }\n    ],\n    emails: [\n      {\n        id: '123',\n        email: 'elon@musk.com',\n        type: 'primary'\n      }\n    ],\n    custom_fields: [\n      {\n        id: '2389328923893298',\n        name: 'employee_level',\n        description: 'Employee Level',\n        value: 'Uses Salesforce and Marketo'\n      }\n    ],\n    tags: ['New'],\n    custom_mappings: {}\n  }\n}\n\ntry {\n  const { data } = await apideck.crm.leadsUpdate(params)\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]}},"/crm/notes":{"get":{"description":"List notes","operationId":"notesAll","parameters":[{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/passThrough"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/GetNotesResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"List notes","tags":["Notes"],"x-apideck-api":"crm","x-apideck-gotchas":[{"connector":"salesforce","description":"If you set the limit below 200, Salesforce will only return a maximum of 2.000 notes. To retrieve more than 2.000 notes, it is recommended to fetch 200 items per page."}],"x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.notesAll({})\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"post":{"description":"Create note","operationId":"notesAdd","parameters":[{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}},"required":true},"responses":{"201":{"$ref":"#/components/responses/CreateNoteResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Create note","tags":["Notes"],"x-apideck-api":"crm","x-apideck-gotchas":[{"connector":"salesforce","description":"When creating a note in Salesforce, you can only associate it with one resource (such as a lead, company or opportunity) at a time. You cannot combine multiple resources or associate the note with more than one resource in a single API call."}],"x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\nconst params = {\n  note: {\n    title: 'Meeting Notes',\n    content: 'Office hours are 9AM-6PM',\n    owner_id: '12345',\n    contact_id: '12345',\n    company_id: '12345',\n    opportunity_id: '12345',\n    lead_id: '12345',\n    active: true,\n    custom_mappings: {}\n  }\n}\n\ntry {\n  const { data } = await apideck.crm.notesAdd(params)\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]}},"/crm/notes/{id}":{"delete":{"description":"Delete note","operationId":"notesDelete","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/raw"}],"responses":{"200":{"$ref":"#/components/responses/DeleteNoteResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Delete note","tags":["Notes"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.notesDelete({\n    id: 'id_example'\n  })\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"get":{"description":"Get note","operationId":"notesOne","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/GetNoteResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Get note","tags":["Notes"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.notesOne({\n    id: 'id_example'\n  })\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"patch":{"description":"Update note","operationId":"notesUpdate","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/raw"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Note"}}},"required":true},"responses":{"200":{"$ref":"#/components/responses/UpdateNoteResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Update note","tags":["Notes"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\nconst params = {\n  id: 'id_example',\n  note: {\n    title: 'Meeting Notes',\n    content: 'Office hours are 9AM-6PM',\n    owner_id: '12345',\n    contact_id: '12345',\n    company_id: '12345',\n    opportunity_id: '12345',\n    lead_id: '12345',\n    active: true,\n    custom_mappings: {}\n  }\n}\n\ntry {\n  const { data } = await apideck.crm.notesUpdate(params)\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]}},"/crm/opportunities":{"get":{"description":"List opportunities","operationId":"opportunitiesAll","parameters":[{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/opportunitiesFilter"},{"$ref":"#/components/parameters/opportunitiesSort"},{"$ref":"#/components/parameters/passThrough"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/GetOpportunitiesResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"List opportunities","tags":["Opportunities"],"x-apideck-api":"crm","x-apideck-gotchas":[{"connector":"hubspot","description":"When using a filter or sorting for opportunities, Hubspot will only return a maximum of 10.000 opportunities and omit the company_id, primary_contact_id, company_id, contact_ids, lead_id and contact_id."},{"connector":"salesforce","description":"If you set the limit below 200, Salesforce will only return a maximum of 2.000 opportunities. To retrieve more than 2.000 opportunities, it is recommended to fetch 200 items per page."}],"x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.opportunitiesAll({})\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"post":{"description":"Create opportunity","operationId":"opportunitiesAdd","parameters":[{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Opportunity"}}},"required":true},"responses":{"201":{"$ref":"#/components/responses/CreateOpportunityResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Create opportunity","tags":["Opportunities"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\nconst params = {\n  opportunity: {\n    title: 'New Rocket',\n    primary_contact_id: '12345',\n    description:\n      'Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.',\n    type: 'Existing Customer - Upgrade',\n    monetary_amount: 75000,\n    currency: 'USD',\n    win_probability: 40,\n    close_date: '2020-10-30',\n    loss_reason_id: '12345',\n    loss_reason: 'No budget',\n    won_reason_id: '12345',\n    won_reason: 'Best pitch',\n    pipeline_id: '12345',\n    pipeline_stage_id: '12345',\n    source_id: '12345',\n    lead_id: '12345',\n    lead_source: 'Website',\n    contact_id: '12345',\n    contact_ids: ['12345'],\n    company_id: '12345',\n    company_name: 'Copper',\n    owner_id: '12345',\n    priority: 'None',\n    status: 'Open',\n    status_id: '12345',\n    tags: ['New'],\n    custom_fields: [\n      {\n        id: '2389328923893298',\n        name: 'employee_level',\n        description: 'Employee Level',\n        value: 'Uses Salesforce and Marketo'\n      }\n    ],\n    stage_last_changed_at: '2020-09-30T07:43:32.000Z',\n    custom_mappings: {}\n  }\n}\n\ntry {\n  const { data } = await apideck.crm.opportunitiesAdd(params)\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]}},"/crm/opportunities/{id}":{"delete":{"description":"Delete opportunity","operationId":"opportunitiesDelete","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/raw"}],"responses":{"200":{"$ref":"#/components/responses/DeleteOpportunityResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Delete opportunity","tags":["Opportunities"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.opportunitiesDelete({\n    id: 'id_example'\n  })\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"get":{"description":"Get opportunity","operationId":"opportunitiesOne","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/GetOpportunityResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Get opportunity","tags":["Opportunities"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.opportunitiesOne({\n    id: 'id_example'\n  })\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"patch":{"description":"Update opportunity","operationId":"opportunitiesUpdate","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/raw"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Opportunity"}}},"required":true},"responses":{"200":{"$ref":"#/components/responses/UpdateOpportunityResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Update opportunity","tags":["Opportunities"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\nconst params = {\n  id: 'id_example',\n  opportunity: {\n    title: 'New Rocket',\n    primary_contact_id: '12345',\n    description:\n      'Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.',\n    type: 'Existing Customer - Upgrade',\n    monetary_amount: 75000,\n    currency: 'USD',\n    win_probability: 40,\n    close_date: '2020-10-30',\n    loss_reason_id: '12345',\n    loss_reason: 'No budget',\n    won_reason_id: '12345',\n    won_reason: 'Best pitch',\n    pipeline_id: '12345',\n    pipeline_stage_id: '12345',\n    source_id: '12345',\n    lead_id: '12345',\n    lead_source: 'Website',\n    contact_id: '12345',\n    contact_ids: ['12345'],\n    company_id: '12345',\n    company_name: 'Copper',\n    owner_id: '12345',\n    priority: 'None',\n    status: 'Open',\n    status_id: '12345',\n    tags: ['New'],\n    custom_fields: [\n      {\n        id: '2389328923893298',\n        name: 'employee_level',\n        description: 'Employee Level',\n        value: 'Uses Salesforce and Marketo'\n      }\n    ],\n    stage_last_changed_at: '2020-09-30T07:43:32.000Z',\n    custom_mappings: {}\n  }\n}\n\ntry {\n  const { data } = await apideck.crm.opportunitiesUpdate(params)\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]}},"/crm/pipelines":{"get":{"description":"List pipelines","operationId":"pipelinesAll","parameters":[{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/passThrough"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/GetPipelinesResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"List pipelines","tags":["Pipelines"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.pipelinesAll({})\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"post":{"description":"Create pipeline","operationId":"pipelinesAdd","parameters":[{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}},"required":true},"responses":{"201":{"$ref":"#/components/responses/CreatePipelineResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Create pipeline","tags":["Pipelines"],"x-apideck-api":"crm","x-apideck-upcoming":true,"x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\nconst params = {\n  pipeline: {\n    id: 'default',\n    name: 'Sales Pipeline',\n    currency: 'USD',\n    archived: false,\n    active: false,\n    display_order: 1,\n    win_probability_enabled: true,\n    stages: [\n      {\n        name: 'Contract Sent',\n        value: 'CONTRACT_SENT',\n        win_probability: 50,\n        display_order: 1\n      }\n    ]\n  }\n}\n\ntry {\n  const { data } = await apideck.crm.pipelinesAdd(params)\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]}},"/crm/pipelines/{id}":{"delete":{"description":"Delete pipeline","operationId":"pipelinesDelete","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/raw"}],"responses":{"200":{"$ref":"#/components/responses/DeletePipelineResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Delete pipeline","tags":["Pipelines"],"x-apideck-api":"crm","x-apideck-upcoming":true,"x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.pipelinesDelete({\n    id: 'id_example'\n  })\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"get":{"description":"Get pipeline","operationId":"pipelinesOne","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/GetPipelineResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Get pipeline","tags":["Pipelines"],"x-apideck-api":"crm","x-apideck-upcoming":true,"x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.pipelinesOne({\n    id: 'id_example'\n  })\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"patch":{"description":"Update pipeline","operationId":"pipelinesUpdate","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/raw"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}},"required":true},"responses":{"200":{"$ref":"#/components/responses/UpdatePipelineResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Update pipeline","tags":["Pipelines"],"x-apideck-api":"crm","x-apideck-upcoming":true,"x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\nconst params = {\n  id: 'id_example',\n  pipeline: {\n    id: 'default',\n    name: 'Sales Pipeline',\n    currency: 'USD',\n    archived: false,\n    active: false,\n    display_order: 1,\n    win_probability_enabled: true,\n    stages: [\n      {\n        name: 'Contract Sent',\n        value: 'CONTRACT_SENT',\n        win_probability: 50,\n        display_order: 1\n      }\n    ]\n  }\n}\n\ntry {\n  const { data } = await apideck.crm.pipelinesUpdate(params)\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]}},"/crm/users":{"get":{"description":"List users","operationId":"usersAll","parameters":[{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/cursor"},{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/passThrough"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/GetUsersResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"List users","tags":["Users"],"x-apideck-api":"crm","x-apideck-gotchas":[{"connector":"hubspot","description":"HubSpot owners are mapped to CRM users in Apideck. HubSpot owners and HubSpot users (people who can log into HubSpot) aren't necessarily the same, as you may have owners created through an integration."},{"connector":"salesforce","description":"If you set the limit below 200, Salesforce will only return a maximum of 2.000 users. To retrieve more than 2.000 users, it is recommended to fetch 200 items per page."}],"x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.usersAll({})\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"post":{"description":"Create user","operationId":"usersAdd","parameters":[{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"required":true},"responses":{"201":{"$ref":"#/components/responses/CreateUserResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Create user","tags":["Users"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\nconst params = {\n  user: {\n    parent_id: '54321',\n    username: 'masterofcoin',\n    first_name: 'Elon',\n    last_name: 'Musk',\n    title: 'CEO',\n    division: 'Europe',\n    department: 'R&D',\n    company_name: 'SpaceX',\n    employee_number: '123456-AB',\n    description: 'A description',\n    image: 'https://logo.clearbit.com/spacex.com?s=128',\n    language: 'EN',\n    status: 'active',\n    password: 'supersecretpassword',\n    addresses: [\n      {\n        id: '123',\n        type: 'primary',\n        string: '25 Spring Street, Blackburn, VIC 3130',\n        name: 'HQ US',\n        line1: 'Main street',\n        line2: 'apt #',\n        line3: 'Suite #',\n        line4: 'delivery instructions',\n        street_number: '25',\n        city: 'San Francisco',\n        state: 'CA',\n        postal_code: '94104',\n        country: 'US',\n        latitude: '40.759211',\n        longitude: '-73.984638',\n        county: 'Santa Clara',\n        contact_name: 'Elon Musk',\n        salutation: 'Mr',\n        phone_number: '111-111-1111',\n        fax: '122-111-1111',\n        email: 'elon@musk.com',\n        website: 'https://elonmusk.com',\n        notes: 'Address notes or delivery instructions.',\n        row_version: '1-12345'\n      }\n    ],\n    phone_numbers: [\n      {\n        id: '12345',\n        country_code: '1',\n        area_code: '323',\n        number: '111-111-1111',\n        extension: '105',\n        type: 'primary'\n      }\n    ],\n    emails: [\n      {\n        id: '123',\n        email: 'elon@musk.com',\n        type: 'primary'\n      }\n    ],\n    custom_mappings: {}\n  }\n}\n\ntry {\n  const { data } = await apideck.crm.usersAdd(params)\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]}},"/crm/users/{id}":{"delete":{"description":"Delete user","operationId":"usersDelete","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/raw"}],"responses":{"200":{"$ref":"#/components/responses/DeleteUserResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Delete user","tags":["Users"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.usersDelete({\n    id: 'id_example'\n  })\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"get":{"description":"Get user","operationId":"usersOne","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/raw"},{"$ref":"#/components/parameters/fields"}],"responses":{"200":{"$ref":"#/components/responses/GetUserResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Get user","tags":["Users"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\ntry {\n  const { data } = await apideck.crm.usersOne({\n    id: 'id_example'\n  })\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]},"patch":{"description":"Update user","operationId":"usersUpdate","parameters":[{"$ref":"#/components/parameters/id"},{"$ref":"#/components/parameters/consumerId"},{"$ref":"#/components/parameters/applicationId"},{"$ref":"#/components/parameters/serviceId"},{"$ref":"#/components/parameters/raw"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/User"}}},"required":true},"responses":{"200":{"$ref":"#/components/responses/UpdateUserResponse"},"400":{"$ref":"#/components/responses/BadRequestResponse"},"401":{"$ref":"#/components/responses/UnauthorizedResponse"},"402":{"$ref":"#/components/responses/PaymentRequiredResponse"},"404":{"$ref":"#/components/responses/NotFoundResponse"},"422":{"$ref":"#/components/responses/UnprocessableResponse"},"default":{"$ref":"#/components/responses/UnexpectedErrorResponse"}},"security":[{"apiKey":[]}],"summary":"Update user","tags":["Users"],"x-apideck-api":"crm","x-codeSamples":[{"label":"Node","lang":"TypeScript","source":"import { Apideck } from '@apideck/node'\n\nconst apideck = new Apideck({\n  apiKey: 'REPLACE_WITH_API_KEY',\n  appId: 'REPLACE_WITH_APP_ID',\n  consumerId: 'REPLACE_WITH_CONSUMER_ID'\n})\n\nconst params = {\n  id: 'id_example',\n  user: {\n    parent_id: '54321',\n    username: 'masterofcoin',\n    first_name: 'Elon',\n    last_name: 'Musk',\n    title: 'CEO',\n    division: 'Europe',\n    department: 'R&D',\n    company_name: 'SpaceX',\n    employee_number: '123456-AB',\n    description: 'A description',\n    image: 'https://logo.clearbit.com/spacex.com?s=128',\n    language: 'EN',\n    status: 'active',\n    password: 'supersecretpassword',\n    addresses: [\n      {\n        id: '123',\n        type: 'primary',\n        string: '25 Spring Street, Blackburn, VIC 3130',\n        name: 'HQ US',\n        line1: 'Main street',\n        line2: 'apt #',\n        line3: 'Suite #',\n        line4: 'delivery instructions',\n        street_number: '25',\n        city: 'San Francisco',\n        state: 'CA',\n        postal_code: '94104',\n        country: 'US',\n        latitude: '40.759211',\n        longitude: '-73.984638',\n        county: 'Santa Clara',\n        contact_name: 'Elon Musk',\n        salutation: 'Mr',\n        phone_number: '111-111-1111',\n        fax: '122-111-1111',\n        email: 'elon@musk.com',\n        website: 'https://elonmusk.com',\n        notes: 'Address notes or delivery instructions.',\n        row_version: '1-12345'\n      }\n    ],\n    phone_numbers: [\n      {\n        id: '12345',\n        country_code: '1',\n        area_code: '323',\n        number: '111-111-1111',\n        extension: '105',\n        type: 'primary'\n      }\n    ],\n    emails: [\n      {\n        id: '123',\n        email: 'elon@musk.com',\n        type: 'primary'\n      }\n    ],\n    custom_mappings: {}\n  }\n}\n\ntry {\n  const { data } = await apideck.crm.usersUpdate(params)\n  console.log('API called successfully', data)\n} catch (error) {\n  console.error(error)\n}\n"}]}}},"components":{"parameters":{"activitiesFilter":{"description":"Apply filters","explode":true,"in":"query","name":"filter","schema":{"$ref":"#/components/schemas/ActivitiesFilter"},"style":"deepObject"},"applicationId":{"description":"The ID of your Unify application","example":"dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX","in":"header","name":"x-apideck-app-id","required":true,"schema":{"type":"string"}},"companiesFilter":{"description":"Apply filters","explode":true,"in":"query","name":"filter","schema":{"$ref":"#/components/schemas/CompaniesFilter"},"style":"deepObject"},"companiesSort":{"description":"Apply sorting","explode":true,"in":"query","name":"sort","schema":{"$ref":"#/components/schemas/CompaniesSort"},"style":"deepObject"},"consumerId":{"description":"ID of the consumer which you want to get or push data from","in":"header","name":"x-apideck-consumer-id","required":true,"schema":{"type":"string"}},"contactsFilter":{"description":"Apply filters","explode":true,"in":"query","name":"filter","schema":{"$ref":"#/components/schemas/ContactsFilter"},"style":"deepObject"},"contactsSort":{"description":"Apply sorting","explode":true,"in":"query","name":"sort","schema":{"$ref":"#/components/schemas/ContactsSort"},"style":"deepObject"},"cursor":{"description":"Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.","in":"query","name":"cursor","schema":{"nullable":true,"type":"string"}},"fields":{"description":"The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. <br /><br />Example: `fields=name,email,addresses.city`<br /><br />In the example above, the response will only include the fields \"name\", \"email\" and \"addresses.city\". If any other fields are available, they will be excluded.","example":"id,updated_at","in":"query","name":"fields","schema":{"nullable":true,"type":"string"}},"id":{"description":"ID of the record you are acting upon.","in":"path","name":"id","required":true,"schema":{"type":"string"}},"leadsFilter":{"description":"Apply filters","explode":true,"in":"query","name":"filter","schema":{"$ref":"#/components/schemas/LeadsFilter"},"style":"deepObject"},"leadsSort":{"description":"Apply sorting","explode":true,"in":"query","name":"sort","schema":{"$ref":"#/components/schemas/LeadsSort"},"style":"deepObject"},"limit":{"description":"Number of results to return. Minimum 1, Maximum 200, Default 20","in":"query","name":"limit","schema":{"default":20,"maximum":200,"minimum":1,"type":"integer"}},"opportunitiesFilter":{"description":"Apply filters","explode":true,"in":"query","name":"filter","schema":{"$ref":"#/components/schemas/OpportunitiesFilter"},"style":"deepObject"},"opportunitiesSort":{"description":"Apply sorting","explode":true,"in":"query","name":"sort","schema":{"$ref":"#/components/schemas/OpportunitiesSort"},"style":"deepObject"},"passThrough":{"description":"Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads","explode":true,"in":"query","name":"pass_through","schema":{"$ref":"#/components/schemas/PassThroughQuery"},"style":"deepObject"},"raw":{"description":"Include raw response. Mostly used for debugging purposes","in":"query","name":"raw","schema":{"default":false,"type":"boolean"}},"serviceId":{"description":"Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.","in":"header","name":"x-apideck-service-id","schema":{"type":"string"}}},"responses":{"BadRequestResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}},"description":"Bad Request"},"CreateActivityResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateActivityResponse"}}},"description":"Activity created"},"CreateCompanyResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCompanyResponse"}}},"description":"Company created"},"CreateContactResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateContactResponse"}}},"description":"Contact created"},"CreateLeadResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLeadResponse"}}},"description":"Lead created"},"CreateNoteResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNoteResponse"}}},"description":"Note created"},"CreateOpportunityResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOpportunityResponse"}}},"description":"Opportunity created"},"CreatePipelineResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePipelineResponse"}}},"description":"Pipeline created"},"CreateUserResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserResponse"}}},"description":"User created"},"DeleteActivityResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteActivityResponse"}}},"description":"Activity deleted"},"DeleteCompanyResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCompanyResponse"}}},"description":"Company deleted"},"DeleteContactResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteContactResponse"}}},"description":"Contact deleted"},"DeleteLeadResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteLeadResponse"}}},"description":"Lead deleted"},"DeleteNoteResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteNoteResponse"}}},"description":"Note deleted"},"DeleteOpportunityResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteOpportunityResponse"}}},"description":"Opportunity deleted"},"DeletePipelineResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletePipelineResponse"}}},"description":"Pipeline deleted"},"DeleteUserResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteUserResponse"}}},"description":"User deleted"},"GetActivitiesResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActivitiesResponse"}}},"description":"Activities"},"GetActivityResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetActivityResponse"}}},"description":"Activity","links":{"company":{"operationId":"companiesOne","parameters":{"id":"$response.body#/data/company_id"}},"contact":{"operationId":"contactsOne","parameters":{"id":"$response.body#/data/contact_id"}},"lead":{"operationId":"leadsOne","parameters":{"id":"$response.body#/data/lead_id"}},"opportunity":{"operationId":"opportunitiesOne","parameters":{"id":"$response.body#/data/opportunity_id"}},"owner":{"operationId":"usersOne","parameters":{"id":"$response.body#/data/owner_id"}}}},"GetCompaniesResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCompaniesResponse"}}},"description":"Companies"},"GetCompanyResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCompanyResponse"}}},"description":"Company","links":{"owner":{"operationId":"usersOne","parameters":{"id":"$response.body#/data/owner_id"}},"parentById":{"operationId":"companiesOne","parameters":{"id":"$response.body#/data/parent_id"}}}},"GetContactResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetContactResponse"}}},"description":"Contact","links":{"company":{"operationId":"companiesOne","parameters":{"id":"$response.body#/data/company_id"}},"lead":{"operationId":"leadsOne","parameters":{"id":"$response.body#/data/lead_id"}},"owner":{"operationId":"usersOne","parameters":{"id":"$response.body#/data/owner_id"}}}},"GetContactsResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetContactsResponse"}}},"description":"Contacts"},"GetCrmLeadResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLeadResponse"}}},"description":"Lead","links":{"company":{"operationId":"companiesOne","parameters":{"id":"$response.body#/data/company_id"}},"contact":{"operationId":"contactsOne","parameters":{"id":"$response.body#/data/contact_id"}},"owner":{"operationId":"usersOne","parameters":{"id":"$response.body#/data/owner_id"}}}},"GetLeadsResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetLeadsResponse"}}},"description":"Leads"},"GetNoteResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNoteResponse"}}},"description":"Note","links":{"company":{"operationId":"companiesOne","parameters":{"id":"$response.body#/data/company_id"}},"contact":{"operationId":"contactsOne","parameters":{"id":"$response.body#/data/contact_id"}},"lead":{"operationId":"leadsOne","parameters":{"id":"$response.body#/data/lead_id"}},"opportunity":{"operationId":"opportunitiesOne","parameters":{"id":"$response.body#/data/opportunity_id"}},"owner":{"operationId":"usersOne","parameters":{"id":"$response.body#/data/owner_id"}}}},"GetNotesResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetNotesResponse"}}},"description":"Notes"},"GetOpportunitiesResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOpportunitiesResponse"}}},"description":"Opportunities"},"GetOpportunityResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetOpportunityResponse"}}},"description":"Opportunity","links":{"company":{"operationId":"companiesOne","parameters":{"id":"$response.body#/data/company_id"}},"contact":{"operationId":"contactsOne","parameters":{"id":"$response.body#/data/contact_id"}},"lead":{"operationId":"leadsOne","parameters":{"id":"$response.body#/data/lead_id"}},"owner":{"operationId":"usersOne","parameters":{"id":"$response.body#/data/owner_id"}},"pipelineById":{"operationId":"pipelinesOne","parameters":{"id":"$response.body#/data/pipeline_id"}},"primarycontact":{"operationId":"contactsOne","parameters":{"id":"$response.body#/data/primary_contact_id"}}}},"GetPipelineResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPipelineResponse"}}},"description":"Pipeline"},"GetPipelinesResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPipelinesResponse"}}},"description":"Pipelines"},"GetUserResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUserResponse"}}},"description":"User"},"GetUsersResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetUsersResponse"}}},"description":"Users"},"NotFoundResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}},"description":"The specified resource was not found"},"NotImplementedResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotImplementedResponse"}}},"description":"Not Implemented"},"PaymentRequiredResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredResponse"}}},"description":"Payment Required"},"TooManyRequestsResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsResponse"}}},"description":"Too Many Requests"},"UnauthorizedResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedResponse"}}},"description":"Unauthorized"},"UnexpectedErrorResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnexpectedErrorResponse"}}},"description":"Unexpected error"},"UnprocessableResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnprocessableResponse"}}},"description":"Unprocessable"},"UpdateActivityResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateActivityResponse"}}},"description":"Activity updated"},"UpdateCompanyResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCompanyResponse"}}},"description":"Company updated"},"UpdateContactResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateContactResponse"}}},"description":"Contact updated"},"UpdateLeadResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLeadResponse"}}},"description":"Lead updated"},"UpdateNoteResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateNoteResponse"}}},"description":"Note updated"},"UpdateOpportunityResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOpportunityResponse"}}},"description":"Opportunity updated"},"UpdatePipelineResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePipelineResponse"}}},"description":"Pipeline updated"},"UpdateUserResponse":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserResponse"}}},"description":"User updated"}},"schemas":{"ActivitiesFilter":{"additionalProperties":false,"example":{"updated_since":"2025-08-15T13:51:17.599Z"},"properties":{"updated_since":{"example":"2025-08-15T13:51:17.599Z","format":"date-time","title":"Updated since (timestamp)","type":"string"}},"type":"object","x-apideck-schema-id":"ActivitiesFilter"},"Activity":{"additionalProperties":false,"properties":{"account_id":{"description":"The account related to the activity","example":"12345","nullable":true,"type":"string"},"activity_date":{"description":"The date of the activity","example":"2025-08-15T13:51:17.599Z","nullable":true,"type":"string"},"activity_datetime":{"description":"The date and time of the activity","example":"2025-08-15T13:51:17.599Z","nullable":true,"type":"string"},"all_day_event":{"description":"Whether the Activity is an all day event or not","example":false,"nullable":true,"type":"boolean"},"archived":{"description":"Whether the activity is archived or not","example":false,"nullable":true,"type":"boolean"},"asset_id":{"description":"The asset related to the activity","example":"12345","nullable":true,"type":"string"},"attendees":{"items":{"$ref":"#/components/schemas/ActivityAttendee"},"type":"array"},"campaign_id":{"description":"The campaign related to the activity","example":"12345","nullable":true,"type":"string"},"case_id":{"description":"The case related to the activity","example":"12345","nullable":true,"type":"string"},"child":{"description":"Whether the activity is a child of another activity or not","example":false,"nullable":true,"type":"boolean"},"company_id":{"description":"The company related to the activity","example":"12345","nullable":true,"type":"string"},"contact_id":{"description":"The contact related to the activity","example":"12345","nullable":true,"type":"string"},"contract_id":{"description":"The contract related to the activity","example":"12345","nullable":true,"type":"string"},"created_at":{"description":"The date and time when the activity was created","example":"2025-08-15T13:51:17.599Z","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"The user who created the activity","example":"12345","nullable":true,"readOnly":true,"type":"string"},"custom_fields":{"description":"Custom fields of the activity","items":{"$ref":"#/components/schemas/CustomField"},"type":"array"},"custom_mappings":{"$ref":"#/components/schemas/CustomMappings"},"custom_object_id":{"description":"The custom object related to the activity","example":"12345","nullable":true,"type":"string"},"deleted":{"description":"Whether the activity is deleted or not","example":false,"nullable":true,"type":"boolean"},"description":{"description":"A description of the activity","example":"More info about the meeting","nullable":true,"type":"string"},"done":{"description":"Whether the Activity is done or not","example":false,"nullable":true,"title":"Done","type":"boolean"},"downstream_id":{"description":"The third-party API ID of original entity","example":"12345","nullable":true,"readOnly":true,"type":"string"},"duration_minutes":{"description":"The duration of the activity in minutes","example":30,"nullable":true,"readOnly":true,"type":"integer"},"duration_seconds":{"description":"The duration of the activity in seconds","example":1800,"minimum":0,"nullable":true,"type":"integer"},"end_date":{"description":"The end date of the activity","example":"2025-08-15T13:51:17.599Z","nullable":true,"type":"string"},"end_datetime":{"description":"The end date and time of the activity","example":"2025-08-15T13:51:17.599Z","nullable":true,"type":"string"},"event_sub_type":{"description":"The sub type of the group event","example":"debrief","nullable":true,"type":"string"},"group_event":{"description":"Whether the Activity is a group event or not","example":true,"nullable":true,"type":"boolean"},"group_event_type":{"description":"The type of the group event","example":"Proposed","nullable":true,"type":"string"},"id":{"description":"The unique identifier of the activity","example":"12345","readOnly":true,"type":"string"},"lead_id":{"description":"The lead related to the activity","example":"12345","nullable":true,"type":"string"},"location":{"description":"The location of the activity","example":"Space","nullable":true,"type":"string"},"location_address":{"$ref":"#/components/schemas/Address"},"note":{"description":"An internal note about the activity","example":"An internal note about the meeting","nullable":true,"title":"Note (internal)","type":"string"},"opportunity_id":{"description":"The opportunity related to the activity","example":"12345","nullable":true,"type":"string"},"owner_id":{"description":"The owner of the activity","example":"12345","nullable":true,"type":"string"},"private":{"description":"Whether the Activity is private or not","example":true,"nullable":true,"type":"boolean"},"product_id":{"description":"The product related to the activity","example":"12345","nullable":true,"type":"string"},"recurrent":{"description":"Whether the activity is recurrent or not","example":false,"type":"boolean"},"reminder_datetime":{"description":"The date and time of the reminder","example":"2025-08-15T13:51:17.599Z","nullable":true,"type":"string"},"reminder_set":{"description":"Whether the reminder is set or not","example":false,"nullable":true,"type":"boolean"},"show_as":{"enum":["free","busy"],"example":"busy","nullable":true,"type":"string","x-apideck-enum-id":"activities.show_as"},"solution_id":{"description":"The solution related to the activity","example":"12345","nullable":true,"type":"string"},"start_datetime":{"description":"The start date and time of the activity","example":"2025-08-15T13:51:17.599Z","nullable":true,"type":"string"},"title":{"description":"The title of the activity","example":"Meeting","nullable":true,"type":"string"},"type":{"description":"The type of the activity","enum":["call","meeting","email","note","task","deadline","send-letter","send-quote","other"],"example":"meeting","nullable":true,"type":"string","x-apideck-enum-id":"activities.type"},"updated_at":{"description":"The date and time when the activity was last updated","example":"2025-08-15T13:51:17.599Z","nullable":true,"readOnly":true,"type":"string"},"updated_by":{"description":"The user who last updated the activity","example":"12345","nullable":true,"readOnly":true,"type":"string"},"user_id":{"description":"The user related to the activity","example":"12345","nullable":true,"type":"string"},"video_conference_id":{"description":"The ID of the video conference","example":"zoom:88120759396","nullable":true,"title":"Meeting ID","type":"string"},"video_conference_url":{"description":"The URL of the video conference","example":"https://us02web.zoom.us/j/88120759396","nullable":true,"title":"Meeting URL","type":"string"}},"required":["type"],"type":"object","x-apideck-schema-id":"Activity","x-apideck-weights":{"account_id":"edge-case","activity_date":"medium","activity_datetime":"high","all_day_event":"medium","archived":"low","asset_id":"edge-case","attendees":"edge-case","campaign_id":"edge-case","case_id":"edge-case","child":"low","company_id":"edge-case","contact_id":"edge-case","contract_id":"edge-case","custom_object_id":"edge-case","deleted":"low","description":"medium","done":"medium","downstream_id":"edge-case","duration_minutes":"edge-case","duration_seconds":"medium","end_date":"medium","end_datetime":"high","event_sub_type":"medium","group_event":"edge-case","group_event_type":"edge-case","id":"critical","lead_id":"edge-case","location":"medium","location_address":"medium","note":"medium","opportunity_id":"edge-case","owner_id":"high","private":"low","product_id":"edge-case","reminder_datetime":"edge-case","reminder_set":"edge-case","show_as":"edge-case","solution_id":"edge-case","start_datetime":"high","title":"critical","type":"critical","updated_at":"high","user_id":"edge-case","video_conference_id":"edge-case","video_conference_url":"edge-case"}},"ActivityAttendee":{"additionalProperties":false,"properties":{"contact_id":{"description":"The identifier for a related contact","example":"12345","nullable":true,"readOnly":true,"type":"string"},"created_at":{"description":"The time the attendee was created (ISO 8601)","example":"2025-08-15T13:51:17.599Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"email_address":{"description":"Email address of the attendee","example":"elon@musk.com","nullable":true,"type":"string"},"first_name":{"description":"First name of the attendee","example":"Elon","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the attendee","example":"12345","nullable":true,"readOnly":true,"type":"string"},"is_organizer":{"description":"Whether the attendee is the organizer of the activity","example":true,"nullable":true,"type":"boolean"},"last_name":{"description":"Last name of the attendee","example":"Musk","nullable":true,"type":"string"},"middle_name":{"description":"Middle name of the attendee","example":"D.","nullable":true,"type":"string"},"name":{"description":"Full name of the attendee","example":"Elon Musk","minLength":1,"nullable":true,"type":"string"},"prefix":{"description":"Prefix of the attendee","example":"Mr.","nullable":true,"type":"string"},"status":{"description":"Status of the attendee","enum":["accepted","tentative","declined"],"example":"accepted","nullable":true,"type":"string","x-apideck-enum-id":"activity-attendees.status"},"suffix":{"description":"Suffix of the attendee","example":"PhD","nullable":true,"type":"string"},"updated_at":{"description":"The last time the attendee was updated (ISO 8601)","example":"2025-08-15T13:51:17.599Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"user_id":{"description":"The identifier for a related user","example":"12345","nullable":true,"readOnly":true,"type":"string"}},"type":"object","x-apideck-schema-id":"ActivityAttendee","x-apideck-weights":{"email_address":"medium","first_name":"high","id":"critical","is_organizer":"medium","last_name":"high","middle_name":"low","name":"critical","prefix":"low","status":"medium","suffix":"edge-case","user_id":"low"},"x-pii":["name","first_name","middle_name","last_name","email_address"]},"Address":{"additionalProperties":false,"properties":{"city":{"description":"Name of city.","example":"San Francisco","nullable":true,"type":"string"},"contact_name":{"description":"Name of the contact person at the address","example":"Elon Musk","nullable":true,"type":"string"},"country":{"description":"country code according to ISO 3166-1 alpha-2.","example":"US","nullable":true,"type":"string"},"county":{"description":"Address field that holds a sublocality, such as a county","example":"Santa Clara","nullable":true,"type":"string"},"email":{"description":"Email address of the address","example":"elon@musk.com","nullable":true,"type":"string"},"fax":{"description":"Fax number of the address","example":"122-111-1111","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the address.","example":"123","nullable":true,"type":"string"},"latitude":{"description":"Latitude of the address","example":"40.759211","nullable":true,"type":"string"},"line1":{"description":"Line 1 of the address e.g. number, street, suite, apt #, etc.","example":"Main street","nullable":true,"type":"string"},"line2":{"description":"Line 2 of the address","example":"apt #","nullable":true,"type":"string"},"line3":{"description":"Line 3 of the address","example":"Suite #","nullable":true,"type":"string"},"line4":{"description":"Line 4 of the address","example":"delivery instructions","nullable":true,"type":"string"},"longitude":{"description":"Longitude of the address","example":"-73.984638","nullable":true,"type":"string"},"name":{"description":"The name of the address.","example":"HQ US","nullable":true,"type":"string"},"notes":{"description":"Additional notes","example":"Address notes or delivery instructions.","nullable":true,"title":"Notes","type":"string"},"phone_number":{"description":"Phone number of the address","example":"111-111-1111","nullable":true,"type":"string"},"postal_code":{"description":"Zip code or equivalent.","example":"94104","nullable":true,"type":"string"},"row_version":{"$ref":"#/components/schemas/RowVersion"},"salutation":{"description":"Salutation of the contact person at the address","example":"Mr","nullable":true,"type":"string"},"state":{"description":"Name of state","example":"CA","nullable":true,"type":"string"},"street_number":{"description":"Street number","example":"25","nullable":true,"type":"string"},"string":{"description":"The address string. Some APIs don't provide structured address data.","example":"25 Spring Street, Blackburn, VIC 3130","nullable":true,"type":"string"},"type":{"description":"The type of address.","enum":["primary","secondary","home","office","shipping","billing","other"],"example":"primary","nullable":true,"type":"string","x-apideck-enum-id":"addresses.type"},"website":{"description":"Website of the address","example":"https://elonmusk.com","nullable":true,"type":"string"}},"type":"object","x-apideck-schema-id":"Address","x-apideck-weights":{"city":"high","contact_name":"edge-case","country":"high","county":"edge-case","email":"edge-case","fax":"edge-case","id":"edge-case","latitude":"low","line1":"high","line2":"low","line3":"edge-case","line4":"edge-case","longitude":"low","name":"edge-case","phone_number":"edge-case","postal_code":"high","row_version":"edge-case","salutation":"edge-case","state":"high","street_number":"low","string":"low","type":"critical","website":"edge-case"}},"BadRequestResponse":{"properties":{"detail":{"anyOf":[{"example":"Missing property foobar","type":"string"},{"example":{"missing":[{"foobar":"required"}]},"type":"object"}],"description":"Contains parameter or domain specific information related to the error and why it occurred."},"error":{"description":"Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)","example":"Bad Request","type":"string"},"message":{"description":"A human-readable message providing more details about the error.","example":"Invalid Params","type":"string"},"ref":{"description":"Link to documentation of error type","example":"https://developers.apideck.com/errors#requestvalidationerror","type":"string"},"status_code":{"description":"HTTP status code","example":400,"type":"number"},"type_name":{"description":"The type of error returned","example":"RequestValidationError","type":"string"}},"type":"object","x-apideck-schema-id":"BadRequest"},"BankAccount":{"additionalProperties":false,"properties":{"account_name":{"description":"The name which you used in opening your bank account.","example":"SPACEX LLC","nullable":true,"title":"Bank Account Name","type":"string"},"account_number":{"description":"A bank account number is a number that is tied to your bank account. If you have several bank accounts, such as personal, joint, business (and so on), each account will have a different account number.","example":"123465","nullable":true,"title":"Bank Account Number","type":"string"},"account_type":{"description":"The type of bank account.","enum":["bank_account","credit_card","other"],"example":"credit_card","nullable":true,"title":"Account Type","type":"string","x-apideck-enum-id":"bank-accounts.account_type"},"bank_code":{"description":"A bank code is a code assigned by a central bank, a bank supervisory body or a Bankers Association in a country to all its licensed member banks or financial institutions.","example":"BNH","nullable":true,"title":"Bank Code","type":"string"},"bank_name":{"description":"The name of the bank","example":"Monzo","nullable":true,"title":"Bank Name","type":"string"},"bic":{"description":"The Bank Identifier Code (BIC).","example":"AUDSCHGGXXX","nullable":true,"type":"string"},"branch_identifier":{"description":"A branch identifier is a unique identifier for a branch of a bank or financial institution.","example":"001","nullable":true,"title":"Branch Identifier","type":"string"},"bsb_number":{"description":"A BSB is a 6 digit numeric code used for identifying the branch of an Australian or New Zealand bank or financial institution.","example":"062-001","nullable":true,"title":"BSB Number","type":"string"},"currency":{"$ref":"#/components/schemas/Currency"},"iban":{"description":"The International Bank Account Number (IBAN).","example":"CH2989144532982975332","nullable":true,"type":"string"},"routing_number":{"description":"A routing number is a nine-digit code used to identify a financial institution in the United States.","example":"012345678","nullable":true,"title":"Routing number","type":"string"}},"type":"object","x-apideck-schema-id":"BankAccount","x-apideck-weights":{"account_name":"medium","account_number":"critical","account_type":"medium","bank_code":"low","bank_name":"medium","bic":"medium","branch_identifier":"low","bsb_number":"edge-case","currency":"medium","iban":"high"}},"CompaniesFilter":{"additionalProperties":false,"example":{"name":"SpaceX"},"properties":{"name":{"description":"Name of the company to filter on","example":"SpaceX","type":"string"}},"type":"object","x-apideck-schema-id":"CompaniesFilter"},"CompaniesSort":{"additionalProperties":false,"example":{"by":"created_at","direction":"desc"},"properties":{"by":{"description":"The field on which to sort the Companies","enum":["created_at","updated_at","name"],"example":"created_at","type":"string","x-apideck-enum-id":"companies.sort_by"},"direction":{"$ref":"#/components/schemas/SortDirection"}},"type":"object","x-apideck-schema-id":"CompaniesSort"},"Company":{"additionalProperties":false,"properties":{"abn_branch":{"description":"An ABN Branch (also known as a GST Branch) is used if part of your business needs to account for GST separately from its parent entity.","example":"123","nullable":true,"title":"ABN Branch","type":"string"},"abn_or_tfn":{"description":"An ABN is necessary for operating a business, while a TFN (Tax File Number) is required for any person working in Australia.","example":"46 115 614 695","nullable":true,"title":"ABN or TFN","type":"string"},"acn":{"description":"The Australian Company Number (ACN) is a nine digit number with the last digit being a check digit calculated using a modified modulus 10 calculation. ASIC has adopted a convention of always printing and displaying the ACN in the format XXX XXX XXX; three blocks of three characters, each block separated by a blank.","example":"XXX XXX XXX","nullable":true,"title":"ACN","type":"string"},"addresses":{"items":{"$ref":"#/components/schemas/Address"},"type":"array"},"annual_revenue":{"description":"The annual revenue of the company","example":"+$35m","nullable":true,"type":"string"},"bank_accounts":{"items":{"$ref":"#/components/schemas/BankAccount"},"type":"array"},"birthday":{"description":"The date of birth of the person.","example":"2025-08-15T13:51:17.599Z","format":"date","nullable":true,"title":"Birth Date","type":"string"},"created_at":{"description":"Creation date","example":"2025-08-15T13:51:17.599Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"Created by user ID","example":"12345","nullable":true,"readOnly":true,"type":"string"},"currency":{"$ref":"#/components/schemas/Currency"},"custom_fields":{"items":{"$ref":"#/components/schemas/CustomField"},"type":"array"},"custom_mappings":{"$ref":"#/components/schemas/CustomMappings"},"deleted":{"description":"Whether the company is deleted or not","example":false,"readOnly":true,"type":"boolean"},"description":{"description":"A description of the company","example":"Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.","nullable":true,"type":"string"},"emails":{"items":{"$ref":"#/components/schemas/Email"},"type":"array"},"fax":{"description":"The fax number of the company","example":"+12129876543","nullable":true,"type":"string"},"first_name":{"$ref":"#/components/schemas/FirstName"},"id":{"description":"Unique identifier for the company","example":"12345","readOnly":true,"type":"string"},"image":{"description":"The Image URL of the company","example":"https://www.spacex.com/static/images/share.jpg","nullable":true,"type":"string"},"industry":{"description":"The industry represents the type of business the company is in.","example":"Apparel","nullable":true,"type":"string"},"interaction_count":{"description":"Number of interactions","example":1,"nullable":true,"readOnly":true,"type":"integer"},"last_activity_at":{"description":"Last activity date","example":"2025-08-15T13:51:17.599Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"last_name":{"$ref":"#/components/schemas/LastName"},"name":{"description":"Name of the company","example":"SpaceX","minLength":1,"title":"Name","type":"string"},"number_of_employees":{"description":"Number of employees","example":"500-1000","nullable":true,"type":"string"},"owner_id":{"description":"Owner ID","example":"12345","nullable":true,"type":"string"},"ownership":{"description":"The ownership indicates the type of ownership of the company.","example":"Public","nullable":true,"type":"string"},"parent_id":{"description":"Parent ID","example":"22345","nullable":true,"readOnly":true,"type":"string"},"payee_number":{"description":"A payee number is a unique number that identifies a payee for tax purposes.","example":"78932EN","nullable":true,"title":"Payee number","type":"string"},"phone_numbers":{"items":{"$ref":"#/components/schemas/PhoneNumber"},"type":"array"},"read_only":{"description":"Whether the company is read-only or not","example":false,"nullable":true,"title":"Read-only","type":"boolean"},"row_type":{"properties":{"id":{"example":"12345","nullable":true,"type":"string"},"name":{"example":"Customer Account","nullable":true,"type":"string"}},"title":"Company Row Type","type":"object","x-apideck-weights":{"id":"critical","name":"medium"}},"sales_tax_number":{"description":"A sales tax number is a unique number that identifies a company for tax purposes.","example":"12456EN","nullable":true,"title":"Sales tax number","type":"string"},"salutation":{"description":"A formal salutation for the person. For example, 'Mr', 'Mrs'","example":"Mr","nullable":true,"type":"string"},"social_links":{"items":{"$ref":"#/components/schemas/SocialLink"},"type":"array"},"status":{"description":"The status of the company","example":"Open","nullable":true,"type":"string"},"tags":{"$ref":"#/components/schemas/Tags"},"updated_at":{"description":"Last updated date","example":"2025-08-15T13:51:17.599Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"updated_by":{"description":"Updated by user ID","example":"12345","nullable":true,"readOnly":true,"type":"string"},"vat_number":{"description":"The VAT number of the company","example":"BE0689615164","nullable":true,"type":"string"},"websites":{"items":{"$ref":"#/components/schemas/Website"},"type":"array"}},"required":["name"],"type":"object","x-apideck-schema-id":"Company","x-apideck-weights":{"abn_branch":"edge-case","abn_or_tfn":"edge-case","acn":"edge-case","addresses":"high","annual_revenue":"low","bank_accounts":"medium","birthday":"edge-case","created_at":"medium","created_by":"edge-case","currency":"medium","custom_fields":"medium","deleted":"medium","description":"medium","emails":"high","fax":"low","first_name":"edge-case","id":"critical","image":"low","industry":"medium","interaction_count":"edge-case","last_activity_at":"low","last_name":"edge-case","name":"critical","number_of_employees":"low","owner_id":"high","ownership":"low","parent_id":"edge-case","payee_number":"edge-case","phone_numbers":"high","read_only":"low","row_type":"edge-case","sales_tax_number":"medium","salutation":"edge-case","social_links":"low","status":"high","tags":"low","updated_at":"high","updated_by":"edge-case","vat_number":"high","websites":"medium"}},"Contact":{"additionalProperties":false,"properties":{"active":{"description":"The active status of the contact.","example":true,"nullable":true,"type":"boolean"},"addresses":{"items":{"$ref":"#/components/schemas/Address"},"type":"array"},"birthday":{"description":"The birthday of the contact.","example":"2025-08-15T13:51:17.600Z","nullable":true,"type":"string"},"company_id":{"description":"The company the contact is associated with.","example":"23456","nullable":true,"type":"string"},"company_name":{"description":"The name of the company the contact is associated with.","example":"23456","nullable":true,"type":"string"},"created_at":{"description":"The creation date of the contact.","example":"2025-08-15T13:51:17.600Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"current_balance":{"description":"The current balance of the contact.","example":10.5,"nullable":true,"title":"Current Balance","type":"number"},"custom_fields":{"items":{"$ref":"#/components/schemas/CustomField"},"type":"array"},"custom_mappings":{"$ref":"#/components/schemas/CustomMappings"},"department":{"description":"The department of the contact.","example":"Engineering","nullable":true,"type":"string"},"description":{"description":"The description of the contact.","example":"Internal champion","nullable":true,"title":"Description","type":"string"},"email_domain":{"example":"gmail.com","nullable":true,"type":"string"},"emails":{"items":{"$ref":"#/components/schemas/Email"},"type":"array"},"fax":{"description":"The fax number of the contact.","example":"+12129876543","nullable":true,"type":"string"},"first_call_at":{"description":"The first call date of the contact.","example":"2025-08-15T13:51:17.600Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"first_email_at":{"description":"The first email date of the contact.","example":"2025-08-15T13:51:17.600Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"first_name":{"description":"The first name of the contact.","example":"Elon","nullable":true,"type":"string"},"gender":{"description":"The gender of the contact.","enum":["male","female","unisex"],"example":"female","nullable":true,"type":"string","x-apideck-enum-id":"contacts.gender"},"id":{"description":"Unique identifier for the contact.","example":"12345","readOnly":true,"type":"string"},"image":{"deprecated":true,"example":"https://unavatar.io/elon-musk","nullable":true,"type":"string"},"language":{"description":"language code according to ISO 639-1. For the United States - EN","example":"EN","nullable":true,"type":"string"},"last_activity_at":{"description":"The last activity date of the contact.","example":"2025-08-15T13:51:17.600Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"last_name":{"description":"The last name of the contact.","example":"Musk","nullable":true,"type":"string"},"lead_id":{"description":"The lead the contact is associated with.","example":"34567","nullable":true,"type":"string"},"lead_source":{"description":"The lead source of the contact.","example":"Cold Call","nullable":true,"type":"string"},"middle_name":{"description":"The middle name of the contact.","example":"D.","nullable":true,"type":"string"},"name":{"description":"Full name of the contact.","example":"Elon Musk","minLength":1,"nullable":true,"type":"string"},"owner_id":{"description":"The owner of the contact.","example":"54321","nullable":true,"type":"string"},"phone_numbers":{"items":{"$ref":"#/components/schemas/PhoneNumber"},"type":"array"},"photo_url":{"description":"The URL of the photo of a person.","example":"https://unavatar.io/elon-musk","nullable":true,"title":"Photo URL","type":"string"},"prefix":{"description":"The prefix of the contact.","example":"Mr.","nullable":true,"type":"string"},"social_links":{"items":{"$ref":"#/components/schemas/SocialLink"},"type":"array"},"status":{"description":"The status of the contact.","example":"open","nullable":true,"type":"string"},"suffix":{"description":"The suffix of the contact.","example":"PhD","nullable":true,"type":"string"},"tags":{"$ref":"#/components/schemas/Tags"},"title":{"description":"The job title of the contact.","example":"CEO","nullable":true,"type":"string"},"type":{"description":"The type of the contact.","enum":["customer","supplier","employee","personal"],"example":"personal","nullable":true,"type":"string","x-apideck-enum-id":"contacts.type"},"updated_at":{"description":"The last update date of the contact.","example":"2025-08-15T13:51:17.600Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"websites":{"items":{"$ref":"#/components/schemas/Website"},"type":"array"}},"required":["name"],"type":"object","x-apideck-schema-id":"Contact","x-apideck-weights":{"active":"edge-case","addresses":"high","birthday":"medium","company_id":"high","company_name":"medium","created_at":"medium","current_balance":"edge-case","custom_fields":"medium","department":"medium","description":"low","email_domain":"edge-case","emails":"high","fax":"low","first_call_at":"edge-case","first_email_at":"edge-case","first_name":"high","gender":"medium","id":"critical","image":"medium","language":"medium","last_activity_at":"medium","last_name":"high","lead_id":"medium","lead_source":"low","middle_name":"low","name":"critical","owner_id":"medium","phone_numbers":"high","photo_url":"medium","prefix":"low","social_links":"low","status":"edge-case","suffix":"low","tags":"low","title":"medium","type":"medium","updated_at":"high","websites":"medium"},"x-pii":["name","first_name","middle_name","last_name","email"]},"ContactsFilter":{"additionalProperties":false,"example":{"company_id":"12345","email":"elon@tesla.com","first_name":"Elon","last_name":"Musk"},"properties":{"company_id":{"description":"Unique identifier for the associated company of the contact to filter on","example":"12345","type":"string"},"email":{"description":"Email of the contact to filter on","example":"elon@tesla.com","type":"string"},"first_name":{"description":"First name of the contact to filter on","example":"Elon","type":"string"},"last_name":{"description":"Last name of the contact to filter on","example":"Musk","type":"string"},"name":{"description":"Name of the contact to filter on","example":"Elon Musk","type":"string"}},"type":"object","x-apideck-schema-id":"ContactsFilter"},"ContactsSort":{"additionalProperties":false,"example":{"by":"created_at","direction":"desc"},"properties":{"by":{"description":"The field on which to sort the Contacts","enum":["created_at","updated_at","name","first_name","last_name","email"],"example":"created_at","type":"string","x-apideck-enum-id":"contacts.sort_by"},"direction":{"$ref":"#/components/schemas/SortDirection"}},"type":"object","x-apideck-schema-id":"ContactsSort"},"CreateActivityResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"add","type":"string"},"resource":{"description":"Unified API resource name","example":"activities","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"CreateActivityResponse"},"CreateCompanyResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"add","type":"string"},"resource":{"description":"Unified API resource name","example":"companies","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"CreateCompanyResponse"},"CreateContactResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"add","type":"string"},"resource":{"description":"Unified API resource name","example":"contacts","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"CreateContactResponse"},"CreateLeadResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"add","type":"string"},"resource":{"description":"Unified API resource name","example":"companies","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"CreateLeadResponse"},"CreateNoteResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"add","type":"string"},"resource":{"description":"Unified API resource name","example":"notes","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"CreateNoteResponse"},"CreateOpportunityResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"add","type":"string"},"resource":{"description":"Unified API resource name","example":"opportunities","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"CreateOpportunityResponse"},"CreatePipelineResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"add","type":"string"},"resource":{"description":"Unified API resource name","example":"pipelines","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"CreatePipelineResponse"},"CreateUserResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"add","type":"string"},"resource":{"description":"Unified API resource name","example":"users","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"CreateUserResponse"},"CrmEventType":{"enum":["*","crm.activity.created","crm.activity.updated","crm.activity.deleted","crm.company.created","crm.company.updated","crm.company.deleted","crm.contact.created","crm.contact.updated","crm.contact.deleted","crm.lead.created","crm.lead.updated","crm.lead.deleted","crm.note.created","crm.note.updated","crm.note.deleted","crm.opportunity.created","crm.opportunity.updated","crm.opportunity.deleted"],"example":"crm.company.created","type":"string","x-apideck-enum-id":"crm.events"},"CrmWebhookEvent":{"allOf":[{"properties":{"consumer_id":{"description":"Unique consumer identifier. You can freely choose a consumer ID yourself. Most of the time, this is an ID of your internal data model that represents a user or account in your system (for example account:12345). If the consumer doesn't exist yet, Vault will upsert a consumer based on your ID.","example":"test_consumer_id","type":"string"},"entity_id":{"description":"The service provider's ID of the entity that triggered this event","example":"123456ASDF","type":"string"},"entity_type":{"description":"The type entity that triggered this event","example":"Company","type":"string"},"entity_url":{"description":"The url to retrieve entity detail.","example":"https://unify.apideck.com/crm/contacts/123456","type":"string"},"event_id":{"description":"Unique reference to this request event","example":"9755c355-56c3-4a2f-a2da-86ff4411fccb","type":"string"},"execution_attempt":{"description":"The current count this request event has been attempted","example":2,"type":"number"},"occurred_at":{"description":"ISO Datetime for when the original event occurred","example":"2025-08-15T13:51:17.600Z","type":"string"},"service_id":{"description":"Service provider identifier","example":"close","type":"string"},"unified_api":{"description":"Name of Apideck Unified API","enum":["accounting","ats","calendar","crm","csp","customer-support","ecommerce","email","email-marketing","expense-management","file-storage","form","hris","lead","payroll","pos","procurement","project-management","script","sms","spreadsheet","team-messaging","issue-tracking","time-registration","transactional-email","vault","data-warehouse"],"example":"crm","type":"string","x-apideck-enum-id":"unified_api"}},"type":"object","x-apideck-schema-id":"WebhookEvent"},{"properties":{"event_type":{"$ref":"#/components/schemas/CrmEventType"}},"type":"object"}],"x-sdk-exclude":true},"Currency":{"description":"Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217).","enum":["UNKNOWN_CURRENCY","AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRC","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","USS","UYI","UYU","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XTS","XXX","YER","ZAR","ZMK","ZMW","BTC","ETH"],"example":"USD","nullable":true,"title":"Currency","type":"string","x-apideck-enum-coverage-ignore":true,"x-apideck-enum-id":"currencies","x-enum-elements":[{"description":"Unknown currency","name":"UNKNOWN_CURRENCY"},{"description":"United Arab Emirates dirham","name":"AED"},{"description":"Afghan afghani","name":"AFN"},{"description":"Albanian lek","name":"ALL"},{"description":"Armenian dram","name":"AMD"},{"description":"Netherlands Antillean guilder","name":"ANG"},{"description":"Angolan kwanza","name":"AOA"},{"description":"Argentine peso","name":"ARS"},{"description":"Australian dollar","name":"AUD"},{"description":"Aruban florin","name":"AWG"},{"description":"Azerbaijani manat","name":"AZN"},{"description":"Bosnia and Herzegovina convertible mark","name":"BAM"},{"description":"Barbados dollar","name":"BBD"},{"description":"Bangladeshi taka","name":"BDT"},{"description":"Bulgarian lev","name":"BGN"},{"description":"Bahraini dinar","name":"BHD"},{"description":"Burundian franc","name":"BIF"},{"description":"Bermudian dollar","name":"BMD"},{"description":"Brunei dollar","name":"BND"},{"description":"Boliviano","name":"BOB"},{"description":"Bolivian Mvdol","name":"BOV"},{"description":"Brazilian real","name":"BRL"},{"description":"Bahamian dollar","name":"BSD"},{"description":"Bhutanese ngultrum","name":"BTN"},{"description":"Botswana pula","name":"BWP"},{"description":"Belarusian ruble","name":"BYR"},{"description":"Belize dollar","name":"BZD"},{"description":"Canadian dollar","name":"CAD"},{"description":"Congolese franc","name":"CDF"},{"description":"WIR Euro","name":"CHE"},{"description":"Swiss franc","name":"CHF"},{"description":"WIR Franc","name":"CHW"},{"description":"Unidad de Fomento","name":"CLF"},{"description":"Chilean peso","name":"CLP"},{"description":"Chinese yuan","name":"CNY"},{"description":"Colombian peso","name":"COP"},{"description":"Unidad de Valor Real","name":"COU"},{"description":"Costa Rican colon","name":"CRC"},{"description":"Cuban convertible peso","name":"CUC"},{"description":"Cuban peso","name":"CUP"},{"description":"Cape Verdean escudo","name":"CVE"},{"description":"Czech koruna","name":"CZK"},{"description":"Djiboutian franc","name":"DJF"},{"description":"Danish krone","name":"DKK"},{"description":"Dominican peso","name":"DOP"},{"description":"Algerian dinar","name":"DZD"},{"description":"Egyptian pound","name":"EGP"},{"description":"Eritrean nakfa","name":"ERN"},{"description":"Ethiopian birr","name":"ETB"},{"description":"Euro","name":"EUR"},{"description":"Fiji dollar","name":"FJD"},{"description":"Falkland Islands pound","name":"FKP"},{"description":"Pound sterling","name":"GBP"},{"description":"Georgian lari","name":"GEL"},{"description":"Ghanaian cedi","name":"GHS"},{"description":"Gibraltar pound","name":"GIP"},{"description":"Gambian dalasi","name":"GMD"},{"description":"Guinean franc","name":"GNF"},{"description":"Guatemalan quetzal","name":"GTQ"},{"description":"Guyanese dollar","name":"GYD"},{"description":"Hong Kong dollar","name":"HKD"},{"description":"Honduran lempira","name":"HNL"},{"description":"Croatian kuna","name":"HRK"},{"description":"Haitian gourde","name":"HTG"},{"description":"Hungarian forint","name":"HUF"},{"description":"Indonesian rupiah","name":"IDR"},{"description":"Israeli new shekel","name":"ILS"},{"description":"Indian rupee","name":"INR"},{"description":"Iraqi dinar","name":"IQD"},{"description":"Iranian rial","name":"IRR"},{"description":"Icelandic króna","name":"ISK"},{"description":"Jamaican dollar","name":"JMD"},{"description":"Jordanian dinar","name":"JOD"},{"description":"Japanese yen","name":"JPY"},{"description":"Kenyan shilling","name":"KES"},{"description":"Kyrgyzstani som","name":"KGS"},{"description":"Cambodian riel","name":"KHR"},{"description":"Comoro franc","name":"KMF"},{"description":"North Korean won","name":"KPW"},{"description":"South Korean won","name":"KRW"},{"description":"Kuwaiti dinar","name":"KWD"},{"description":"Cayman Islands dollar","name":"KYD"},{"description":"Kazakhstani tenge","name":"KZT"},{"description":"Lao kip","name":"LAK"},{"description":"Lebanese pound","name":"LBP"},{"description":"Sri Lankan rupee","name":"LKR"},{"description":"Liberian dollar","name":"LRD"},{"description":"Lesotho loti","name":"LSL"},{"description":"Lithuanian litas","name":"LTL"},{"description":"Latvian lats","name":"LVL"},{"description":"Libyan dinar","name":"LYD"},{"description":"Moroccan dirham","name":"MAD"},{"description":"Moldovan leu","name":"MDL"},{"description":"Malagasy ariary","name":"MGA"},{"description":"Macedonian denar","name":"MKD"},{"description":"Myanmar kyat","name":"MMK"},{"description":"Mongolian tögrög","name":"MNT"},{"description":"Macanese pataca","name":"MOP"},{"description":"Mauritanian ouguiya","name":"MRO"},{"description":"Mauritian rupee","name":"MUR"},{"description":"Maldivian rufiyaa","name":"MVR"},{"description":"Malawian kwacha","name":"MWK"},{"description":"Mexican peso","name":"MXN"},{"description":"Mexican Unidad de Inversion","name":"MXV"},{"description":"Malaysian ringgit","name":"MYR"},{"description":"Mozambican metical","name":"MZN"},{"description":"Namibian dollar","name":"NAD"},{"description":"Nigerian naira","name":"NGN"},{"description":"Nicaraguan córdoba","name":"NIO"},{"description":"Norwegian krone","name":"NOK"},{"description":"Nepalese rupee","name":"NPR"},{"description":"New Zealand dollar","name":"NZD"},{"description":"Omani rial","name":"OMR"},{"description":"Panamanian balboa","name":"PAB"},{"description":"Peruvian sol","name":"PEN"},{"description":"Papua New Guinean kina","name":"PGK"},{"description":"Philippine peso","name":"PHP"},{"description":"Pakistani rupee","name":"PKR"},{"description":"Polish złoty","name":"PLN"},{"description":"Paraguayan guaraní","name":"PYG"},{"description":"Qatari riyal","name":"QAR"},{"description":"Romanian leu","name":"RON"},{"description":"Serbian dinar","name":"RSD"},{"description":"Russian ruble","name":"RUB"},{"description":"Rwandan franc","name":"RWF"},{"description":"Saudi riyal","name":"SAR"},{"description":"Solomon Islands dollar","name":"SBD"},{"description":"Seychelles rupee","name":"SCR"},{"description":"Sudanese pound","name":"SDG"},{"description":"Swedish krona","name":"SEK"},{"description":"Singapore dollar","name":"SGD"},{"description":"Saint Helena pound","name":"SHP"},{"description":"Sierra Leonean leone","name":"SLL"},{"description":"Somali shilling","name":"SOS"},{"description":"Surinamese dollar","name":"SRD"},{"description":"South Sudanese pound","name":"SSP"},{"description":"São Tomé and Príncipe dobra","name":"STD"},{"description":"Salvadoran colón","name":"SVC"},{"description":"Syrian pound","name":"SYP"},{"description":"Swazi lilangeni","name":"SZL"},{"description":"Thai baht","name":"THB"},{"description":"Tajikstani somoni","name":"TJS"},{"description":"Turkmenistan manat","name":"TMT"},{"description":"Tunisian dinar","name":"TND"},{"description":"Tongan pa'anga","name":"TOP"},{"description":"Turkish lira","name":"TRY"},{"description":"Trinidad and Tobago dollar","name":"TTD"},{"description":"New Taiwan dollar","name":"TWD"},{"description":"Tanzanian shilling","name":"TZS"},{"description":"Ukrainian hryvnia","name":"UAH"},{"description":"Ugandan shilling","name":"UGX"},{"description":"United States dollar","name":"USD"},{"description":"United States dollar (next day)","name":"USN"},{"description":"United States dollar (same day)","name":"USS"},{"description":"Uruguay Peso en Unidedades Indexadas","name":"UYI"},{"description":"Uruguyan peso","name":"UYU"},{"description":"Uzbekistan som","name":"UZS"},{"description":"Venezuelan bolívar soberano","name":"VEF"},{"description":"Vietnamese đồng","name":"VND"},{"description":"Vanuatu vatu","name":"VUV"},{"description":"Samoan tala","name":"WST"},{"description":"CFA franc BEAC","name":"XAF"},{"description":"Silver","name":"XAG"},{"description":"Gold","name":"XAU"},{"description":"European Composite Unit","name":"XBA"},{"description":"European Monetary Unit","name":"XBB"},{"description":"European Unit of Account 9","name":"XBC"},{"description":"European Unit of Account 17","name":"XBD"},{"description":"East Caribbean dollar","name":"XCD"},{"description":"Special drawing rights (International Monetary Fund)","name":"XDR"},{"description":"CFA franc BCEAO","name":"XOF"},{"description":"Palladium","name":"XPD"},{"description":"CFP franc","name":"XPF"},{"description":"Platinum","name":"XPT"},{"description":"Code reserved for testing","name":"XTS"},{"description":"No currency","name":"XXX"},{"description":"Yemeni rial","name":"YER"},{"description":"South African rand","name":"ZAR"},{"description":"Zambian kwacha","name":"ZMK"},{"description":"Zambian kwacha","name":"ZMW"},{"description":"Bitcoin","name":"BTC"},{"description":"Ether","name":"ETH"}]},"CustomField":{"additionalProperties":false,"properties":{"description":{"description":"More information about the custom field","example":"Employee Level","nullable":true,"title":"Description","type":"string"},"id":{"description":"Unique identifier for the custom field.","example":"2389328923893298","nullable":true,"title":"ID","type":"string"},"name":{"description":"Name of the custom field.","example":"employee_level","nullable":true,"title":"Name","type":"string"},"value":{"anyOf":[{"example":"Uses Salesforce and Marketo","nullable":true,"type":"string"},{"example":10,"nullable":true,"type":"number"},{"example":true,"nullable":true,"type":"boolean"},{"example":{"foo":"bar"},"nullable":true,"type":"object"},{"items":{"type":"string"},"type":"array"},{"items":{"type":"object"},"type":"array"}]}},"required":["id"],"type":"object","x-apideck-schema-id":"CustomField","x-apideck-weights":{"description":"edge-case","id":"critical","name":"medium","value":"critical"}},"CustomMappings":{"description":"When custom mappings are configured on the resource, the result is included here.","nullable":true,"type":"object","x-apideck-schema-id":"CustomMappings"},"DeleteActivityResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"delete","type":"string"},"resource":{"description":"Unified API resource name","example":"activities","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"DeleteActivityResponse"},"DeleteCompanyResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"delete","type":"string"},"resource":{"description":"Unified API resource name","example":"companies","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"DeleteCompanyResponse"},"DeleteContactResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"delete","type":"string"},"resource":{"description":"Unified API resource name","example":"contacts","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"DeleteContactResponse"},"DeleteLeadResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"delete","type":"string"},"resource":{"description":"Unified API resource name","example":"companies","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"DeleteLeadResponse"},"DeleteNoteResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"delete","type":"string"},"resource":{"description":"Unified API resource name","example":"notes","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"DeleteNoteResponse"},"DeleteOpportunityResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"delete","type":"string"},"resource":{"description":"Unified API resource name","example":"companies","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"DeleteOpportunityResponse"},"DeletePipelineResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"delete","type":"string"},"resource":{"description":"Unified API resource name","example":"companies","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"DeletePipelineResponse"},"DeleteUserResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"delete","type":"string"},"resource":{"description":"Unified API resource name","example":"users","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"DeleteUserResponse"},"Email":{"additionalProperties":false,"properties":{"email":{"description":"Email address","example":"elon@musk.com","format":"email","minLength":1,"nullable":true,"type":"string"},"id":{"description":"Unique identifier for the email address","example":"123","nullable":true,"type":"string"},"type":{"description":"Email type","enum":["primary","secondary","work","personal","billing","other"],"example":"primary","nullable":true,"type":"string","x-apideck-enum-id":"emails.type"}},"required":["email"],"type":"object","x-apideck-schema-id":"Email","x-apideck-weights":{"email":"critical","id":"edge-case","type":"critical"}},"FirstName":{"description":"The first name of the person.","example":"Elon","nullable":true,"title":"First name","type":"string"},"GetActivitiesResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Activity"},"type":"array"},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/Meta"},"operation":{"description":"Operation performed","example":"all","type":"string"},"resource":{"description":"Unified API resource name","example":"activities","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"GetActivitiesResponse"},"GetActivityResponse":{"properties":{"data":{"$ref":"#/components/schemas/Activity"},"operation":{"description":"Operation performed","example":"one","type":"string"},"resource":{"description":"Unified API resource name","example":"activities","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"GetActivityResponse"},"GetCompaniesResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Company"},"type":"array"},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/Meta"},"operation":{"description":"Operation performed","example":"all","type":"string"},"resource":{"description":"Unified API resource name","example":"companies","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"GetCompaniesResponse"},"GetCompanyResponse":{"properties":{"data":{"$ref":"#/components/schemas/Company"},"operation":{"description":"Operation performed","example":"one","type":"string"},"resource":{"description":"Unified API resource name","example":"companies","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"GetCompanyResponse"},"GetContactResponse":{"properties":{"data":{"$ref":"#/components/schemas/Contact"},"operation":{"description":"Operation performed","example":"one","type":"string"},"resource":{"description":"Unified API resource name","example":"companies","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"GetContactResponse"},"GetContactsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Contact"},"type":"array"},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/Meta"},"operation":{"description":"Operation performed","example":"all","type":"string"},"resource":{"description":"Unified API resource name","example":"contacts","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"GetContactsResponse"},"GetLeadResponse":{"properties":{"data":{"$ref":"#/components/schemas/Lead"},"operation":{"description":"Operation performed","example":"one","type":"string"},"resource":{"description":"Unified API resource name","example":"companies","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"GetLeadResponse"},"GetLeadsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Lead"},"type":"array"},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/Meta"},"operation":{"description":"Operation performed","example":"all","type":"string"},"resource":{"description":"Unified API resource name","example":"companies","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"GetLeadsResponse"},"GetNoteResponse":{"properties":{"data":{"$ref":"#/components/schemas/Note"},"operation":{"description":"Operation performed","example":"one","type":"string"},"resource":{"description":"Unified API resource name","example":"notes","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"GetNoteResponse"},"GetNotesResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Note"},"type":"array"},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/Meta"},"operation":{"description":"Operation performed","example":"all","type":"string"},"resource":{"description":"Unified API resource name","example":"notes","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"GetNotesResponse"},"GetOpportunitiesResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Opportunity"},"type":"array"},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/Meta"},"operation":{"description":"Operation performed","example":"all","type":"string"},"resource":{"description":"Unified API resource name","example":"opportunities","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"GetOpportunitiesResponse"},"GetOpportunityResponse":{"properties":{"data":{"$ref":"#/components/schemas/Opportunity"},"operation":{"description":"Operation performed","example":"one","type":"string"},"resource":{"description":"Unified API resource name","example":"opportunities","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"GetOpportunityResponse"},"GetPipelineResponse":{"properties":{"data":{"$ref":"#/components/schemas/Pipeline"},"operation":{"description":"Operation performed","example":"one","type":"string"},"resource":{"description":"Unified API resource name","example":"pipelines","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"GetPipelineResponse"},"GetPipelinesResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Pipeline"},"type":"array"},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/Meta"},"operation":{"description":"Operation performed","example":"all","type":"string"},"resource":{"description":"Unified API resource name","example":"pipelines","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"GetPipelinesResponse"},"GetUserResponse":{"properties":{"data":{"$ref":"#/components/schemas/User"},"operation":{"description":"Operation performed","example":"one","type":"string"},"resource":{"description":"Unified API resource name","example":"companies","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"GetUserResponse"},"GetUsersResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/User"},"type":"array"},"links":{"$ref":"#/components/schemas/Links"},"meta":{"$ref":"#/components/schemas/Meta"},"operation":{"description":"Operation performed","example":"all","type":"string"},"resource":{"description":"Unified API resource name","example":"users","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"GetUsersResponse"},"LastName":{"description":"The last name of the person.","example":"Musk","nullable":true,"title":"Last name","type":"string"},"Lead":{"additionalProperties":false,"properties":{"addresses":{"items":{"$ref":"#/components/schemas/Address"},"type":"array"},"company_id":{"description":"The company the lead is associated with.","example":"2","nullable":true,"type":"string"},"company_name":{"description":"The name of the company the lead is associated with.","example":"Spacex","nullable":true,"type":"string"},"created_at":{"description":"Date created in ISO 8601 format","example":"2025-08-15T13:51:17.601Z","nullable":true,"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$","readOnly":true,"type":"string"},"currency":{"$ref":"#/components/schemas/Currency"},"custom_fields":{"items":{"$ref":"#/components/schemas/CustomField"},"type":"array"},"custom_mappings":{"$ref":"#/components/schemas/CustomMappings"},"description":{"description":"The description of the lead.","example":"A thinker","nullable":true,"type":"string"},"emails":{"items":{"$ref":"#/components/schemas/Email"},"type":"array"},"fax":{"description":"The fax number of the lead.","example":"+12129876543","nullable":true,"type":"string"},"first_name":{"description":"The first name of the lead.","example":"Elon","nullable":true,"type":"string"},"id":{"description":"Unique identifier for the contact.","example":"12345","readOnly":true,"type":"string"},"language":{"description":"language code according to ISO 639-1. For the United States - EN","example":"EN","nullable":true,"type":"string"},"last_name":{"description":"The last name of the lead.","example":"Musk","nullable":true,"type":"string"},"lead_id":{"description":"The identifier of the lead.","example":"2","nullable":true,"type":"string"},"lead_source":{"description":"The source of the lead.","example":"Cold Call","nullable":true,"type":"string"},"monetary_amount":{"description":"The monetary amount of the lead.","example":75000,"nullable":true,"type":"number"},"name":{"description":"Full name of the lead.","example":"Elon Musk","minLength":1,"type":"string"},"owner_id":{"description":"The owner of the lead.","example":"54321","nullable":true,"type":"string"},"phone_numbers":{"items":{"$ref":"#/components/schemas/PhoneNumber"},"type":"array"},"prefix":{"description":"The prefix of the lead.","example":"Sir","nullable":true,"type":"string"},"social_links":{"items":{"$ref":"#/components/schemas/SocialLink"},"type":"array"},"status":{"example":"New","nullable":true,"type":"string"},"tags":{"$ref":"#/components/schemas/Tags"},"title":{"description":"The job title of the lead.","example":"CEO","nullable":true,"type":"string"},"updated_at":{"description":"Date updated in ISO 8601 format","example":"2025-08-15T13:51:17.601Z","nullable":true,"pattern":"^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}.\\d{3}Z$","readOnly":true,"type":"string"},"websites":{"items":{"$ref":"#/components/schemas/Website"},"type":"array"}},"required":["name","company_name"],"type":"object","x-apideck-schema-id":"Lead","x-apideck-weights":{"addresses":"high","company_id":"high","company_name":"high","contact_id":"low","created_at":"medium","currency":"low","custom_fields":"medium","description":"low","emails":"high","fax":"low","first_name":"high","id":"critical","language":"medium","last_name":"high","lead_source":"low","monetary_amount":"low","name":"critical","owner_id":"high","phone_numbers":"high","prefix":"low","social_links":"low","status":"high","tags":"low","title":"high","updated_at":"medium","websites":"medium"},"x-pii":["name","email","first_name","last_name"]},"LeadsFilter":{"additionalProperties":false,"example":{"email":"elon@tesla.com","first_name":"Elon","last_name":"Musk"},"properties":{"email":{"description":"E-mail of the lead to filter on","example":"elon@tesla.com","type":"string"},"first_name":{"description":"First name of the lead to filter on","example":"Elon","type":"string"},"last_name":{"description":"Last name of the lead to filter on","example":"Musk","type":"string"},"name":{"description":"Name of the lead to filter on","example":"Elon Musk","type":"string"}},"type":"object","x-apideck-schema-id":"LeadsFilter"},"LeadsSort":{"additionalProperties":false,"example":{"by":"created_at","direction":"desc"},"properties":{"by":{"description":"The field on which to sort the Leads","enum":["created_at","updated_at","name","first_name","last_name","email"],"example":"created_at","type":"string","x-apideck-enum-id":"leads.sort_by"},"direction":{"$ref":"#/components/schemas/SortDirection"}},"type":"object","x-apideck-schema-id":"LeadsSort"},"Links":{"description":"Links to navigate to previous or next pages through the API","properties":{"current":{"description":"Link to navigate to the current page through the API","example":"https://unify.apideck.com/crm/companies","type":"string"},"next":{"description":"Link to navigate to the previous page through the API","example":"https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM","nullable":true,"type":"string"},"previous":{"description":"Link to navigate to the previous page through the API","example":"https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D","nullable":true,"type":"string"}},"type":"object","x-apideck-schema-id":"Links"},"Meta":{"description":"Response metadata","properties":{"cursors":{"description":"Cursors to navigate to previous or next pages through the API","properties":{"current":{"description":"Cursor to navigate to the current page of results through the API","example":"em9oby1jcm06OnBhZ2U6OjI=","nullable":true,"type":"string"},"next":{"description":"Cursor to navigate to the next page of results through the API","example":"em9oby1jcm06OnBhZ2U6OjM=","nullable":true,"type":"string"},"previous":{"description":"Cursor to navigate to the previous page of results through the API","example":"em9oby1jcm06OnBhZ2U6OjE=","nullable":true,"type":"string"}},"type":"object"},"items_on_page":{"description":"Number of items returned in the data property of the response","example":50,"type":"integer"}},"type":"object","x-apideck-schema-id":"Meta"},"NotFoundResponse":{"properties":{"detail":{"anyOf":[{"example":"Could not find widget with id: '123'","type":"string"},{"example":{"not_found":{"entity":"widget","id":"123"}},"type":"object"}],"description":"Contains parameter or domain specific information related to the error and why it occurred."},"error":{"description":"Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)","example":"Not Found","type":"string"},"message":{"description":"A human-readable message providing more details about the error.","example":"Unknown Widget","type":"string"},"ref":{"description":"Link to documentation of error type","example":"https://developers.apideck.com/errors#entitynotfounderror","type":"string"},"status_code":{"description":"HTTP status code","example":404,"type":"number"},"type_name":{"description":"The type of error returned","example":"EntityNotFoundError","type":"string"}},"type":"object","x-apideck-schema-id":"NotFound"},"NotImplementedResponse":{"properties":{"detail":{"anyOf":[{"example":"Failed to retrieve Widget tokenUrl from 'components.securitySchemes.OAuth2.flows'","type":"string"},{"type":"object"}],"description":"Contains parameter or domain specific information related to the error and why it occurred."},"error":{"description":"Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)","example":"Not Implemented","type":"string"},"message":{"description":"A human-readable message providing more details about the error.","example":"Unmapped Attribute","type":"string"},"ref":{"description":"Link to documentation of error type","example":"https://developers.apideck.com/errors#mappingerror","type":"string"},"status_code":{"description":"HTTP status code","example":501,"type":"number"},"type_name":{"description":"The type of error returned","example":"MappingError","type":"string"}},"type":"object","x-apideck-schema-id":"NotImplemented"},"Note":{"additionalProperties":false,"properties":{"active":{"description":"Whether the Note is active or not.","example":true,"nullable":true,"type":"boolean"},"company_id":{"description":"The company that is related to the note.","example":"12345","nullable":true,"type":"string"},"contact_id":{"description":"The contact that is related to the note.","example":"12345","nullable":true,"type":"string"},"content":{"description":"The content of the note.","example":"Office hours are 9AM-6PM","nullable":true,"type":"string"},"created_at":{"description":"The timestamp when the note was created","example":"2025-08-15T13:51:17.601Z","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"The user that created the note.","example":"12345","nullable":true,"readOnly":true,"type":"string"},"custom_mappings":{"$ref":"#/components/schemas/CustomMappings"},"id":{"description":"The unique identifier of the note","example":"12345","readOnly":true,"type":"string"},"lead_id":{"description":"The lead that is related to the note.","example":"12345","nullable":true,"type":"string"},"opportunity_id":{"description":"The opportunity that is related to the note.","example":"12345","nullable":true,"type":"string"},"owner_id":{"description":"The user that owns the note.","example":"12345","nullable":true,"type":"string"},"title":{"description":"The title of the note","example":"Meeting Notes","nullable":true,"type":"string"},"updated_at":{"description":"The timestamp when the note was last updated","example":"2025-08-15T13:51:17.601Z","nullable":true,"readOnly":true,"type":"string"},"updated_by":{"description":"The user that last updated the note.","example":"12345","nullable":true,"readOnly":true,"type":"string"}},"type":"object","x-apideck-schema-id":"Note","x-apideck-weights":{"active":"low","company_id":"medium","contact_id":"medium","content":"critical","created_at":"medium","created_by":"edge-case","id":"critical","lead_id":"medium","opportunity_id":"medium","owner_id":"high","title":"critical","updated_at":"medium","updated_by":"edge-case"}},"OpportunitiesFilter":{"additionalProperties":false,"example":{"monetary_amount":75000,"status":"Completed"},"properties":{"company_id":{"description":"Company ID to filter on","example":"1234","type":"string"},"monetary_amount":{"description":"Monetary amount to filter on","example":75000,"type":"number"},"status":{"description":"Status to filter on","example":"Completed","type":"string"},"title":{"description":"Title of the opportunity to filter on","example":"Tesla deal","type":"string"},"win_probability":{"description":"Win probability to filter on","example":50,"type":"number"}},"type":"object","x-apideck-schema-id":"OpportunitiesFilter"},"OpportunitiesSort":{"additionalProperties":false,"example":{"by":"created_at","direction":"desc"},"properties":{"by":{"description":"The field on which to sort the Opportunities","enum":["created_at","updated_at","title","win_probability","monetary_amount","status"],"example":"created_at","type":"string","x-apideck-enum-id":"opportunities.sort_by"},"direction":{"$ref":"#/components/schemas/SortDirection"}},"type":"object","x-apideck-schema-id":"OpportunitiesSort"},"Opportunity":{"additionalProperties":false,"properties":{"close_date":{"description":"The actual closing date for the opportunity. If close_date is null, the opportunity is not closed yet.","example":"2025-08-15T13:51:17.601Z","format":"date","nullable":true,"type":"string"},"company_id":{"description":"The unique identifier of the company associated with the opportunity.","example":"12345","nullable":true,"type":"string"},"company_name":{"description":"The name of the company associated with the opportunity.","example":"Copper","nullable":true,"type":"string"},"contact_id":{"description":"The unique identifier of the contact associated with the opportunity.","example":"12345","nullable":true,"type":"string"},"contact_ids":{"description":"An array of unique identifiers of all contacts associated with the opportunity.","items":{"example":"12345","type":"string"},"type":"array"},"created_at":{"description":"The date and time when the opportunity was created.","example":"2025-08-15T13:51:17.601Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"created_by":{"description":"The unique identifier of the user who created the opportunity.","example":"12345","nullable":true,"readOnly":true,"type":"string"},"currency":{"$ref":"#/components/schemas/Currency"},"custom_fields":{"items":{"$ref":"#/components/schemas/CustomField"},"type":"array"},"custom_mappings":{"$ref":"#/components/schemas/CustomMappings"},"date_last_contacted":{"description":"The date and time when the opportunity was last contacted.","example":"2025-08-15T13:51:17.601Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"date_lead_created":{"description":"The date and time when the lead associated with the opportunity was created.","example":"2025-08-15T13:51:17.601Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"date_stage_changed":{"description":"The date and time when the stage of the opportunity was last changed.","example":"2025-08-15T13:51:17.601Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"deleted":{"description":"Indicates whether the opportunity has been deleted.","example":false,"readOnly":true,"type":"boolean"},"description":{"description":"A description of the opportunity.","example":"Opportunities are created for People and Companies that are interested in buying your products or services. Create Opportunities for People and Companies to move them through one of your Pipelines.","nullable":true,"type":"string"},"expected_revenue":{"description":"The expected revenue from the opportunity","example":75000,"nullable":true,"readOnly":true,"type":"number"},"id":{"description":"A unique identifier for the opportunity.","example":"12345","readOnly":true,"type":"string"},"interaction_count":{"description":"The number of interactions with the opportunity.","example":0,"nullable":true,"readOnly":true,"type":"number"},"last_activity_at":{"description":"The date and time of the last activity associated with the opportunity.","example":"2025-08-15T13:51:17.601Z","nullable":true,"readOnly":true,"type":"string"},"lead_id":{"description":"The unique identifier of the lead associated with the opportunity.","example":"12345","nullable":true,"type":"string"},"lead_source":{"description":"The source of the lead associated with the opportunity.","example":"Website","nullable":true,"type":"string"},"loss_reason":{"description":"The reason why the opportunity was lost.","example":"No budget","nullable":true,"type":"string"},"loss_reason_id":{"description":"The unique identifier of the reason why the opportunity was lost.","example":"12345","nullable":true,"type":"string"},"monetary_amount":{"description":"The monetary value associated with the opportunity","example":75000,"nullable":true,"type":"number"},"owner_id":{"description":"The unique identifier of the user who owns the opportunity.","example":"12345","nullable":true,"type":"string"},"pipeline_id":{"description":"The unique identifier of the pipeline associated with the opportunity","example":"12345","nullable":true,"type":"string"},"pipeline_stage_id":{"description":"The unique identifier of the stage in the pipeline associated with the opportunity.","example":"12345","nullable":true,"type":"string"},"primary_contact_id":{"description":"The unique identifier of the primary contact associated with the opportunity.","example":"12345","nullable":true,"type":"string"},"priority":{"description":"The priority level of the opportunity.","example":"None","nullable":true,"type":"string"},"source_id":{"description":"The unique identifier of the source of the opportunity.","example":"12345","nullable":true,"type":"string"},"stage_last_changed_at":{"description":"The date and time when the stage of the opportunity was last changed.","example":"2025-08-15T13:51:17.601Z","format":"date-time","nullable":true,"type":"string"},"status":{"description":"The current status of the opportunity.","example":"Open","nullable":true,"type":"string"},"status_id":{"description":"The unique identifier of the current status of the opportunity.","example":"12345","nullable":true,"type":"string"},"tags":{"$ref":"#/components/schemas/Tags"},"title":{"description":"The title or name of the opportunity.","example":"New Rocket","minLength":1,"type":"string"},"type":{"description":"The type of the opportunity","example":"Existing Customer - Upgrade","nullable":true,"type":"string"},"updated_at":{"description":"The date and time when the opportunity was last updated.","example":"2025-08-15T13:51:17.601Z","format":"date-time","nullable":true,"readOnly":true,"type":"string"},"updated_by":{"description":"The unique identifier of the user who last updated the opportunity.","example":"12345","nullable":true,"readOnly":true,"type":"string"},"win_probability":{"description":"The probability of winning the opportunity, expressed as a percentage.","example":40,"nullable":true,"type":"number"},"won_reason":{"description":"The reason why the opportunity was won.","example":"Best pitch","nullable":true,"type":"string"},"won_reason_id":{"description":"The unique identifier of the reason why the opportunity was won.","example":"12345","nullable":true,"type":"string"}},"required":["title","primary_contact_id"],"type":"object","x-apideck-schema-id":"Opportunity","x-apideck-weights":{"close_date":"medium","company_id":"high","company_name":"medium","contact_id":"medium","created_at":"medium","created_by":"edge-case","currency":"high","custom_fields":"medium","date_last_contacted":"medium","date_lead_created":"edge-case","date_stage_changed":"edge-case","deleted":"low","description":"medium","expected_revenue":"medium","id":"critical","interaction_count":"low","last_activity_at":"medium","lead_id":"medium","lead_source":"edge-case","loss_reason":"edge-case","loss_reason_id":"edge-case","monetary_amount":"high","owner_id":"high","pipeline_id":"edge-case","pipeline_stage_id":"edge-case","primary_contact_id":"critical","priority":"medium","source_id":"medium","stage_last_changed_at":"edge-case","status":"high","status_id":"edge-case","tags":"low","title":"critical","type":"high","updated_at":"medium","updated_by":"edge-case","win_probability":"high","won_reason":"edge-case","won_reason_id":"edge-case"}},"PassThroughQuery":{"additionalProperties":true,"example":{"search":"San Francisco"},"properties":{"example_downstream_property":{"description":"All passthrough query parameters are passed along to the connector as is (?pass_through[search]=leads becomes ?search=leads)","type":"string"}},"type":"object"},"PaymentRequiredResponse":{"properties":{"detail":{"description":"Contains parameter or domain specific information related to the error and why it occurred.","example":"You have reached your limit of 2000","type":"string"},"error":{"description":"Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)","example":"Payment Required","type":"string"},"message":{"description":"A human-readable message providing more details about the error.","example":"Request Limit Reached","type":"string"},"ref":{"description":"Link to documentation of error type","example":"https://developers.apideck.com/errors#requestlimiterror","type":"string"},"status_code":{"description":"HTTP status code","example":402,"type":"number"},"type_name":{"description":"The type of error returned","example":"RequestLimitError","type":"string"}},"type":"object","x-apideck-schema-id":"PaymentRequired"},"PhoneNumber":{"additionalProperties":false,"properties":{"area_code":{"description":"The area code of the phone number, e.g. 323","example":"323","nullable":true,"title":"Area code","type":"string"},"country_code":{"description":"The country code of the phone number, e.g. +1","example":"1","nullable":true,"title":"Country code","type":"string"},"extension":{"description":"The extension of the phone number","example":"105","nullable":true,"title":"Phone extension","type":"string"},"id":{"description":"Unique identifier of the phone number","example":"12345","nullable":true,"type":"string"},"number":{"description":"The phone number","example":"111-111-1111","minLength":1,"title":"Phone number","type":"string"},"type":{"description":"The type of phone number","enum":["primary","secondary","home","work","office","mobile","assistant","fax","direct-dial-in","personal","other"],"example":"primary","nullable":true,"type":"string","x-apideck-enum-id":"phone_numbers.type"}},"required":["number"],"type":"object","x-apideck-schema-id":"PhoneNumber","x-apideck-weights":{"area_code":"edge-case","country_code":"edge-case","extension":"edge-case","id":"edge-case","number":"critical","type":"critical"}},"Pipeline":{"additionalProperties":false,"properties":{"active":{"description":"Whether the Pipeline is active or not.","example":false,"type":"boolean"},"archived":{"description":"Whether the Pipeline is archived or not.","example":false,"type":"boolean"},"created_at":{"description":"The date and time when the object was created.","example":"2025-08-15T13:51:17.601Z","format":"date-time","nullable":true,"readOnly":true,"title":"Created at (timestamp)","type":"string"},"currency":{"$ref":"#/components/schemas/Currency"},"display_order":{"description":"The order in which the Pipeline is displayed in the UI.","example":1,"nullable":true,"type":"integer"},"id":{"description":"The unique identifier of the Pipeline.","example":"default","type":"string"},"name":{"description":"The name of the Pipeline.","example":"Sales Pipeline","minLength":1,"type":"string"},"stages":{"description":"The Pipeline Stages.","items":{"additionalProperties":false,"properties":{"display_order":{"description":"The order in which the Pipeline Stage is displayed in the UI.","example":1,"nullable":true,"type":"integer"},"id":{"description":"The unique identifier of the Pipeline Stage.","example":"contractsent","nullable":true,"readOnly":true,"type":"string"},"name":{"description":"The name of the Pipeline Stage.","example":"Contract Sent","nullable":true,"type":"string"},"value":{"description":"The value of the Pipeline Stage.","example":"CONTRACT_SENT","nullable":true,"type":"string"},"win_probability":{"description":"The expected probability of winning an Opportunity in this Pipeline Stage. Valid values are [0-100].","example":50,"nullable":true,"type":"integer"}},"type":"object","x-apideck-weights":{"display_order":"medium","id":"medium","name":"medium","value":"medium","win_probability":"medium"}},"type":"array"},"updated_at":{"description":"The date and time when the object was last updated.","example":"2025-08-15T13:51:17.601Z","format":"date-time","nullable":true,"readOnly":true,"title":"Updated at (timestamp)","type":"string"},"win_probability_enabled":{"description":"Whether the Pipeline has win probability enabled or not.","example":true,"type":"boolean"}},"required":["name"],"type":"object","x-apideck-schema-id":"Pipeline","x-apideck-weights":{"archived":"low","created_at":"medium","currency":"low","display_order":"edge-case","id":"critical","name":"critical","stages":"high","updated_at":"medium","win_probability_enabled":"edge-case"},"x-pii":[]},"RowVersion":{"description":"A binary value used to detect updates to a object and prevent data conflicts. It is incremented each time an update is made to the object.","example":"1-12345","nullable":true,"title":"Row version","type":"string"},"SocialLink":{"additionalProperties":false,"properties":{"id":{"description":"Unique identifier of the social link","example":"12345","nullable":true,"type":"string"},"type":{"description":"Type of the social link, e.g. twitter","example":"twitter","nullable":true,"type":"string"},"url":{"description":"URL of the social link, e.g. https://www.twitter.com/apideck","example":"https://www.twitter.com/apideck","minLength":1,"type":"string"}},"required":["url"],"type":"object","x-apideck-schema-id":"SocialLink","x-apideck-weights":{"id":"edge-case","type":"critical","url":"critical"}},"SortDirection":{"default":"asc","description":"The direction in which to sort the results","enum":["asc","desc"],"type":"string","x-apideck-enum-id":"sort_direction","x-apideck-schema-id":"SortDirection"},"Tags":{"example":["New"],"items":{"type":"string"},"nullable":true,"type":"array","x-apideck-schema-id":"Tags"},"TooManyRequestsResponse":{"properties":{"detail":{"properties":{"context":{"type":"string"},"error":{"additionalProperties":true,"type":"object"}},"type":"object"},"error":{"description":"Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 6585)","example":"Too Many Requests","type":"string"},"message":{"description":"A human-readable message providing more details about the error.","example":"Connector Rate Limit Error","type":"string"},"ref":{"description":"Link to documentation of error type","example":"https://developers.apideck.com/errors#connectorratelimiterror","type":"string"},"status_code":{"description":"HTTP status code","example":429,"type":"number"},"type_name":{"description":"The type of error returned","example":"ConnectorRateLimitError","type":"string"}},"type":"object","x-apideck-schema-id":"TooManyRequests"},"UnauthorizedResponse":{"properties":{"detail":{"description":"Contains parameter or domain specific information related to the error and why it occurred.","example":"Failed to generate valid JWT Session. Verify applicationId is correct","type":"string"},"error":{"description":"Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)","example":"Unauthorized","type":"string"},"message":{"description":"A human-readable message providing more details about the error.","example":"Unauthorized Request","type":"string"},"ref":{"description":"Link to documentation of error type","example":"https://developers.apideck.com/errors#unauthorizederror","type":"string"},"status_code":{"description":"HTTP status code","example":401,"type":"number"},"type_name":{"description":"The type of error returned","example":"UnauthorizedError","type":"string"}},"type":"object","x-apideck-schema-id":"Unauthorized"},"UnexpectedErrorResponse":{"properties":{"detail":{"anyOf":[{"example":"Missing Header: x-apideck-consumer-id","type":"string"},{"example":{"missing":[{"x-apideck-consumer-id":"required"}]},"type":"object"}],"description":"Contains parameter or domain specific information related to the error and why it occurred."},"error":{"description":"Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)","example":"Bad Request","type":"string"},"message":{"description":"A human-readable message providing more details about the error.","example":"Invalid Params","type":"string"},"ref":{"description":"Link to documentation of error type","example":"https://developers.apideck.com/errors#unauthorizederror","type":"string"},"status_code":{"description":"HTTP status code","example":400,"type":"number"},"type_name":{"description":"The type of error returned","example":"RequestHeadersValidationError","type":"string"}},"type":"object","x-apideck-schema-id":"Error"},"UnifiedId":{"properties":{"id":{"description":"The unique identifier of the resource","example":"12345","readOnly":true,"title":"Id","type":"string"}},"required":["id"],"title":"UnifiedId","type":"object","x-apideck-schema-id":"Id"},"UnprocessableResponse":{"properties":{"detail":{"description":"Contains parameter or domain specific information related to the error and why it occurred.","example":"Unprocessable request, please verify your request headers and body.","type":"string"},"error":{"description":"Contains an explanation of the status_code as defined in HTTP/1.1 standard (RFC 7231)","example":"Unprocessable Entity","type":"string"},"message":{"description":"A human-readable message providing more details about the error.","example":"Invalid State","type":"string"},"ref":{"description":"Link to documentation of error type","example":"https://developers.apideck.com/errors#invalidstateerror","type":"string"},"status_code":{"description":"HTTP status code","example":422,"type":"number"},"type_name":{"description":"The type of error returned","example":"InvalidStateError","type":"string"}},"type":"object","x-apideck-schema-id":"Unprocessable"},"UpdateActivityResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"update","type":"string"},"resource":{"description":"Unified API resource name","example":"activities","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"UpdateActivityResponse"},"UpdateCompanyResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"update","type":"string"},"resource":{"description":"Unified API resource name","example":"companies","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"UpdateCompanyResponse"},"UpdateContactResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"update","type":"string"},"resource":{"description":"Unified API resource name","example":"contacts","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"UpdateContactResponse"},"UpdateLeadResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"update","type":"string"},"resource":{"description":"Unified API resource name","example":"companies","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"UpdateLeadResponse"},"UpdateNoteResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"update","type":"string"},"resource":{"description":"Unified API resource name","example":"notes","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"UpdateNoteResponse"},"UpdateOpportunityResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"update","type":"string"},"resource":{"description":"Unified API resource name","example":"companies","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"UpdateOpportunityResponse"},"UpdatePipelineResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"update","type":"string"},"resource":{"description":"Unified API resource name","example":"pipelines","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"UpdatePipelineResponse"},"UpdateUserResponse":{"properties":{"data":{"$ref":"#/components/schemas/UnifiedId"},"operation":{"description":"Operation performed","example":"update","type":"string"},"resource":{"description":"Unified API resource name","example":"companies","type":"string"},"service":{"description":"Apideck ID of service provider","example":"zoho-crm","type":"string"},"status":{"description":"HTTP Response Status","example":"OK","type":"string"},"status_code":{"description":"HTTP Response Status Code","example":200,"type":"integer"}},"required":["status_code","status","service","resource","operation","data"],"type":"object","x-apideck-schema-id":"UpdateUserResponse"},"User":{"properties":{"addresses":{"items":{"$ref":"#/components/schemas/Address"},"type":"array"},"company_name":{"description":"The name of the company.","example":"SpaceX","nullable":true,"title":"Company name","type":"string"},"created_at":{"description":"The date and time when the user was created.","example":"2025-08-15T13:51:17.601Z","nullable":true,"readOnly":true,"type":"string"},"custom_mappings":{"$ref":"#/components/schemas/CustomMappings"},"department":{"deprecated":true,"description":"The department the person is currently in. [Deprecated](https://developers.apideck.com/changelog) in favor of the dedicated department_id and department_name field.","example":"R&D","nullable":true,"title":"Department","type":"string"},"description":{"description":"A description of the object.","example":"A description","nullable":true,"title":"Description","type":"string"},"division":{"description":"The division the person is currently in. Usually a collection of departments or teams or regions.","example":"Europe","nullable":true,"title":"Division","type":"string"},"emails":{"items":{"$ref":"#/components/schemas/Email"},"type":"array"},"employee_number":{"description":"An Employee Number, Employee ID or Employee Code, is a unique number that has been assigned to each individual staff member within a company.","example":"123456-AB","nullable":true,"title":"Employee number","type":"string"},"first_name":{"$ref":"#/components/schemas/FirstName"},"id":{"description":"The unique identifier for the user","example":"12345","readOnly":true,"type":"string"},"image":{"description":"The URL of the user's avatar","example":"https://logo.clearbit.com/spacex.com?s=128","nullable":true,"type":"string"},"language":{"description":"language code according to ISO 639-1. For the United States - EN","example":"EN","nullable":true,"type":"string"},"last_name":{"$ref":"#/components/schemas/LastName"},"parent_id":{"description":"The parent user id","example":"54321","nullable":true,"type":"string"},"password":{"description":"The password of the user","example":"supersecretpassword","nullable":true,"type":"string","writeOnly":true},"phone_numbers":{"items":{"$ref":"#/components/schemas/PhoneNumber"},"type":"array"},"status":{"description":"The status of the user","example":"active","nullable":true,"type":"string"},"title":{"description":"The job title of the person.","example":"CEO","nullable":true,"title":"Job title","type":"string"},"updated_at":{"description":"The date and time when the user was last updated.","example":"2025-08-15T13:51:17.601Z","nullable":true,"readOnly":true,"type":"string"},"username":{"description":"The username of the user","example":"masterofcoin","nullable":true,"type":"string"}},"required":["emails"],"type":"object","x-apideck-schema-id":"User","x-apideck-weights":{"addresses":"high","company_name":"medium","created_at":"medium","department":"medium","description":"low","division":"medium","emails":"high","employee_number":"medium","first_name":"high","id":"critical","image":"medium","language":"medium","last_name":"high","parent_id":"edge-case","password":"medium","phone_numbers":"high","status":"high","title":"high","updated_at":"medium","username":"medium"},"x-pii":["username","first_name","last_name","email"]},"Website":{"additionalProperties":false,"properties":{"id":{"description":"Unique identifier for the website","example":"12345","nullable":true,"type":"string"},"type":{"description":"The type of website","enum":["primary","secondary","work","personal","other"],"example":"primary","nullable":true,"type":"string","x-apideck-enum-id":"websites.type"},"url":{"description":"The website URL","example":"http://example.com","minLength":1,"type":"string"}},"required":["url"],"type":"object","x-apideck-schema-id":"Website","x-apideck-weights":{"id":"edge-case","type":"critical","url":"critical"}}},"securitySchemes":{"apiKey":{"description":"To use API you have to sign up and get your own API key. Unify API accounts have sandbox mode and live mode API keys. \nTo change modes just use the appropriate key to get a live or test object. You can find your API keys on the unify settings of your Apideck app.\nYour Apideck application_id can also be found on the same page.\n\nAuthenticate your API requests by including your test or live secret API key in the request header. \n\n- Bearer authorization header: `Authorization: Bearer <your-apideck-api-key>`\n- Application id header: `x-apideck-app-id: <your-apideck-app-id>`\n\nYou should use the public keys on the SDKs and the secret keys to authenticate API requests.\n\n**Do not share or include your secret API keys on client side code.** Your API keys carry significant privileges. Please ensure to keep them 100% secure and be sure to not share your secret API keys in areas that are publicly accessible like GitHub.\n\nLearn how to set the Authorization header inside Postman https://learning.postman.com/docs/postman/sending-api-requests/authorization/#api-key\n\nGo to Unify to grab your API KEY https://app.apideck.com/unify/api-keys\n","in":"header","name":"Authorization","type":"apiKey"},"applicationId":{"description":"The ID of your Unify application","in":"header","name":"x-apideck-app-id","type":"apiKey"},"consumerId":{"description":"The ID of the consumer which you want to get or push data from","in":"header","name":"x-apideck-consumer-id","type":"apiKey"}}},"x-webhooks":{"ActivityCreated":{"post":{"description":"Event broadcast when an activity has been created.","operationId":"activityCreated","parameters":[{"description":"The type of event that was triggered","in":"header","name":"x-apideck-event-type","required":true,"schema":{"$ref":"#/components/schemas/CrmEventType"}},{"description":"An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.","in":"header","name":"x-apideck-idempotency-key","required":true,"schema":{"example":"d290f1ee-6c54-4b01-90e6-d701748f0851","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"payload":{"consumer_id":"test_user_id","entity_id":"123456ASDF","entity_type":"activity","entity_url":"https://unify.apideck.com/crm/activities/123456ASDF","event_id":"d290f1ee-6c54-4b01-90e6-d701748f0851","event_type":"crm.activity.created","occurred_at":"2025-08-15T13:51:17.601Z","service_id":"hubspot","unified_api":"crm"}},"schema":{"properties":{"payload":{"$ref":"#/components/schemas/CrmWebhookEvent"}},"type":"object"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully."}},"security":[],"summary":"Activity Created","tags":["Webhook Events"],"x-apideck-event-type":"crm.activity.created"}},"ActivityDeleted":{"post":{"description":"Event broadcast when an activity has been deleted.","operationId":"activityDeleted","parameters":[{"description":"The type of event that was triggered","in":"header","name":"x-apideck-event-type","required":true,"schema":{"$ref":"#/components/schemas/CrmEventType"}},{"description":"An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.","in":"header","name":"x-apideck-idempotency-key","required":true,"schema":{"example":"d290f1ee-6c54-4b01-90e6-d701748f0851","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"payload":{"consumer_id":"test_user_id","entity_id":"123456ASDF","entity_type":"activity","entity_url":"https://unify.apideck.com/crm/activities/123456ASDF","event_id":"d290f1ee-6c54-4b01-90e6-d701748f0851","event_type":"crm.activity.deleted","occurred_at":"2025-08-15T13:51:17.601Z","service_id":"hubspot","unified_api":"crm"}},"schema":{"properties":{"payload":{"$ref":"#/components/schemas/CrmWebhookEvent"}},"type":"object"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully."}},"security":[],"summary":"Activity Deleted","tags":["Webhook Events"],"x-apideck-event-type":"crm.activity.deleted"}},"ActivityUpdated":{"post":{"description":"Event broadcast when an activity has been updated.","operationId":"activityUpdated","parameters":[{"description":"The type of event that was triggered","in":"header","name":"x-apideck-event-type","required":true,"schema":{"$ref":"#/components/schemas/CrmEventType"}},{"description":"An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.","in":"header","name":"x-apideck-idempotency-key","required":true,"schema":{"example":"d290f1ee-6c54-4b01-90e6-d701748f0851","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"payload":{"consumer_id":"test_user_id","entity_id":"123456ASDF","entity_type":"activity","entity_url":"https://unify.apideck.com/crm/activities/123456ASDF","event_id":"d290f1ee-6c54-4b01-90e6-d701748f0851","event_type":"crm.activity.updated","occurred_at":"2025-08-15T13:51:17.602Z","service_id":"hubspot","unified_api":"crm"}},"schema":{"properties":{"payload":{"$ref":"#/components/schemas/CrmWebhookEvent"}},"type":"object"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully."}},"security":[],"summary":"Activity Updated","tags":["Webhook Events"],"x-apideck-event-type":"crm.activity.updated"}},"CompanyCreated":{"post":{"description":"Event broadcast when a company has been created.","operationId":"companyCreated","parameters":[{"description":"The type of event that was triggered","in":"header","name":"x-apideck-event-type","required":true,"schema":{"$ref":"#/components/schemas/CrmEventType"}},{"description":"An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.","in":"header","name":"x-apideck-idempotency-key","required":true,"schema":{"example":"d290f1ee-6c54-4b01-90e6-d701748f0851","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"payload":{"consumer_id":"test_user_id","entity_id":"123456ASDF","entity_type":"company","entity_url":"https://unify.apideck.com/crm/companies/123456ASDF","event_id":"d290f1ee-6c54-4b01-90e6-d701748f0851","event_type":"crm.company.created","occurred_at":"2025-08-15T13:51:17.602Z","service_id":"hubspot","unified_api":"crm"}},"schema":{"properties":{"payload":{"$ref":"#/components/schemas/CrmWebhookEvent"}},"type":"object"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully."}},"security":[],"summary":"Company Created","tags":["Webhook Events"],"x-apideck-event-type":"crm.company.created"}},"CompanyDeleted":{"post":{"description":"Event broadcast when a company has been deleted.","operationId":"companyDeleted","parameters":[{"description":"The type of event that was triggered","in":"header","name":"x-apideck-event-type","required":true,"schema":{"$ref":"#/components/schemas/CrmEventType"}},{"description":"An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.","in":"header","name":"x-apideck-idempotency-key","required":true,"schema":{"example":"d290f1ee-6c54-4b01-90e6-d701748f0851","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"payload":{"consumer_id":"test_user_id","entity_id":"123456ASDF","entity_type":"company","entity_url":"https://unify.apideck.com/crm/companies/123456ASDF","event_id":"d290f1ee-6c54-4b01-90e6-d701748f0851","event_type":"crm.company.deleted","occurred_at":"2025-08-15T13:51:17.602Z","service_id":"hubspot","unified_api":"crm"}},"schema":{"properties":{"payload":{"$ref":"#/components/schemas/CrmWebhookEvent"}},"type":"object"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully."}},"security":[],"summary":"Company Deleted","tags":["Webhook Events"],"x-apideck-event-type":"crm.company.deleted"}},"CompanyUpdated":{"post":{"description":"Event broadcast when a company has been updated.","operationId":"companyUpdated","parameters":[{"description":"The type of event that was triggered","in":"header","name":"x-apideck-event-type","required":true,"schema":{"$ref":"#/components/schemas/CrmEventType"}},{"description":"An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.","in":"header","name":"x-apideck-idempotency-key","required":true,"schema":{"example":"d290f1ee-6c54-4b01-90e6-d701748f0851","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"payload":{"consumer_id":"test_user_id","entity_id":"123456ASDF","entity_type":"company","entity_url":"https://unify.apideck.com/crm/companies/123456ASDF","event_id":"d290f1ee-6c54-4b01-90e6-d701748f0851","event_type":"crm.company.updated","occurred_at":"2025-08-15T13:51:17.602Z","service_id":"hubspot","unified_api":"crm"}},"schema":{"properties":{"payload":{"$ref":"#/components/schemas/CrmWebhookEvent"}},"type":"object"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully."}},"security":[],"summary":"Company Updated","tags":["Webhook Events"],"x-apideck-event-type":"crm.company.updated"}},"ContactCreated":{"post":{"description":"Event broadcast when a contact has been created.","operationId":"contactCreated","parameters":[{"description":"The type of event that was triggered","in":"header","name":"x-apideck-event-type","required":true,"schema":{"$ref":"#/components/schemas/CrmEventType"}},{"description":"An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.","in":"header","name":"x-apideck-idempotency-key","required":true,"schema":{"example":"d290f1ee-6c54-4b01-90e6-d701748f0851","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"payload":{"consumer_id":"test_user_id","entity_id":"123456ASDF","entity_type":"contact","entity_url":"https://unify.apideck.com/crm/contacts/123456ASDF","event_id":"d290f1ee-6c54-4b01-90e6-d701748f0851","event_type":"crm.contact.created","occurred_at":"2025-08-15T13:51:17.602Z","service_id":"hubspot","unified_api":"crm"}},"schema":{"properties":{"payload":{"$ref":"#/components/schemas/CrmWebhookEvent"}},"type":"object"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully."}},"security":[],"summary":"Contact Created","tags":["Webhook Events"],"x-apideck-event-type":"crm.contact.created"}},"ContactDeleted":{"post":{"description":"Event broadcast when a contact has been deleted.","operationId":"contactDeleted","parameters":[{"description":"The type of event that was triggered","in":"header","name":"x-apideck-event-type","required":true,"schema":{"$ref":"#/components/schemas/CrmEventType"}},{"description":"An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.","in":"header","name":"x-apideck-idempotency-key","required":true,"schema":{"example":"d290f1ee-6c54-4b01-90e6-d701748f0851","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"payload":{"consumer_id":"test_user_id","entity_id":"123456ASDF","entity_type":"contact","entity_url":"https://unify.apideck.com/crm/contacts/123456ASDF","event_id":"d290f1ee-6c54-4b01-90e6-d701748f0851","event_type":"crm.contact.deleted","occurred_at":"2025-08-15T13:51:17.602Z","service_id":"hubspot","unified_api":"crm"}},"schema":{"properties":{"payload":{"$ref":"#/components/schemas/CrmWebhookEvent"}},"type":"object"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully."}},"security":[],"summary":"Contact Deleted","tags":["Webhook Events"],"x-apideck-event-type":"crm.contact.deleted"}},"ContactUpdated":{"post":{"description":"Event broadcast when a contact has been updated.","operationId":"contactUpdated","parameters":[{"description":"The type of event that was triggered","in":"header","name":"x-apideck-event-type","required":true,"schema":{"$ref":"#/components/schemas/CrmEventType"}},{"description":"An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.","in":"header","name":"x-apideck-idempotency-key","required":true,"schema":{"example":"d290f1ee-6c54-4b01-90e6-d701748f0851","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"payload":{"consumer_id":"test_user_id","entity_id":"123456ASDF","entity_type":"contact","entity_url":"https://unify.apideck.com/crm/contacts/123456ASDF","event_id":"d290f1ee-6c54-4b01-90e6-d701748f0851","event_type":"crm.contact.updated","occurred_at":"2025-08-15T13:51:17.602Z","service_id":"hubspot","unified_api":"crm"}},"schema":{"properties":{"payload":{"$ref":"#/components/schemas/CrmWebhookEvent"}},"type":"object"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully."}},"security":[],"summary":"Contact Updated","tags":["Webhook Events"],"x-apideck-event-type":"crm.contact.updated"}},"LeadCreated":{"post":{"description":"Event broadcast when a lead has been created.","operationId":"leadCreated","parameters":[{"description":"The type of event that was triggered","in":"header","name":"x-apideck-event-type","required":true,"schema":{"$ref":"#/components/schemas/CrmEventType"}},{"description":"An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.","in":"header","name":"x-apideck-idempotency-key","required":true,"schema":{"example":"d290f1ee-6c54-4b01-90e6-d701748f0851","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"payload":{"consumer_id":"test_user_id","entity_id":"123456ASDF","entity_type":"lead","entity_url":"https://unify.apideck.com/crm/leads/123456ASDF","event_id":"d290f1ee-6c54-4b01-90e6-d701748f0851","event_type":"crm.lead.created","occurred_at":"2025-08-15T13:51:17.602Z","service_id":"hubspot","unified_api":"crm"}},"schema":{"properties":{"payload":{"$ref":"#/components/schemas/CrmWebhookEvent"}},"type":"object"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully."}},"security":[],"summary":"Lead Created","tags":["Webhook Events"],"x-apideck-event-type":"crm.lead.created"}},"LeadDeleted":{"post":{"description":"Event broadcast when a lead has been deleted.","operationId":"leadDeleted","parameters":[{"description":"The type of event that was triggered","in":"header","name":"x-apideck-event-type","required":true,"schema":{"$ref":"#/components/schemas/CrmEventType"}},{"description":"An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.","in":"header","name":"x-apideck-idempotency-key","required":true,"schema":{"example":"d290f1ee-6c54-4b01-90e6-d701748f0851","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"payload":{"consumer_id":"test_user_id","entity_id":"123456ASDF","entity_type":"lead","entity_url":"https://unify.apideck.com/crm/leads/123456ASDF","event_id":"d290f1ee-6c54-4b01-90e6-d701748f0851","event_type":"crm.lead.deleted","occurred_at":"2025-08-15T13:51:17.602Z","service_id":"hubspot","unified_api":"crm"}},"schema":{"properties":{"payload":{"$ref":"#/components/schemas/CrmWebhookEvent"}},"type":"object"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully."}},"security":[],"summary":"Lead Deleted","tags":["Webhook Events"],"x-apideck-event-type":"crm.lead.deleted"}},"LeadUpdated":{"post":{"description":"Event broadcast when a lead has been updated.","operationId":"leadUpdated","parameters":[{"description":"The type of event that was triggered","in":"header","name":"x-apideck-event-type","required":true,"schema":{"$ref":"#/components/schemas/CrmEventType"}},{"description":"An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.","in":"header","name":"x-apideck-idempotency-key","required":true,"schema":{"example":"d290f1ee-6c54-4b01-90e6-d701748f0851","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"payload":{"consumer_id":"test_user_id","entity_id":"123456ASDF","entity_type":"lead","entity_url":"https://unify.apideck.com/crm/leads/123456ASDF","event_id":"d290f1ee-6c54-4b01-90e6-d701748f0851","event_type":"crm.lead.updated","occurred_at":"2025-08-15T13:51:17.602Z","service_id":"hubspot","unified_api":"crm"}},"schema":{"properties":{"payload":{"$ref":"#/components/schemas/CrmWebhookEvent"}},"type":"object"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully."}},"security":[],"summary":"Lead Updated","tags":["Webhook Events"],"x-apideck-event-type":"crm.lead.updated"}},"NoteCreated":{"post":{"description":"Event broadcast when a note has been created.","operationId":"noteCreated","parameters":[{"description":"The type of event that was triggered","in":"header","name":"x-apideck-event-type","required":true,"schema":{"$ref":"#/components/schemas/CrmEventType"}},{"description":"An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.","in":"header","name":"x-apideck-idempotency-key","required":true,"schema":{"example":"d290f1ee-6c54-4b01-90e6-d701748f0851","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"payload":{"consumer_id":"test_user_id","entity_id":"123456ASDF","entity_type":"note","entity_url":"https://unify.apideck.com/crm/notes/123456ASDF","event_id":"d290f1ee-6c54-4b01-90e6-d701748f0851","event_type":"crm.note.created","occurred_at":"2025-08-15T13:51:17.602Z","service_id":"hubspot","unified_api":"crm"}},"schema":{"properties":{"payload":{"$ref":"#/components/schemas/CrmWebhookEvent"}},"type":"object"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully."}},"security":[],"summary":"Note Created","tags":["Webhook Events"],"x-apideck-event-type":"crm.note.created"}},"NoteDeleted":{"post":{"description":"Event broadcast when a note has been deleted.","operationId":"noteDeleted","parameters":[{"description":"The type of event that was triggered","in":"header","name":"x-apideck-event-type","required":true,"schema":{"$ref":"#/components/schemas/CrmEventType"}},{"description":"An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.","in":"header","name":"x-apideck-idempotency-key","required":true,"schema":{"example":"d290f1ee-6c54-4b01-90e6-d701748f0851","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"payload":{"consumer_id":"test_user_id","entity_id":"123456ASDF","entity_type":"note","entity_url":"https://unify.apideck.com/crm/notes/123456ASDF","event_id":"d290f1ee-6c54-4b01-90e6-d701748f0851","event_type":"crm.note.deleted","occurred_at":"2025-08-15T13:51:17.602Z","service_id":"hubspot","unified_api":"crm"}},"schema":{"properties":{"payload":{"$ref":"#/components/schemas/CrmWebhookEvent"}},"type":"object"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully."}},"security":[],"summary":"Note Deleted","tags":["Webhook Events"],"x-apideck-event-type":"crm.note.deleted"}},"NoteUpdated":{"post":{"description":"Event broadcast when a note has been updated.","operationId":"noteUpdated","parameters":[{"description":"The type of event that was triggered","in":"header","name":"x-apideck-event-type","required":true,"schema":{"$ref":"#/components/schemas/CrmEventType"}},{"description":"An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.","in":"header","name":"x-apideck-idempotency-key","required":true,"schema":{"example":"d290f1ee-6c54-4b01-90e6-d701748f0851","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"payload":{"consumer_id":"test_user_id","entity_id":"123456ASDF","entity_type":"note","entity_url":"https://unify.apideck.com/crm/notes/123456ASDF","event_id":"d290f1ee-6c54-4b01-90e6-d701748f0851","event_type":"crm.note.updated","occurred_at":"2025-08-15T13:51:17.602Z","service_id":"hubspot","unified_api":"crm"}},"schema":{"properties":{"payload":{"$ref":"#/components/schemas/CrmWebhookEvent"}},"type":"object"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully."}},"security":[],"summary":"Note Updated","tags":["Webhook Events"],"x-apideck-event-type":"crm.note.updated"}},"OpportunityCreated":{"post":{"description":"Event broadcast when an opportunity has been created.","operationId":"opportunityCreated","parameters":[{"description":"The type of event that was triggered","in":"header","name":"x-apideck-event-type","required":true,"schema":{"$ref":"#/components/schemas/CrmEventType"}},{"description":"An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.","in":"header","name":"x-apideck-idempotency-key","required":true,"schema":{"example":"d290f1ee-6c54-4b01-90e6-d701748f0851","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"payload":{"consumer_id":"test_user_id","entity_id":"123456ASDF","entity_type":"opportunity","entity_url":"https://unify.apideck.com/crm/opportunities/123456ASDF","event_id":"d290f1ee-6c54-4b01-90e6-d701748f0851","event_type":"crm.opportunity.created","occurred_at":"2025-08-15T13:51:17.602Z","service_id":"hubspot","unified_api":"crm"}},"schema":{"properties":{"payload":{"$ref":"#/components/schemas/CrmWebhookEvent"}},"type":"object"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully."}},"security":[],"summary":"Opportunity Created","tags":["Webhook Events"],"x-apideck-event-type":"crm.opportunity.created"}},"OpportunityDeleted":{"post":{"description":"Event broadcast when an opportunity has been deleted.","operationId":"opportunityDeleted","parameters":[{"description":"The type of event that was triggered","in":"header","name":"x-apideck-event-type","required":true,"schema":{"$ref":"#/components/schemas/CrmEventType"}},{"description":"An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.","in":"header","name":"x-apideck-idempotency-key","required":true,"schema":{"example":"d290f1ee-6c54-4b01-90e6-d701748f0851","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"payload":{"consumer_id":"test_user_id","entity_id":"123456ASDF","entity_type":"opportunity","entity_url":"https://unify.apideck.com/crm/opportunities/123456ASDF","event_id":"d290f1ee-6c54-4b01-90e6-d701748f0851","event_type":"crm.opportunity.deleted","occurred_at":"2025-08-15T13:51:17.602Z","service_id":"hubspot","unified_api":"crm"}},"schema":{"properties":{"payload":{"$ref":"#/components/schemas/CrmWebhookEvent"}},"type":"object"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully."}},"security":[],"summary":"Opportunity Deleted","tags":["Webhook Events"],"x-apideck-event-type":"crm.opportunity.deleted"}},"OpportunityUpdated":{"post":{"description":"Event broadcast when an opportunity has been updated.","operationId":"opportunityUpdated","parameters":[{"description":"The type of event that was triggered","in":"header","name":"x-apideck-event-type","required":true,"schema":{"$ref":"#/components/schemas/CrmEventType"}},{"description":"An idempotency key is a unique value generated to recognize subsequent retries/duplicates of the same request.","in":"header","name":"x-apideck-idempotency-key","required":true,"schema":{"example":"d290f1ee-6c54-4b01-90e6-d701748f0851","format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"example":{"payload":{"consumer_id":"test_user_id","entity_id":"123456ASDF","entity_type":"opportunity","entity_url":"https://unify.apideck.com/crm/opportunities/123456ASDF","event_id":"d290f1ee-6c54-4b01-90e6-d701748f0851","event_type":"crm.opportunity.updated","occurred_at":"2025-08-15T13:51:17.602Z","service_id":"hubspot","unified_api":"crm"}},"schema":{"properties":{"payload":{"$ref":"#/components/schemas/CrmWebhookEvent"}},"type":"object"}}}},"responses":{"200":{"description":"Return a 200 status to indicate that the data was received successfully."}},"security":[],"summary":"Opportunity Updated","tags":["Webhook Events"],"x-apideck-event-type":"crm.opportunity.updated"}},"x-sdk-exclude":true}}