Connection
Connections

PUT /connections/disconnect

Changed on

Disable a connection

Request

  • Base URL
    https://api.railz.ai
  • Auth
    HTTP bearer

Request body

connectionIdstring required

Example request

{
  "connectionId": "CON-e66400c1-4d2f-4683-9bea-275799943695"
}

Response

connectionIdstring required
businessNamestring required
serviceName'quickbooks' | 'xero' | 'freshbooks' | 'quickbooksDesktop' | 'sageIntacct' | 'sageBusinessCloud' | 'oracleNetsuite' | 'dynamicsBusinessCentral' | 'dynamics365Finance' | 'wave' | 'zohoBooks' | 'myob' required
statusstring required
createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "connectionId": "CON-e66400c1-4d2f-4683-9bea-275799943695",
  "businessName": "Railz",
  "serviceName": "xero",
  "status": "disconnected",
  "createdAt": "2020-12-25T01:02:03Z",
  "updatedAt": "2020-12-25T01:02:03Z"
}

Changes

    • info

      api tag Connection added

    • warning

      added the new dynamics365Finance enum value to the response property for the response status

    • warning

      added the new dynamicsBusinessCentral enum value to the response property for the response status

    • warning

      added the new freshbooks enum value to the response property for the response status

    • warning

      added the new myob enum value to the response property for the response status

    • warning

      added the new oracleNetsuite enum value to the response property for the response status

    • warning

      added the new quickbooks enum value to the response property for the response status

    • warning

      added the new quickbooksDesktop enum value to the response property for the response status

    • warning

      added the new sageBusinessCloud enum value to the response property for the response status

    • warning

      added the new sageIntacct enum value to the response property for the response status

    • warning

      added the new wave enum value to the response property for the response status

    • warning

      added the new xero enum value to the response property for the response status

    • warning

      added the new zohoBooks enum value to the response property for the response status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status

    • info

      the response required property became read-only for the status