POST
/
core
/
invite_links
curl --request POST \
  --url https://api.rootfi.dev/v3/core/invite_links \
  --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": null
  }
}

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.

Company Name is the name of your customer’s company. This is the name that will be displayed in the RootFi dashboard. If left blank, your customer will be prompted to enter a company name when they connect their integration.

Integration is the name of the integration that you want to connect to. Integration Category is the category of the integrations that you want to connect to.

Authorizations

​
api_key
string
header
required

Body

application/json
The body of the invite link to create

The data of the invite link endpoint

Response

200
application/json

The data of the invite link endpoint