curl --request PUT \
--url https://api.rootfi.dev/v3/core/invite_links/{invite_link_id} \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"company_name": "RootFi",
"integrations": [
"XERO"
],
"integration_categories": [
"ACCOUNTING"
],
"sync_config": [
{
"data_model": "ACCOUNTS",
"category": "ACCOUNTING",
"enabled": true,
"frequency": "DAILY",
"interval": 1,
"scope_access": {
"READ": true,
"CREATE": true,
"UPDATE": true,
"DELETE": true
},
"sync_from": "2023-01-01T00:00:00Z"
}
]
}
'{
"data": {
"rootfi_id": 1,
"rootfi_created_at": "2021-08-10T12:00:00Z",
"rootfi_updated_at": "2021-08-10T12:00:00Z",
"invite_link_id": "1",
"integrations": [
"XERO"
],
"integration_categories": [
"ACCOUNTING"
],
"company": {
"rootfi_id": 1,
"rootfi_created_at": "2021-08-10T12:00:00Z",
"rootfi_updated_at": "2021-08-10T12:00:00Z",
"name": "RootFi"
},
"connections": [
{
"rootfi_id": 1,
"rootfi_created_at": "2021-08-10T12:00:00Z",
"rootfi_updated_at": "2021-08-10T12:00:00Z",
"integration_type": "XERO",
"status": "HEALTHY",
"sync_status": "IDLE",
"rate_limits": {
"counters": {
"day": 4,
"hour": 1,
"minute": 1,
"concurrent": 0
},
"lastReset": {
"day": "2024-01-28T11:00:17.087Z",
"hour": "2024-01-29T05:10:40.896Z",
"minute": "2024-01-29T05:10:40.896Z"
},
"maxLimits": {
"per_minute": 500,
"concurrent_calls": 10
}
},
"sync_config": [
{
"data_model": "ACCOUNTS",
"enabled": true,
"frequency": "DAILY",
"interval": 1,
"scope_access": {
"READ": true,
"CREATE": true,
"UPDATE": true,
"DELETE": true
},
"category": "ACCOUNTING",
"sync_from": "2023-01-01T00:00:00Z"
}
],
"category": "ACCOUNTING"
}
]
}
}Update Invite Link
Update a single invite link from the database.
curl --request PUT \
--url https://api.rootfi.dev/v3/core/invite_links/{invite_link_id} \
--header 'Content-Type: application/json' \
--header 'api_key: <api-key>' \
--data '
{
"company_name": "RootFi",
"integrations": [
"XERO"
],
"integration_categories": [
"ACCOUNTING"
],
"sync_config": [
{
"data_model": "ACCOUNTS",
"category": "ACCOUNTING",
"enabled": true,
"frequency": "DAILY",
"interval": 1,
"scope_access": {
"READ": true,
"CREATE": true,
"UPDATE": true,
"DELETE": true
},
"sync_from": "2023-01-01T00:00:00Z"
}
]
}
'{
"data": {
"rootfi_id": 1,
"rootfi_created_at": "2021-08-10T12:00:00Z",
"rootfi_updated_at": "2021-08-10T12:00:00Z",
"invite_link_id": "1",
"integrations": [
"XERO"
],
"integration_categories": [
"ACCOUNTING"
],
"company": {
"rootfi_id": 1,
"rootfi_created_at": "2021-08-10T12:00:00Z",
"rootfi_updated_at": "2021-08-10T12:00:00Z",
"name": "RootFi"
},
"connections": [
{
"rootfi_id": 1,
"rootfi_created_at": "2021-08-10T12:00:00Z",
"rootfi_updated_at": "2021-08-10T12:00:00Z",
"integration_type": "XERO",
"status": "HEALTHY",
"sync_status": "IDLE",
"rate_limits": {
"counters": {
"day": 4,
"hour": 1,
"minute": 1,
"concurrent": 0
},
"lastReset": {
"day": "2024-01-28T11:00:17.087Z",
"hour": "2024-01-29T05:10:40.896Z",
"minute": "2024-01-29T05:10:40.896Z"
},
"maxLimits": {
"per_minute": 500,
"concurrent_calls": 10
}
},
"sync_config": [
{
"data_model": "ACCOUNTS",
"enabled": true,
"frequency": "DAILY",
"interval": 1,
"scope_access": {
"READ": true,
"CREATE": true,
"UPDATE": true,
"DELETE": true
},
"category": "ACCOUNTING",
"sync_from": "2023-01-01T00:00:00Z"
}
],
"category": "ACCOUNTING"
}
]
}
}- Change the company name.
- Update the sync config for this company (includes specific scopes, custom fields or sync frequency).
Authorizations
Path Parameters
The ID of the invite link to update
Body
The body of the invite link to update
The data of the invite link endpoint
The integration categories of the invite link
ACCOUNTING, PAYMENTS, CRM, ECOMMERCE, CUSTOM The name of the company
The integrations of the invite link
ZOHO_BOOKS, QUICKBOOKS_SANDBOX, QUICKBOOKS, XERO, TALLY, ROOTFI_SANDBOX, SAGE_CLOUD_ACCOUNTING, MS_DYNAMICS_365, SAGE_ZA_CLOUD_ACCOUNTING, MYOB_BUSINESS, NETSUITE, WAVE, ODOO_ACCOUNTING, WAFEQ, MEKARI_JURNAL, BUSY, QOYOD, STRIPE, RAZORPAY, PAYPAL, SHOPIFY, BIG_COMMERCE, WOO_COMMERCE, HUBSPOT, SALESFORCE, PIPEDRIVE, ZOHO_CRM The sync configuration of the connection
Show child attributes
Show child attributes
The status of the sync configuration
true
The interval of the sync configuration
1
The frequency of the sync configuration
DAILY, WEEKLY, MONTHLY, YEARLY The data model of the sync configuration
ACCOUNTS, BANK_ACCOUNTS, BILLS, BILL_PAYMENTS, COMPANY_INFO, CONTACTS, BILL_CREDIT_NOTES, INVOICE_CREDIT_NOTES, DOCUMENTS, EXPENSES, INVOICES, INVOICE_PAYMENTS, ITEMS, LINE_ITEMS, TAX_RATES, JOURNAL_ENTRIES, BANK_TRANSACTIONS, JOURNAL_LINES, PURCHASE_ORDERS, SALES_ORDERS, PHONE_NUMBERS, ADDRESSES, EXTERNAL_LINKS, CONTACT_PERSONS, INCOME_STATEMENT, BALANCE_SHEET, TRACKING_CATEGORIES, CASH_FLOW_STATEMENT, CURRENCIES, PAYMENT_CUSTOMERS, PAYMENT_INVOICES, PAYMENT_LINE_ITEMS, PAYMENT_ITEMS, PAYMENT_ORDERS, PAYMENT_TAX_RATES, PAYMENT_DISPUTES, PAYMENT_PAYMENTS, PAYMENT_REFUNDS, PAYMENT_PAYMENT_LINKS, PAYMENT_PAYOUTS, PAYMENT_ADDRESSES, PAYMENT_PHONE_NUMBERS, PAYMENT_EXTERNAL_LINKS, PAYMENT_TRANSACTIONS, PAYMENT_BALANCES, ECOMMERCE_ORDERS, ECOMMERCE_CUSTOMERS, ECOMMERCE_PRODUCTS, ECOMMERCE_LINE_ITEMS, CRM_CONTACTS, CRM_COMPANIES, CRM_DEALS, CRM_LEADS, CRM_NOTES, CRM_PIPELINES, CRM_STAGES, CRM_ACTIVITIES, CRM_TASKS, CRM_USERS, CRM_EXTERNAL_LINKS, CRM_PHONE_NUMBERS, CRM_ADDRESSES The category of the datamodel
ACCOUNTING, PAYMENTS, CRM, ECOMMERCE, CUSTOM The scope access of the sync configuration
The date from which the data should be synced. If not provided, it will sync all historical data.
The custom field names to fetch during syncing (for Netsuite, Hubspot only)
A custom ID which can be used to identify the invite link or Company
Response
The data of the invite link endpoint
The data of the invite link endpoint
Show child attributes
Show child attributes
The unique ID we assign for that data's information
The date at which RootFi first synced this data
The latest date at which RootFi updated this data
The ID of the invite link
"1"
The integrations of the invite link
ZOHO_BOOKS, QUICKBOOKS_SANDBOX, QUICKBOOKS, XERO, TALLY, ROOTFI_SANDBOX, SAGE_CLOUD_ACCOUNTING, MS_DYNAMICS_365, SAGE_ZA_CLOUD_ACCOUNTING, MYOB_BUSINESS, NETSUITE, WAVE, ODOO_ACCOUNTING, WAFEQ, MEKARI_JURNAL, BUSY, QOYOD, STRIPE, RAZORPAY, PAYPAL, SHOPIFY, BIG_COMMERCE, WOO_COMMERCE, HUBSPOT, SALESFORCE, PIPEDRIVE, ZOHO_CRM The integration categories of the invite link
ACCOUNTING, PAYMENTS, CRM, ECOMMERCE, CUSTOM The company of the invite link
Show child attributes
Show child attributes
The unique ID we assign for that data's information
The date at which RootFi first synced this data
The latest date at which RootFi updated this data
The name of the company
"RootFi"
The connections of the invite link
Show child attributes
Show child attributes
The unique ID we assign for that data's information
The date at which RootFi first synced this data
The latest date at which RootFi updated this data
The integration type of the connection
ZOHO_BOOKS, QUICKBOOKS_SANDBOX, QUICKBOOKS, XERO, TALLY, ROOTFI_SANDBOX, SAGE_CLOUD_ACCOUNTING, MS_DYNAMICS_365, SAGE_ZA_CLOUD_ACCOUNTING, MYOB_BUSINESS, NETSUITE, WAVE, ODOO_ACCOUNTING, WAFEQ, MEKARI_JURNAL, BUSY, QOYOD, STRIPE, RAZORPAY, PAYPAL, SHOPIFY, BIG_COMMERCE, WOO_COMMERCE, HUBSPOT, SALESFORCE, PIPEDRIVE, ZOHO_CRM The status of the connection
HEALTHY, DISCONNECTED, EXPIRED, PENDING The sync status of the connection
IDLE, FETCHING, SLEEPING, PARSING, RUNNING The rate limits of the connection
The category of the connection
ACCOUNTING, PAYMENTS, CRM, ECOMMERCE, CUSTOM The sync configuration of the connection
Show child attributes
Show child attributes
The status of the sync configuration
true
The interval of the sync configuration
1
The frequency of the sync configuration
DAILY, WEEKLY, MONTHLY, YEARLY The data model of the sync configuration
ACCOUNTS, BANK_ACCOUNTS, BILLS, BILL_PAYMENTS, COMPANY_INFO, CONTACTS, BILL_CREDIT_NOTES, INVOICE_CREDIT_NOTES, DOCUMENTS, EXPENSES, INVOICES, INVOICE_PAYMENTS, ITEMS, LINE_ITEMS, TAX_RATES, JOURNAL_ENTRIES, BANK_TRANSACTIONS, JOURNAL_LINES, PURCHASE_ORDERS, SALES_ORDERS, PHONE_NUMBERS, ADDRESSES, EXTERNAL_LINKS, CONTACT_PERSONS, INCOME_STATEMENT, BALANCE_SHEET, TRACKING_CATEGORIES, CASH_FLOW_STATEMENT, CURRENCIES, PAYMENT_CUSTOMERS, PAYMENT_INVOICES, PAYMENT_LINE_ITEMS, PAYMENT_ITEMS, PAYMENT_ORDERS, PAYMENT_TAX_RATES, PAYMENT_DISPUTES, PAYMENT_PAYMENTS, PAYMENT_REFUNDS, PAYMENT_PAYMENT_LINKS, PAYMENT_PAYOUTS, PAYMENT_ADDRESSES, PAYMENT_PHONE_NUMBERS, PAYMENT_EXTERNAL_LINKS, PAYMENT_TRANSACTIONS, PAYMENT_BALANCES, ECOMMERCE_ORDERS, ECOMMERCE_CUSTOMERS, ECOMMERCE_PRODUCTS, ECOMMERCE_LINE_ITEMS, CRM_CONTACTS, CRM_COMPANIES, CRM_DEALS, CRM_LEADS, CRM_NOTES, CRM_PIPELINES, CRM_STAGES, CRM_ACTIVITIES, CRM_TASKS, CRM_USERS, CRM_EXTERNAL_LINKS, CRM_PHONE_NUMBERS, CRM_ADDRESSES The category of the datamodel
ACCOUNTING, PAYMENTS, CRM, ECOMMERCE, CUSTOM The scope access of the sync configuration
Show child attributes
Show child attributes
The access of the scope
The access of the scope
The access of the scope
The access of the scope
The date from which the data should be synced. If not provided, it will sync all historical data.
The custom field names to fetch during syncing (for Netsuite, Hubspot only)