setClientSelfExclusion

This command triggers a Self-Exclusion (SX) event. Command is a legal and regulatory requirement that locks the user's account entirely

This command requires the logged in session

Documentation

Try it now

Request parameters:

Name	Description	Type	Values	Default

password	User password to verify that the person requesting the exclusion is the actual account owner	string	-	-
excType	Defines the type of exclusion	string	"timeout", "bettingBlock", "selfExclusion", "accountClosure", "availabilityPeriod", "sportsBookTemporaryBlock", "sportBookBlockForAccountClosure"	-
days	Number of days for temporary exclusion	number	-	-
months	Number of months for temporary exclusion	number	-	-
years	Number of years for temporary exclusion	number	-	-
reasonText	If the system uses TwoReason for the self-exclusion provided by the user	string	-	-
confirmationCode	Confirmation code sent to the user via email or sms	number	-	-
minutes	Number of minutes for temporary exclusion	number	-	-
hours	Number of hours for temporary exclusion	number	-	-
reason	Soon	number	-	-
isInfinitive	Soon	boolean	true / false	-
schedules	A collection of specific time-slots during which the user is prohibited	array	-	-
└─		object		-
└─ scheduleType	The frequency of the schedule	string	-	"week"
└─ weekDayFrom	Start the days of the week for the restriction	string	"monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"	-
└─ weekDayTo	End the days of the week for the restriction	string	"monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"	-
└─ timeFrom	The exact clock time (HH:MM:SS) the restriction starts within those specific days	string	-	-
└─ timeTo	The exact clock time (HH:MM:SS) the restriction ends within those specific days	string	-	-

Call example:
JavaScriptReact HookFlutter

setClientSelfExclusion({
  excType: 'availabilityPeriod',
  hours: 1,
  password: 1,
  reason: 1,
  reasonText: 'reason text',
  schedules: [{
    scheduleType: 'week',
    weekDayFrom: 'sunday',
    weekDayTo: 'sunday',
    timeFrom: '13:00:00',
    timeTo: '14:00:00'
  }, {
    scheduleType: 'week',
    weekDayFrom: 'saturday',
    weekDayTo: 'saturday',
    timeFrom: '16:00:00',
    timeTo: '17:00:00'
  }]
})

Response examples:
SuccessError

{
  code: 0,
  rid: 'command527167704059894',
  data: {
    result: 0,
    result_text: null,
    details: {
      ClientId: 88736727,
      ExcludeTypeId: 8,
      Excluded: 1767606444,
      ExcludedFrom: 1767001644,
      Status: 2,
      BeforeBalance: 302.29,
      AfterBalance: 302.29,
      IBAN: null,
      Created: 1718786241
    }
  }
}

Response parameters:

Name	Description	Type	Values

ClientId	The unique internal ID of the player being excluded	number	-
ExcludeTypeId	Soon	number	-
ExcludedFrom	The Start Timestamp (Unix epoch). This is the exact moment the restriction became active	number	-
Excluded	The End Timestamp (Unix epoch). This represents the date and time the restriction will automatically lift	number	-
Status	Soon	number	-
BeforeBalance	Soon	number	-
AfterBalance	Soon	number	-
Created	The audit timestamp for when this specific exclusion record was created	number	-
IBAN	The IBAN field is used to identify the designated bank account for the mandatory withdrawal of remaining funds	number	-