Details

Update the Integration Status API Call allows you to adjust the integration status with the partner.

🚧
Set the status to pending after initial authentication
When the partner enters their Partner API Key in your vendor portal to authenticate the integration set the status to pending.

Requirements

Update the integration Status requires status and a valid GRADIENT-TOKEN.

status - The status represents whether the integration will be "inactive," "active," or "pending"

🚧
Please note: The status is case sensitive

Status Description and Use Case

inactive - This is the default status of the partner integration. If the partner disconnects the integration, mark the status as inactive.

active - Once we've successfully received Billing usage or an Alert, we will mark the integration as active. This does not need to be set manually.

pending - When the partner enters their Partner API Key in your vendor portal to authenticate the integration. Set the status to pending. This tells us you're ready to communicate with this partner account.

Sample Response

The response will show a confirmation that the integration status was updated, and will show the current status.

{
  "data": {
    "organizationId": "64...3c",
    "name": "AJ AT",
    "vendorId": "64...69",
    "vendorName": "API",
    "integrationId": "64...d2",
    "status": "pending",
    "lastSyncedAt": "1900-06-18T17:11:28.553Z"
  },
  "status": 200,
  "message": "Success - Updated Integration Status"
}