Admin

Block a user account

Blocks a user indefinitely or until a date. ADMIN and SUPPORT_AGENT only; admin-access accounts and the caller cannot be blocked. Re-blocking replaces the current block.

post/admin/users/{user_id}/block

Request

Base URL: https://api.presscart.com (the document declares no server; this is the origin it was published from)
URL: https://api.presscart.com/admin/users/{user_id}/block
Auth: HTTP bearer

Path parameters

user_idstring uuid required

Example:af093537-0832-4a40-b93d-24d1bda00bee

Request body

reasonstring required

Response

User blocked

idstring uuid required

first_namestring required

last_namestring required

full_namestring nullable

emailstring email required

referral_codestring nullable required

user_role_idstring uuid nullable required

user_account_type_idstring uuid nullable required

hubspot_contact_idstring nullable required

timezonestring nullable required

blocked_reasonstring nullable required

blocked_by_user_idstring uuid nullable required

Example response

{
  "first_name": "Alfreda",
  "last_name": "Tremblay",
  "full_name": "Florence Koch",
  "email": "Eric4@yahoo.com",
  "referral_code": "MnWmI0",
  "timezone": "America/New_York",
  "user_role": {
    "name": "ADMIN"
  }
}

Changes

No recorded changes to this operation across all 3 revisions of this API.