Skip to content

Admin Endpoints

Below we have documented all Management endpoints.

Authentication

These endpoints are restricted to NurtureCloud administrators.

Integrator

Integrators are accounts used to perform any business operation or to manage webhook subscriptions.

Create Integrator

  • Method: POST
  • Endpoint: /management/auth/create
  • Request Payload
    {
      "label": "Raywhite Development",
      "organisationName": "raywhitedevelopment",
      "businessAccessRule": {
          "deniedBusinessIds": []
      }
    }
    

Update Integrator

  • Method: POST
  • Endpoint: /management/auth/update/:id
  • Request Payload
    {
      "label": "Raywhite Development",
      "organisationName": "raywhitedevelopment",
      "businessAccessRule": {
          "deniedBusinessIds": []
      }
    }
    

Update Integrator

  • Method: POST
  • Endpoint: /management/auth/delete/:id

List All Integrators

  • Method: POST
  • Endpoint: /management/auth/list-all