Integrations Status

Update Kindful on the status of the integration as a means to provide feedback to users on the Kindful side.



posthttps://app.kindful.com/admin/oauth2/api/v1/integrations/status

COPY
  Post

  {
    "data": {
      "status": "Connected",
      "units": "5"
    }
  }

  Successful Response (200)

  {
    "allow_campaign_sync": true,
    "allow_remote_campaign_creation": false,
    "contact_name_format": "display_name",
    "enable_local_changes_push": false,
    "enable_remote_changes_pull": false,
    "id": 13,
    "name": null,
    "sync_enabled": false,
    "type": "Integrations::Application",
    "units": 5,
    "fetch_transactions_after": null,
    "push_transactions_after": null,
    "first_sync_at": null,
    "first_sync_completed_at": null,
    "last_synced_at": null,
    "last_sync_completed_at": null,
    "org_name": "Nonprofit Organization",
    "subdomain": "nonprofit",
    "org_trial_tier": false
  }

Body Params

status
string
required

Must be one of the following values:

units
string

Use units to pass in the number of connected users to your application

Note: You will need the data\_query scope for this endpoint.



Units

Use units to send Kindful the number of connected accounts/users authenticated to your application.



Indicate Disconnected Status

Note: Sending the following request will indicate your application as disconnected in the app directory.

COPY
  {
    "data": {
      "status": "disconnected",
      "units": "0"
    }
  }