Skip to content
MediuxDocs

Clear a relationship

DELETE/relationships/{username}

Removes your follow or hide of a User.

Works by username for any User, including one who is now banned or hidden. Clearing a relationship that does not exist, or naming an unknown or stale username, is a 204 no-op. Usernames can change, and a freed username can be taken by another User: store the target's id and re-read its current username (from GET /relationships or the profile) before writing.

Authorization

OAuth 2 bearer token in the Authorization header. Required scope: relationships:manage

Path parameters

  • username string required

    The username of the User to follow, hide or clear, in any letter case.

    pattern

Responses

204 The relationship is cleared; no body.

Headers

  • Cache-Control string

    Browser caching policy.

    "private, no-store"
400 The request is malformed or failed validation. Inspect error.code and error.issues.

Headers

  • Cache-Control string

    Browser caching policy.

    "private, no-store"
  • data any | null

    Always null on an error.

  • error object

    Why the request failed.

    Show child attributes
    • code string

      Stable dotted camelCase code such as resource.gone. Branch on this, not on message.

    • message string

      Short explanation for people. Wording can change.

      min length 1max length 256
    • requestId string

      The Cloudflare ray ID. Absent on Snippet and WAF errors and on cached 404, 410 and 503 responses, which carry it only in cf-ray.

      min length 1
    • docs string (uri)

      Link to this code's entry in the error catalogue.

    • details map of string | number | boolean | array of string | null

      Constraints that apply to the failure, such as byte limits, dimensions or allowed types.

    • issues array of object

      Per-field validation failures, when any.

      max 50 items
      Show item attributes
      • code string

        Stable code for this field failure. Branch on this.

        min length 1
      • message string

        Short human-readable description of this field failure.

        min length 1
      • path array of string

        Path to the failing field, for example ["items", 2, "slot"].

      • details map of string | number | boolean | array of string | null

        Constraints that apply to the failure, such as byte limits, dimensions or allowed types.

401 The access token is missing (auth.required), or invalid, expired or revoked (auth.invalidToken).

Headers

  • Cache-Control string

    Browser caching policy.

    "private, no-store"
  • WWW-Authenticate string

    RFC 6750 challenge: Bearer realm="mediux", plus error="invalid_token" for a bad or expired token.

  • data any | null

    Always null on an error.

  • error object

    Why the request failed.

    Show child attributes
    • code string

      Stable dotted camelCase code such as resource.gone. Branch on this, not on message.

    • message string

      Short explanation for people. Wording can change.

      min length 1max length 256
    • requestId string

      The Cloudflare ray ID. Absent on Snippet and WAF errors and on cached 404, 410 and 503 responses, which carry it only in cf-ray.

      min length 1
    • docs string (uri)

      Link to this code's entry in the error catalogue.

    • details map of string | number | boolean | array of string | null

      Constraints that apply to the failure, such as byte limits, dimensions or allowed types.

    • issues array of object

      Per-field validation failures, when any.

      max 50 items
      Show item attributes
      • code string

        Stable code for this field failure. Branch on this.

        min length 1
      • message string

        Short human-readable description of this field failure.

        min length 1
      • path array of string

        Path to the failing field, for example ["items", 2, "slot"].

      • details map of string | number | boolean | array of string | null

        Constraints that apply to the failure, such as byte limits, dimensions or allowed types.

403 The token lacks the required App Permission (auth.insufficientScope, with details.required), or the account or connection may not do this (auth.forbidden).

Headers

  • Cache-Control string

    Browser caching policy.

    "private, no-store"
  • data any | null

    Always null on an error.

  • error object

    Why the request failed.

    Show child attributes
    • code string

      Stable dotted camelCase code such as resource.gone. Branch on this, not on message.

    • message string

      Short explanation for people. Wording can change.

      min length 1max length 256
    • requestId string

      The Cloudflare ray ID. Absent on Snippet and WAF errors and on cached 404, 410 and 503 responses, which carry it only in cf-ray.

      min length 1
    • docs string (uri)

      Link to this code's entry in the error catalogue.

    • details map of string | number | boolean | array of string | null

      Constraints that apply to the failure, such as byte limits, dimensions or allowed types.

    • issues array of object

      Per-field validation failures, when any.

      max 50 items
      Show item attributes
      • code string

        Stable code for this field failure. Branch on this.

        min length 1
      • message string

        Short human-readable description of this field failure.

        min length 1
      • path array of string

        Path to the failing field, for example ["items", 2, "slot"].

      • details map of string | number | boolean | array of string | null

        Constraints that apply to the failure, such as byte limits, dimensions or allowed types.

429 Too many requests. Wait the Retry-After seconds before trying again.

Headers

  • Cache-Control string

    Browser caching policy.

    "private, no-store"
  • Retry-After string

    Seconds to wait before trying again.

    pattern ^\d+$
  • data any | null

    Always null on an error.

  • error object

    Why the request failed.

    Show child attributes
    • code string

      Stable dotted camelCase code such as resource.gone. Branch on this, not on message.

    • message string

      Short explanation for people. Wording can change.

      min length 1max length 256
    • requestId string

      The Cloudflare ray ID. Absent on Snippet and WAF errors and on cached 404, 410 and 503 responses, which carry it only in cf-ray.

      min length 1
    • docs string (uri)

      Link to this code's entry in the error catalogue.

    • details map of string | number | boolean | array of string | null

      Constraints that apply to the failure, such as byte limits, dimensions or allowed types.

    • issues array of object

      Per-field validation failures, when any.

      max 50 items
      Show item attributes
      • code string

        Stable code for this field failure. Branch on this.

        min length 1
      • message string

        Short human-readable description of this field failure.

        min length 1
      • path array of string

        Path to the failing field, for example ["items", 2, "slot"].

      • details map of string | number | boolean | array of string | null

        Constraints that apply to the failure, such as byte limits, dimensions or allowed types.

503 Temporarily unavailable. Check the outcome before retrying a write.

Headers

  • Cache-Control string

    Browser caching policy.

    "private, no-store"
  • data any | null

    Always null on an error.

  • error object

    Why the request failed.

    Show child attributes
    • code string

      Stable dotted camelCase code such as resource.gone. Branch on this, not on message.

    • message string

      Short explanation for people. Wording can change.

      min length 1max length 256
    • requestId string

      The Cloudflare ray ID. Absent on Snippet and WAF errors and on cached 404, 410 and 503 responses, which carry it only in cf-ray.

      min length 1
    • docs string (uri)

      Link to this code's entry in the error catalogue.

    • details map of string | number | boolean | array of string | null

      Constraints that apply to the failure, such as byte limits, dimensions or allowed types.

    • issues array of object

      Per-field validation failures, when any.

      max 50 items
      Show item attributes
      • code string

        Stable code for this field failure. Branch on this.

        min length 1
      • message string

        Short human-readable description of this field failure.

        min length 1
      • path array of string

        Path to the failing field, for example ["items", 2, "slot"].

      • details map of string | number | boolean | array of string | null

        Constraints that apply to the failure, such as byte limits, dimensions or allowed types.

The path holds the target’s username in any letter case. The route works for any user holding that username, including one who has since been banned or hidden. It answers 204 with no body, also when there was no relationship to clear or no user holds the username: a stale name is a no-op. Usernames can change and a freed name can be taken by another user, so store the id and read the current username from the row’s target.username in GET /relationships before clearing.