User

Create Strike

Create a user strike for a policy violation and get the resulting effective action.

POST
/api/user/strike

Create a strike when you need to record a violation directly. This endpoint returns the created strike and the current effective action for the user.

Authorizations

  • Authorizationstringheaderrequired

    API Key required. Format: Bearer wc-your-api-key

Headers

  • whitecircle-versionstringrequired

    API Version

    Example: "2025-12-01"

Body

application/json

  • policy_idstringrequired

  • severity_level_idstring<uuid>required

  • emailstring | null

  • external_session_idstring | null

  • idstring | null

  • internal_session_idstring | null

  • ipstring | null

Response

application/json

Success

  • strikeobjectrequired

    Show child attributes
    • strike.created_atinteger<int64>required

    • strike.expires_atinteger<int64>required

    • strike.internal_session_idstringrequired

    • strike.pointsinteger<int32>required

    • strike.policyobjectrequired

      Show child attributes
      • strike.policy.idstringrequired

      • strike.policy.namestringrequired

      • strike.policy.severitystringrequired

    • strike.reasonstringrequired

    • strike.severitystringrequired

    • strike.appealnull | object

      Show child attributes
      • strike.appeal.statusstringrequired

      • strike.appeal.timeinteger<int64>required

    • strike.external_session_idstring | null

  • actionstring | null

  • action_expires_atstring<date-time> | null