Deactivate Subscription

  • Published on Feb 25, 2025
Delete
/scheduled-exports/logs/subscription/{subscription_id}

Deactivates a single export subscription for a given Subscription Id.

Security
API Key
Query parameter nameapp_id

app_id | Unique identifier for Branch app of requested data.

API Key
Header parameter nameaccess-token

Access-Token | Key that encapsulates the users permission w.r.t an org. Obtained from the Branch Dashboard needed for authentication.

Path parameters
subscription_id
stringRequired

A persistent id for the specific subscription.

ExampleXXXX-0000-xxxx
Responses
200

Status of aggregate export

object

Deactivate Subscription Body

status
string

Indicates whether the deactivate request succeeded.

ExampleSUCCESS
description
string

Additional information about the status of the request

ExampleSubscription deactivated successfully
400

Authentication Failed

Result
"{\n    \"error\": {\n        \"message\": \"Authentication failed !\",\n        \"code\": 400\n    }\n}"
Expand All
object
error
object (inline_response_400_error)
message
string
ExampleAuthentication failed !
code
integer
Example400
404

Job ID Not Found