SCscrunch
ai-referrals

Disable AI Referrals Connection

Changed on

Soft-disable a connection. Previously pushed events are retained but further pushes are rejected with 410 Gone and the dashboard stops reading from this connection.

delete/{brand_id}/ai-referrals/connections/{connection_id}

Request

Path parameters

brand_idinteger required

The unique identifier for the brand.

connection_idstring required

The ULID of the AI Referrals connection.

Response

Connection disabled.

idstring required

ULID identifier for the connection.

brand_idinteger required
websitestring required

Hostname or URL of the website whose referrals are pushed against this connection.

provider'custom' | 'adobe_analytics' required

Where the data comes from: "custom" for any analytics tool, or "adobe_analytics". Both are read the same way.

status'active' | 'disabled' required
created_atstring date-time required
last_pushed_atstring date-time nullable
last_push_errorstring nullable
sends_engagementboolean

Whether the connection's rows carry users, engagement and key events. Set by its first push.

Example response

{
  "provider": "custom"
}

Changes

  • 3c6aa69a6595Revision changes
    • warning

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

    • warning

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

    • info

      added the optional property to the response with the status