Skip to main content
POST
Inactivate Subscription
Required token scopes: Activate/inactivate scenarios, Manage scenarios on behalf of user (both are required) Optionally, you can include an authorUid body field (a Texter user UID) to attribute the action to a specific user; when omitted, it is attributed automatically.

Authorizations

Authorization
string
header
required

API token generated in Texter: gear icon → Developers → API Tokens. When creating a token, assign it the scopes required by the endpoints you plan to call - each endpoint lists its required scopes.

Path Parameters

scenarioId
string
required

The unique identifier of the subscription (scenario). Use List All Subscriptions to find it under scenarios[]._id

Body

application/json
authorUid
string

Optional - Texter user ID (UID) to attribute the action to. When omitted, it is attributed automatically

Response

The updated scenario object (the active revision moved to inactiveRevisions). Field-by-field reference: The Scenario object

An event subscription (scenario) in Texter

_id
string

Unique identifier of the subscription/scenario

system
string

System scenario identifier. Present only on built-in system scenarios (returned when includeSystem=true)

drafts
object[]

Draft revisions of this scenario being edited. Same shape as a revision, but with status: "draft", no version/revisionComment, and metadata limited to authorUid/created/modified

inactiveRevisions
object[]

Inactive revisions

activeRevision
object

The currently active version of the scenario