VIviafoura
users

Update User Ban Details

Update the ban details for a user. Requires ban ID which is returned when creating a ban.

patch/{site_id}/bans/{id}

Request

  • Base URL
    https://api.viafoura.co/v2
  • URL
    https://api.viafoura.co/v2/{site_id}/bans/{id}
  • Auth
    none declared

Path parameters

site_idstring required

Site ID is either a site domain or an ID (provided to you by Viafoura Customer Success).

idstring required

Ban ID

Request body */*

durationinteger
permanentinteger
type'ghost' | 'hide' | 'posting' | 'login' | 'none'

Severity level of ban

user_idinteger

Response

OK

uuidstring uuid
user_uuidstring uuid
ban_level'ghost' | 'hide' | 'posting' | 'login' | 'none'

Severity level of ban

is_expiredboolean
user_notesstring

Changes

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