Sign in
Setup User

Update

Update an existing Setup User record by ID.

put/api/cp/setup/user/{id}

Path parameters

idinteger required

Id identifier

Request body

idinteger

Id

account_idinteger

Account Id (references account.id)

reseller_idinteger

Reseller Id

namestring required

Name

emailstring email

Email (unique)

passwordstring password

Password

mobilestring

Mobile

skypestring

Skype

role'Administrator' | 'User' | 'Guest'

Role

tfa_secretstring password

Tfa Secret

floating_nocinteger required

Floating Noc

languagestring

Language

last_loginstring date-time nullable

Last Login

login_countinteger required

Login Count

mobile_verifyinteger

Mobile Verify

email_verifyinteger

Email Verify

otp_hashstring

Otp Hash

api_keystring

Api Key

timezonestring

Timezone

readonlyinteger required

Readonly

email_subscriptionstring

Email Subscription

ip_whiteliststring

Ip Whitelist

share_ticketinteger required

Share Ticket

id_verifystring required

Id Verify

flagsstring

Flags

Example request

{
  "id": 12345,
  "account_id": 1,
  "reseller_id": 1,
  "name": "Example Name",
  "email": "user@example.com",
  "password": "********",
  "mobile": "+1-555-123-4567",
  "skype": "example_skype",
  "role": "Administrator",
  "tfa_secret": "example_tfa_secret",
  "floating_noc": 1,
  "language": "example_language",
  "last_login": "2025-01-17T10:30:00Z",
  "login_count": 10,
  "mobile_verify": 1000,
  "email_verify": 123,
  "otp_hash": "example_otp_hash",
  "api_key": "example_api_key",
  "timezone": "example_timezone",
  "readonly": 1,
  "email_subscription": "example_email_subscription",
  "ip_whitelist": "example_ip_whitelist",
  "share_ticket": 1,
  "id_verify": "example_id_verify",
  "flags": "example_flags"
}

Response

Operation completed successfully

statusstring

Operation status

Example response

{
  "status": "OK"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.