v9.6.0 - (2023-05-25)
HRIS API
- Add the
probation_period
field on the Employee resource.
v9.5.0 - (2023-05-15)
Accounting API
- Added new connectors for Kashflow and Clearbooks
- Updated Exact Online connector
HRIS API
- Added Employee Terminated event.
v9.4.0 - (2023-05-09)
ATS API
- Added Create Applicant and added Delete Applicant
v9.3.1 - (2023-05-07)
ATS API
- Added
job_id
filter to Teamtailor.
v9.3.0 - (2023-04-18)
Vault API
- Added new
invalid
state and newvalidation_support
field on Connections to support connection validation. - Added
prefix
andsuffix
toform_fields
on Connections
v9.2.0 - (2023-04-17)
HRIS API
- Deprecate the
department
field in favor of the dedicateddepartment_id
anddepartment_name
field on the Employee resource.
v9.1.5 - (2023-04-17)
HRIS API
- Improved Sage-HR mapping
Unify
- Updated Unify specs by referencing the PassThrough query parameter required for the Unify SDKs
v9.1.4 - (2023-04-14)
Accounting API
- added optional
payment_method_id
to Payments resource. - added
taxable
to InvoiceItems resource.
v9.1.3 - (2023-04-13)
- Unify shared field representing
currency
enum extended to includeETH
v9.1.2 - (2023-03-24)
Accounting API
- pass_through parameter is now available on all list endpoints.
- added
terms
to Credit Notes resource. - added
rate
to Tax Rates resource.
v9.1.1 - (2023-03-13)
Accounting API
- Added
discount_amount
to Invoices resource and it's Line Items.
v9.1.0 - (2023-02-28)
- Added
List Tags
endpoint to Issue Tracking API.
v9.0.0 - (2023-02-24)
Connector API
- Removed
resource
property insupported_events
of a Connector. - Added
resources
andentity_type
property insupported_events
of a Connector.
v8.93.0 - (2023-02-23)
Issue Tracking API
Added the Issue Tracking API.
Resources
Webhooks
Connectors
v8.92.0 - (2023-02-22)
File Storage API
- Added Rename or move File.
v8.91.1 - (2023-02-22)
Ecommerce API
- Product
inventory
property is now a string instead of number.
Connectors
v8.91.0 - (2023-02-15)
- Added
parent
andproject
fields to the Customer schema on Accounting.
v8.90.0 - (2023-02-15)
Ecommerce API
Added the Ecommerce API.
Resources
Connectors
v8.89.0 - (2023-02-07)
Accounting API
- Added the Journal Entries resource.
v8.88.0 - (2023-02-07)
CRM API
v8.87.0 - (2023-01-24)
CRM API
- Added
filter[updated_since]
to Activities
v8.86.0 - (2023-01-11)
Vault API
- Added Create Consumer
- Added Update Consumer
- Added Delete Consumer
v8.85.1 - (2022-12-19)
Webhooks API
- Added
disabled_reason
to Webhook to reflect when a webhook has been automatically disabled.
v8.85.0 - (2022-11-15)
Connector API
- Added
free_trial_available
,signup_url
andwebhook_support
to Connector
CRM API
- Added
company_id
filter to Opportunities
v8.84.0 - (2022-11-12)
ATS API
- Added Jobs and Applicants resource to SAP SuccessFactors.
- Added
created_by
andupdated_by
fields to the Applicant schema.
v8.83.0 - (2022-11-10)
- Added Mollie and monday.com auth-only connector
v8.82.0 - (2022-11-09)
- Added Calendly and Google Contacts auth-only connector
v8.81.0 - (2022-11-09)
HRIS API
- Added Time Off Requests resource to ADP Workforce Now.
- Added Time Off Requests resource to BambooHR.
- Added Time Off Requests resource to Personio.
- Added Time Off Requests resource to Sage Hr.
- Added Time Off Requests resource to SAP SuccessFactors.
- Added Time Off Requests resource to Workday.
ATS API
- Added
job_id
filter to Recruitee.
v8.80.0 - (2022-11-07)
ATS API
- Added
jobs
resource to Greenhouse.
v8.79.0 - (2022-11-07)
Procurement API
- Added Portt auth-only connector
Expense management API
- Moved the Web Expenses auth-only settings to connection level
Connector API
- Added
custom_scopes
to Connector
v8.78.0 - (2022-11-07)
- Added webhooksResolve operation to the Webhooks API to provide a shorter route.
v8.77.0 - (2022-11-03)
- Updated Orders Clover on POS with additional modifier fields on line items.
v8.76.0 - (2022-10-31)
- Added Connection Hooks
- Added support cor Connection based Webhooks
- Added Connection webhook support FactorialHR
Vault API
- Added subscriptions prop to Connections
v8.75.0 - (2022-10-28)
ACCOUNTING API
- Added
credit-notes
resource to Sage Intacct. - Added create, update and delete operations to payments resource in Sage Intacct.
- Added workflows to separate between receivable payments and payable payments in Sage Intacct.
- Expanded
invoices
resource mapping in Sage Intacct. - Expanded fields to
Bill
,BillLineItem
,CreditNote
,InvoiceLineItem
andPayment
schemas. - Updated workflow client to support
unified_metadata
.
v8.74.0 - (2022-10-27)
Connector API
- Added
downstream_unsupported_operations
to ConnectorResource -
Added
unified_apis[].downstream_unsupported_resources
to Connector
v8.73.0 - (2022-10-27)
- Added Google Calendar auth-only connector
- Added Microsoft Outlook Calendar auth-only connector
v8.72.1 - (2022-10-24)
Accounting API
- Updated Ledger accounts, invoice items, payments, suppliers to use [QuickBooks] SyncToken
v8.72.0 - (2022-10-18)
Accounting API
- Added
bill
, resource for Sage Intacct. - Improved array mappings for xml cases.
- Added new fields to the Bill schema.
v8.71.0 - (2022-10-17)
Connector API
- Added
unified_apis[].name
andunified_apis[].supported_resources
to Connector - Added
?unified_api
parameter to ConnectorResource
v8.70.2 - (2022-10-14)
Vault API
- Add
show_sidebar
to settings on create session.
v8.70.1 - (2022-10-13)
Accounting API
- Added
discount_percentage
to root of Invoice object. Quickbooks has limited support for LineItem discounts, so this is a workaround to support discounts on invoices.
v8.70.0 - (2022-10-11)
HRIS API
- Reworked Workday auth + mapping to use SOAP API
Expense management API
- Added Web Expenses auth-only connector
v8.69.0 - (2022-10-07)
HRIS API
- Added Ceridian Dayforce connector
v8.68.0 - (2022-10-06)
- Added
create
,update
anddelete
operations tocredit-notes
resource for [QuickBooks].
v8.67.1 - (2022-09-30)
Connector API
- extended connector API to return nested filed level coverage
v8.67.0 - (2022-09-29)
Accounting API
- Added
display_id
,created_by
andupdated_by
fields to the Payment schema.
v8.66.0 - (2022-09-28)
- Added filter support for employees in Loket connector.
- Added support to filter employees by employee number.
- Added Lucca HR connector
v8.65.0 - (2022-09-28)
HRIS API
- Added SDWorx as an auth-only connector.
v8.64.0 - (2022-09-28)
Accounting API
- Added NetSuite as an auth-only connector.
v8.63.0 - (2022-09-27)
- Added the Project Management API for auth-only connectors.
- Added JIRA as an auth-only connector.
v8.62.0 - (2022-09-27)
HRIS API
- Added Jobs support for Officient.
v8.61.0 - (2022-09-26)
HRIS API
- Added filter support for employees in ADP Workforce Now connector.
v8.60.0 - (2022-09-23)
HRIS API
- Added Time Off Requests resource.
v8.59.0 - (2022-09-22)
Team Messaging API
- Added Microsoft Teams connector
v8.58.0 - (2022-09-19)
Connector API
- Added
blind_mapping
to Connector
v8.57.0 - (2022-09-13)
HRIS API
- Added PayFit connector
v8.56.0 - (2022-09-12)
HRIS API
- Added Okta connector
v8.55.0 - (2022-09-12)
HRIS API
- Added Alexis HR connector
v8.54.0 - (2022-09-12)
HRIS API
- Added Microsoft Dynamics HR connector
v8.53.0 - (2022-09-09)
HRIS API
- Added Namely connector.
v8.52.1 - (2022-09-09)
- Generalize example detail for Unprocessable Entity Error to prevent confusing when using the Mock API.
v8.52.0 - (2022-09-07)
- Added Paylocity connector
v8.51.0 - (2022-09-06)
- Expanded support for
Employees
for the UKG Pro connector
v8.50.0 - (2022-09-06)
- Added Zoho People connector
v8.49.0 - (2022-09-05)
ACTION REQUIRED
Beta users should note the following breaking changes that may affect existing integrations implementing the POS
API:
- The schema description for a
bank_account
on thePayments
object has been defined asPosBankAccount
to avoid confusion with theBankAccount
object in other APIs. - This change is backwards compatible, but we recommend updating your integrations to use the new name if you are using typed definitions.
- Note: the properties on the
PosBankAccount
object have not changed. PosPayments
v8.48.0 - (2022-09-05)
- Added UKG Pro connector
v8.47.0 - (2022-09-05)
- Added ADP Workforce Now connector
- extended gender enum to include
not-specified
- Added
tls_support
to Connector
v8.46.0 - (2022-09-02)
HRIS API
- Added Zenefits connector
v8.45.0 - (2022-09-02)
HRIS API
- Added Factorial connector.
v8.44.0 - (2022-09-01)
HRIS API
- Added Sapling connector
v8.43.0 - (2022-08-30)
HRIS API
- Added Freshteam connector
v8.42.0 - (2022-08-24)
Accounting API
- Added sorting support to Invoices. To sort results, use the
sort[by]
andsort[direction]
query parameters. First availablesort[by]
value isupdated_at
. Supported for Xero and Quickbooks.
v8.41.1 - (2022-08-24)
Accounting API
- Make
invoice_date
anddue_date
nullable on Invoices
v8.41.0 - (2022-08-17)
Accounting API
- Added Credit Note support.
- Added Credit Notes support for Xero.
- Added Credit Notes readOnly support for Quickbooks.
v8.40.1 - (2022-08-16)
Accounting API
- Added
filter[start_date]
,filter[end_date]
to Customers
v8.40.0 - (2022-08-15)
- Added Mock API and SDKs to documentation for all APIs.
v8.39.1 - (2022-08-10)
Accounting API
- Added Bills
v8.39.0 - (2022-08-09)
Connector API
- Added
supported_list_fields
to ConnectorResource
v8.38.0 - (2022-08-03)
- Added Drives resource on the File Storage API.
- Added Drive Groups resource on the File Storage API.
v8.37.1 - (2022-07-25)
v8.37.0 - (2022-07-20)
- Added
modifier_groups
property to Items on the POS API.
v8.36.0 - (2022-07-20)
- Added
status
property to Company info on the Accounting API and for the MYOB connector.
v8.35.1 - (2022-07-20)
- Added docs for QuickBooks as supported connector for Profit And Loss resource on the Accounting API.
v8.35.0 - (2022-07-20)
- Added Profit And Loss resource on the Accounting API.
v8.34.0 - (2022-07-06)
- Added Jobs on the HRIS API
v8.33.0 - (2022-07-02)
- Added
deceased_on
andpartner
to Employee on the HRIS API. - Added new resource EmployeeSchedules on the HRIS API.
v8.32.6 - (2022-06-24)
- Fix faulty examples
v8.32.5 - (2022-06-21)
- Updated Orders and Payments for the Clover connector
v8.32.4 - (2022-06-16)
- Added
filter[first_name]
andfilter[display_name
] to to Customers - Added
automated_sales_tax
to CompanyInfo
v8.32.3 - (2022-06-15)
- Added
country
,sales_tax_enabled
anddefault_sales_tax
to CompanyInfo
v8.32.2 - (2022-06-15)
Accounting API
- Added
filter[company_name]
,filter[last_name]
,filter[email]
to Customers
v8.32.1 - (2022-06-08)
ATS API
- Extended
department
properties on Jobs
v8.32.0 - (2022-06-03)
HRIS API
- Added Humaans
v8.31.3 - (2022-06-02)
Accounting API
- Added filter[name] to InvoiceItems
v8.31.2 - (2022-06-01)
- Added
row_type
Companies
v8.31.1 - (2022-05-31)
- Added
ConnectorOperationUnsupportedError
to provide detail when a Unify call is made that the downstream connector does not support.
Accounting API
ACTION REQUIRED
Beta users should note the following breaking changes that may affect existing integrations implementing the Accounting
API:
- LedgerAccount
nominal_code
has been deprecated in favour ofcode
.
v8.31.0 - (2022-05-26)
CRM API
- Added
pipelines
Pipelines for Salesforce
v8.30.1 - (2022-05-24)
Accounting API
- Added
bank_accounts
Suppliers
v8.30.0 - (2022-05-23)
ATS API
v8.29.5 - (2022-05-19)
Accounting API
- Added Balance Sheet
v8.29.4 - (2022-05-16)
- Made
is_primary
optional for Employee jobs of HRIS API.
v8.29.3 - (2022-05-10)
- Extended Bills with
paid_date
,deposit
,sub_total
, andtotal_tax
. If these properties are available in downstream connector response, they will be mapped returned.
v8.29.2 - (2022-05-10)
- Added optional
inventory_date
to InvoiceItem
v8.29.1 - (2022-05-06)
Accounting API
- Added Bills
v8.29.0 - (2022-05-05)
Accounting API
- Added Suppliers
v8.28.2 - (2022-05-05)
Accounting API
- Added optional
tax_code
to Invoice
v8.28.1 - (2022-05-03)
POS API
- Added Square Locations
v8.28.0 - (2022-05-03)
HRIS API
- Added Personio connector to HRIS
v8.27.2 - (2022-04-29)
HRIS API
- Added Webhook Support
v8.27.1 - (2022-04-27)
Vault API
- Added docs for
authorize_url
andrevoke_url
to Connections
v8.27.0 - (2022-04-27)
- Added
ConnectorRateLimitError
v8.26.1 - (2022-04-26)
Vault API
- Include connectionsImport when running sdk generation.
v8.26.0 - (2022-04-25)
HRIS API
- Added Payrolls and EmployeePayrollsto HRIS
v8.25.0 - (2022-04-22)
ATS API
- Added Workable connector to ATS
v8.24.1 - (2022-04-21)
Accounting API
- Updated TaxRates components.id to be
string
v8.24.0 - (2022-04-20)
- Add Company info to QuickBooks connector
v8.23.0 - (2022-04-19)
v8.22.0 - (2022-04-17)
- Added
Order Types
andModifier Groups
to Clover connector
v8.21.0 - (2022-04-14)
- Added
Orders
to Clover connector
v8.20.0 - (2022-04-12)
Connector API
- Added
oauth_scopes
to Connector
v8.19.3 - (2022-04-11)
Vault API
- Added TokenRefreshFailed to Vault spec to include in docs
v8.19.2 - (2022-04-08)
- Bump version to initialize PHP SDK
v8.19.1 - (2022-04-08)
- Removed
minLength: 1
limitation because responses can contain empty strings. - Set default value of
raw
parameter tofalse
, it wastrue
.
v8.19.0 - (2022-04-04)
Vault API
- Added Import Connection
v8.18.0 - (2022-04-04)
Connector API
v8.17.0 - (2022-03-24)
Connector API
- Added
oauth_grant_type
,oauth_credentials_source
andhas_sandbox_credentials
to Connector
v8.16.0 - (2022-03-24)
HRIS API
- Added Departments to HRIS
- Fixed Nmbrs birthday date format on Employees
v8.15.0 - (2022-03-23)
- Added Greenhouse connector to ATS
- Added Merchant ID to Clover connector
v8.14.0 - (2022-03-18)
Accounting API
- Added Sage Intacct connector
- LedgerAccounts
LedgerAccount.type
enum extended to includebalancesheet
- Added
categories
property
- AccountingCustomer
AccountingCustomer.status
enum extended to includeinactive
- Payment
Payment
extended with optionalpayment_method
string
Vault API
- Extended Connections
auth_type
enum to includecustom
.
v8.13.0 - (2022-03-09)
- Added
Items
andOrders
POS mapping to Square
v8.12.1 - (2022-02-18)
Accounting API
- Added
taxRatesFilter
filter to TaxRates
v8.12.0 - (2022-02-16)
Vault API
- Added
oauth_grant_type
property to Connections. - Added Token endpoint to support the
client_credentials
OAuth flow.
HRIS API
v8.11.1 - (2022-02-09)
Accounting API
- optional
report_tax_type
property added to TaxRates
v8.11.0 - (2022-01-15)
POS API
- Added Square connector.
v8.10.2 - (2022-01-12)
HRIS API
- Moved compensations out of jobs array on Employees
v8.10.1 - (2021-12-14)
Accounting API
-
Shared Schema
Address
extended with optionalline3
andline4
properties -
LedgerAccount.type
enum extended to includeother_income
-
AccountingCustomer
extended withwebsites
,title
,display_name
,middle_name
,last_name
, andsuffix
properties
-
Invoice
extended with optionalterms
string
-
Payment
extended with optionalnote
string
v8.10.0 - (2021-12-05)
File Storage API
- Added Upload Sessions resource.
- Added File Upload to the Google Drive connector.
HRIS API
- Added BambooHR connector.
v8.9.0 - (2021-12-03)
ATS API
- Added Lever connector.
v8.8.1 - (2021-11-24)
Accounting API
- Payments
Payment.reconciled
added to reflect reconciliation statePayment.status
enum added to reflect payment state [authorised
,paid
,voided
,deleted
]Payment.type
enum added [accounts_receivable
,accounts_payable
,accounts_receivable_credit
,accounts_payable_credit
,accounts_receivable_overpayment
,accounts_payable_overpayment
,accounts_receivable_prepayment
,accounts_payable_prepayment
]
ACTION REQUIRED
Accounting APIBeta users should note the following breaking changes that may affect existing integrations implementing the Accounting
API:
- Payments
accounts_receivable_account_type
andaccounts_receivable_account_id
have been deprecated in favour of a singleaccount
object.
v8.8.0 - (2021-11-18)
File Storage API
- Added Shared Links resource.
v8.7.1 - (2021-11-16)
Accounting API
-
added
BankAccount.account_type
andBankAccount.currency
. Account type is an enum [bank_account
,credit_card
,other
] -
LedgerAccount.type
enum extended to includefixed_asset
andrevenue
LedgerAccount.status
added to reflect downstream provider who allow different states (soft delete) [active
,inactive
,archived
]
-
InvoiceItem.purchase_details
added to reflect purchase cost detail on an itemInvoiceItem.tracked
added to indicate whether or not the item is tracked via inventoryInvoiceItem.asset_account
added to reflect the asset account that this item should be related to.InvoiceItem.purchased
boolean added to indicate whether or not the item is available for purchase transactions
v8.7.0 - (2021-11-15)
File Storage API
- Added File Upload.
v8.6.0 - (2021-11-11)
ACTION REQUIRED
Accounting APIBeta users should note the following breaking changes that may affect existing integrations implementing the Accounting
API:
- Type of TaxRates
tax_type
has been deprecated to facilitate migrating from an enum to string using newTaxRate.type
. Values sent viaTaxRate.type
should be aligned with any downstream connector requirements.
v8.5.0 - (2021-11-09)
File Storage API
- Added Folders resource.
v8.4.1 - (2021-11-08)
File Storage API
- Added sorting support to Files. To sort results, use the
sort[by]
andsort[direction]
query parameters. Availablesort[by]
values arename
andupdated_at
.
v8.4.0 - (2021-11-04)
- Added Connector API.
v8.3.2 - (2021-11-03)
Accounting API
- Extend InvoiceItems to include
income_account
andexpense_account
.
v8.3.1 - (2021-11-02)
Accounting API
- Ensure Customer is shared model between Invoice and Payment
v8.3.0 - (2021-11-02)
Accounting API
- Added Payments
- Added
downstream_id
to Invoices allowing for single endpoint fanning out to multiple downstream endpoints for Invoices.
v8.2.0 - (2021-11-01)
SMS API
- Added MessageBird and Vonage messages.
v8.1.0 - (2021-10-26)
SMS API
v8.0.0 - (2021-10-25)
- Added SMS API.
v7.2.0 - (2021-10-23)
CRM API
- Added users support for the Salesforce connector.
v7.1.0 - (2021-10-22)
Webhook API
- Rename
url
todelivery_url
.
v7.0.0 - (2021-10-19)
Customer Support API
- Added the Kustomer connector to the Customer Support API.
CRM & Lead API
- Added the Flexmail connector to the CRM API.
v6.0.0 - (2021-10-14)
Webhook API
- Added beta version of the Webhook API.
v5.12.1 - (2021-10-13)
Vault API
- Connection.form_fields is readOnly. The values should be sent via Connection.settings when mutating a connection.
v5.12.0 - (2021-09-16)
- Extended phone number resource with
country_code
,area_code
, and newdirect-dial-in
type
Accounting API
- Mapped Xero customers
File Storage API
v5.11.0 - (2021-09-15)
File Storage API
- Added
/file-storage/files/search
endpoint. - Added the Sharepoint and OneDrive connectors
v5.10.0 - (2021-09-13)
File Storage API
- Renamed
folderId
filter tofolder_id
- Add
shared
filter to the Files resource
v5.9.1 - (2021-09-08)
File Storage API
- Added filter on
folderId
to the Files resource.
v5.8.1 - (2021-09-08)
Proxy API
- Added support for responses larger than 6MB. For more information, see the Proxy API docs.
v5.8.0 - (2021-09-08)
File Storage API
- Added beta version of the File Storage API and the Google Drive connector.
v5.7.0 - (2021-09-06)
- Add Company info resource. Replace Contact and Company resource by Customer resource.
v5.6.0 - (2021-09-06)
Accounting API
- Add Customers resource.
v5.5.1 - (2021-08-29)
Accounting API
- Rename
general_ledger_account
toledger_account
read-only on Invoices.
v5.4.1 - (2021-08-27)
Accounting, CRM, Lead & Vault API
- normlized the naming of definitions
- fixed response descriptions to match shared definitions and avoid duplicates
v5.4.0 - (2021-08-25)
CRM API
- Make
duration_minutes
read-only on Activities.
v5.3.0 - (2021-08-19)
Vault API
- Add
custom_consumer_settings
to create session. Allow wildcard objects to be passed through themetadata
field on a connection.
v5.2.0 - (2021-08-15)
CRM API
- Add
contact_id
,company_id
,opportunity_id
,lead_id
, andactive
to Notes.
v5.1.0 - (2021-08-13)
Accounting API
- Added alpha version of the Accounting API and the MYOB connector.
Supported resources:
- Ledger Accounts
- Tax Rates
- Invoices
- Contacts
- Companies
v5.0.1 - (2021-08-11)
CRM, Lead & Vault API
- For all error responses,
typeName
was renamed totype_name
for consistency.
v5.0.0 - (2021-08-01)
CRM & Lead API
expected_revenue
,type
,last_activity_at
,lead_source
, andstage_last_changed_at
added to Opportunity resourceannual_revenue
,number_of_employees
,industry
,last_activity_at
,ownership
, andparent_id
added to Company resource- Renamed
image_url
toimage
on the Company resource - Remove
tax
on the Company resource, since it's already present inphone_numbers
image
,last_activity_at
,first_email_at
, andfirst_call_at
added to Contact resource
v4.3.3 - (2021-07-29)
Vault API
vault/callback
: Addedcode
parameter
v4.3.2 - (2021-07-23)
Vault API
- Connection.json#updated_at is nullable
vault/logs
filter for exclude_unified_apis has been refactored to be comma separated string
v4.3.1 - (2021-07-15)
Vault API
- Added ability to filter log results in vault.
v4.3.0 - (2021-07-14)
Vault API
- New
/vault/logs
endpoint released to enable fetching paginated list of request logs scoped to application and consumer.
v4.2.0 - (2021-07-07)
Vault API
- Added a
services
array to list all active services when listing all consumers.
v4.1.1 - (2021-07-05)
CRM API & Lead API & Vault API
- extend examples for fields that allow
anyOf
(in this case errors that allow strings or objects)
v4.1.0 - (2021-07-02)
CRM API
- Added sorting support to Leads, Companies and Opportunities. To sort results, use the
sort[by]
andsort[direction]
query parameters.- Leads: available
sort[by]
values arename
,first_name
,last_name
,email
,created_at
andupdated_at
. - Companies: available
sort[by]
values arename
,created_at
andupdated_at
. - Opportunities: available
sort[by]
values aretitle
,status
,monetary_amount
,win_probability
,created_at
andupdated_at
.
- Leads: available
v4.0.0 - (2021-07-01)
CRM API
- Added
note
andtask
as allowed values fortype
on the activity resource activity_datetime
andduration_seconds
are no longer required on the activity resource
ACTION REQUIRED
CRM APIBeta users should note the following breaking changes that may affect existing integrations implementing the CRM
API:
- On the activity resource, following fields were removed:
recurrence_activity_id
recurrence_start_datetime
recurrence_end_date
recurrence_timezone
recurrence_interval
recurrence_day_of_week_mask
recurrence_day_of_month
recurrence_instance
recurrence_month_of_year
recurrence_end_date_only
recurrence_type
v3.0.3 - (2021-07-01)
CRM API & Lead API & Vault API
detail
property on all errors can be a string or and object
v3.0.2 - (2021-06-29)
CRM API & Lead API & Vault API
- all required fields are validated with
minLength: 1
v3.0.1 - (2021-06-28)
CRM API & Lead API
lead_source
andlanguage
added to Lead resourceaccount_id
andduration_in_minutes
added to Activity resource
v3.0.0 - (2021-06-18)
ACTION REQUIRED
Vault APIBeta users should note the following breaking changes that may affect existing integrations implementing the Vault
API:
- Moved
api_key
field from the root in the request body to the settings object when creating/updating connections.
v2.4.0 - (2021-06-08)
CRM API
- Added sorting support to Contacts. To sort Contacts, use the
sort[by]
andsort[direction]
query parameters. Availablesort[by]
values arename
,first_name
,last_name
,email
,created_at
andupdated_at
.
v2.3.0 - (2021-06-07)
CRM API & Lead API
- Remove connectors table
v2.2.0 - (2021-06-07)
Proxy API
- Documented
static IP
andlimitations
v2.1.0 - (2021-05-31)
Vault API
- Undocumented
connectionsAdd
added - Normalized reponses for
connectionsGetSettings
andconnectionsUpdateSettings
v2.0.0 - (2021-05-28)
Vault/Proxy API
- Deprecated /vault/proxy and moved to the Proxy API
v1.10.0 - (2021-05-28)
CRM API
- Added filter query parameter for opportunity
v1.9.0 - (2021-05-26)
CRM API
- Added filter query parameter for lead
v1.8.0 - (2021-05-24)
CRM API
- Added Activities resource
v1.7.0 - (2021-05-21)
CRM API
- Added Users resource
v1.6.0 - (2021-05-20)
CRM API
- Added Notes resource
v1.5.0 - (2021-05-19)
- Configuration options per resource extended to fetch dynamic options when configuring settings.
Vault API
- Added
filter-type
toFormField.type
that allows configuration options to be filtered by the value of a separate setting. FormFieldOptionGroup
schema added to define grouping of options within a FormField
v1.4.0 - (2021-05-18)
Added configuration options per resource.
1.4.0Vault API
- Renamed
schema_support
toresource_schema_support
and introducedresource_settings_support
to the connection settings endpoint - Add
configurable_resources
to the connections endpoint
v1.3.0 - (2021-05-13)
Apideck APIs now use a single semver version for clarity.
1.3.0CRM API & Lead API
SpecRequestValidationError
was replaced by 2 more helpful errors.RequestBodyValidationError
andRequestParametersValidationError
are more readable, informative and provide suggestions.
v1.2.0 - (2021-05-12)
New consumer endpoints added to the Vault API providing a list and aggregate data on the type of requests consumers are making.
Vault 1.2.0/vault/consumers
added to provide paginated list of consumers scoped to application/vault/consumers/{consumer_id}
added to provide consumer detail includingaggregated_request_count
and request counts across the Unified APIs./vault/consumers/{consumer_id}/stats
added to provide request count aggregation data within a datetime range.
v1.1.1 - (2021-05-10)
Initial spec of new Vault Consumers API drafted for upcoming release.
Vault 1.1.1v1.1.0 - (2021-04-23)
We switched to a dynamic way of using filters instead of fixed query parameters.
ACTION REQUIRED
CRM 1.1.0Beta users should note the following breaking changes that may affect existing integrations implementing the CRM
API:
-
Filtering on contacts has now a dedicated
filter
query parameter instead of seperated query parameters per field -
Filtering on opportunities has now a dedicated
filter
query parameter instead of seperated query parameters per field
v1.0.0 - (2021-04-21)
Moving towards widespread public release, we're updating our specs to version 1.0.0
across the board. This acts as a starting point to officially implement semantic versioning
across all of our specs.
From here on in, we'll be tracking, documenting and broadcasting implemented or upcoming API changes within this document.
ACTION REQUIRED
CRM 1.0.0 Lead 1.0.0Beta users should note the following breaking changes that may affect existing integrations implementing either Lead
or CRM
API:
-
Address.type
enum updated to["primary", "secondary", "home", "office", "shipping", "billing", "other"]
-
Website.category
has been renamed toWebsite.type
and is now anenum
. Now accepts:["primary", "secondary", "work", "personal", "other"]
-
Email.type
migrated from string toenum
. Now accepts:["primary", "secondary", "work", "personal", "billing", "other"]
-
PhoneNumber.phone_type
changed toPhoneNumber.type
andenum
now accepts:["primary", "secondary", "home", "office", "mobile", "assistant", "fax", "other"]
.
Note: All enums that previously accepted
default
now expectprimary
!