POST
/
invite_link
curl --request POST \
  --url https://api.rootfi.dev/invite_link \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_name": "Test Company",
  "integrations": ["ZOHO_BOOKS"]
}'

{
  "data": {
    "invite_link": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b",
    "invite_link_data": {
      "rootfi_id": 1234,
      "rootfi_created_at": "2021-01-01T00:00:00Z",
      "rootfi_updated_at": "2021-01-01T00:00:00Z",
      "rootfi_company_id": 1234,
      "rootfi_organisation_id": 12,
      "metadata": null,
      "invite_link_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b",
      "integrations": [
        "ZOHO_BOOKS"
      ]
    },
    "company_id": 1234
  },
  "request_timestamp": "2021-01-01T00:00:00Z",
  "response_timestamp": "2021-01-01T00:00:00Z",
  "request_id": "7a1c0e42-9f85-4d6e-bb5d-358a72913c0b"
}
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 the company that will be displayed in the Accounting platform. Integration is the name of the integration that you want to connect to. 
curl --request POST \
  --url https://api.rootfi.dev/invite_link \
  --header 'Content-Type: application/json' \
  --header 'api_key: <api-key>' \
  --data '{
  "company_name": "Test Company",
  "integrations": ["ZOHO_BOOKS"]
}'

Authorizations

​
api_key
string
header
required

Body

application/json
​
company_name
string | null

If company_name is not passed, the company won't be created and so, user have to enter it.

​
integrations
enum<string>[] | null

To enable only certain integrations, you can pass a list of integration codes to the API with the key integrations. If only one integration is passed, user will be redirected to the Accounting platform login URL directly.

Response

200 - application/json

Response object for the create invite link endpoint.

​
data
object
required

The response data of the create invite link endpoint

​
request_timestamp
string<date-time>
required

The time at which the request was received by the server

​
response_timestamp
string<date-time>
required

The time at which the response was sent by the server

​
request_id
string
required

The unique ID of the request