Docs
API ReferenceapiidentityPATCH /v1/erasure-requests/{request_id}

PATCH /v1/erasure-requests/\{request_id\}

Service: identity · operationId: (none)

Internal workflow status update for an erasure request

Required scopes

(no scope declared — review service config)

Path parameters

  • request_id (string) required —

Request body

{
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "in_progress",
        "completed"
      ]
    },
    "services_erased": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "partial_failures": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "service": {
            "type": "string",
            "minLength": 1
          },
          "message": {
            "type": "string",
            "minLength": 1
          }
        },
        "required": [
          "service",
          "message"
        ]
      }
    },
    "completed_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  }
}

Responses

200 Erasure request updated

{
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string",
      "format": "uuid"
    },
    "user_id": {
      "type": "string"
    },
    "requested_by": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "in_progress",
        "completed"
      ]
    },
    "reason": {
      "type": "string"
    },
    "services_erased": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "partial_failures": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "service": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        },
        "required": [
          "service",
          "message"
        ]
      }
    },
    "requested_at": {
      "type": "string",
      "format": "date-time"
    },
    "completed_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  },
  "required": [
    "request_id",
    "user_id",
    "requested_by",
    "status",
    "reason",
    "services_erased",
    "partial_failures",
    "requested_at",
    "completed_at"
  ]
}

400 Validation error

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

403 Forbidden

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

404 Not found

{
  "type": "object",
  "properties": {
    "error": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  },
  "required": [
    "error",
    "message"
  ]
}

Example

curl -X PATCH https://identity.platform.loop.health/v1/erasure-requests/{request_id} \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Related

PATCH /v1/admin/staff/{id}PATCH /v1/users/me/addresses/{address_id}