Invite Links
Update Invite Link
Update a single invite link from the database.
PUT
/
core
/
invite_links
/
{invite_link_id}
An invite link contains API requests for generating and managing invite links, which can be used to connect end users to their preferred accounting platforms.
You can update the invite link if you need to:
- Change the company name.
- Update the sync config for this company (includes specific scopes, custom fields or sync frequency).
Authorizations
api_key
string
headerrequiredPath Parameters
invite_link_id
string
requiredThe ID of the invite link to update
Body
application/json
The data of the invite link endpoint
integration_categories
enum<string>[]
requiredThe integration categories of the invite link
Available options:
ACCOUNTING
, PAYMENTS
, CRM
, ECOMMERCE
, CUSTOM
company_name
string | null
The name of the company
integrations
enum<string>[] | null
The integrations of the invite link
Available options:
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
sync_config
object[] | null
The sync configuration of the connection
partner_id
string | null
A custom ID which can be used to identify the invite link or Company
Response
200 - application/json
The data of the invite link endpoint
data
object
requiredThe data of the invite link endpoint