Skip to content

user_request.change

Request change of personal information

Create

Path
POST /v7.0/user_request/changes
Description
Authentication required
yes
Scope
user_request.change#create
Aliases
new
Blocking
no

Input parameters

Layout
object
Namespace
change
ParameterTypeRequiredDetails
change_reason
Change reason
 String yes

Why do you wish to make the change?

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty

Length
  • Maximum length: 255 characters (inclusive).

Validation error message: length must be at most 255
full_name
Full name
 String no

First and last name

Default: null

Validation rules
RuleDetails
Length
  • Minimum length: 2 characters (inclusive).

Validation error message: length must be at least 2
email
E-mail
 String no

Administrator of this zone

Default: null

Validation rules
RuleDetails
Format

Must match this regular expression:

@

null

Validation error message: not a valid e-mail address
address
Address
 String no

Default: null

Output parameters

Layout
object
Namespace
change
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
raw_user_id
Raw_user_id
 Integer
state
State
 String
api_ip_addr
API IP address
 String
api_ip_ptr
API IP PTR
 String
client_ip_addr
Client IP address
 String
client_ip_ptr
Client IP PTR
 String
admin
Admin
 Resource Filter users with administrator privileges
admin_response
Admin's response
 String
created_at
Created at
 Datetime
updated_at
Updated at
 Datetime
label
Label
 String
change_reason
Change reason
 String Why do you wish to make the change?
full_name
Full name
 String First and last name
email
E-mail
 String Administrator of this zone
address
Address
 String

Index

Path
GET /v7.0/user_request/changes
Description
Authentication required
yes
Scope
user_request.change#index
Aliases
list
Blocking
no

Input parameters

Layout
object
Namespace
change
ParameterTypeRequiredDetails
from_id
From ID
 Integer no

List objects with IDs greater or lower than this value

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).

Validation error message: must be at least 0
limit
Limit
 Integer no

Number of objects to retrieve

Default: null

Validation rules
RuleDetails
Number
  • Must be a number after parameter type conversion.
  • Minimum: 0 (inclusive).
  • Maximum: 1000 (inclusive).

Validation error message: must be between 0 and 1000
user
User
 Resource no
state
State
 String no

Default: null

Validation rules
RuleDetails
Include

Allowed values:

  • awaiting
  • approved
  • denied
  • ignored
  • pending_correction

Validation error message: %{value} cannot be used
api_ip_addr
API IP address
 String no

Default: null
client_ip_addr
Client IP address
 String no

Default: null
client_ip_ptr
Client IP PTR
 String no

Default: null
admin
Admin
 Resource no

Filter users with administrator privileges

Output parameters

Layout
object_list
Namespace
changes
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
raw_user_id
Raw_user_id
 Integer
state
State
 String
api_ip_addr
API IP address
 String
api_ip_ptr
API IP PTR
 String
client_ip_addr
Client IP address
 String
client_ip_ptr
Client IP PTR
 String
admin
Admin
 Resource Filter users with administrator privileges
admin_response
Admin's response
 String
created_at
Created at
 Datetime
updated_at
Updated at
 Datetime
label
Label
 String
change_reason
Change reason
 String Why do you wish to make the change?
full_name
Full name
 String First and last name
email
E-mail
 String Administrator of this zone
address
Address
 String

Resolve

Path
POST /v7.0/user_request/changes/{change_id}/resolve
Description
Resolve user request
Authentication required
yes
Scope
user_request.change#resolve
Aliases
Blocking
no

Input parameters

Layout
object
Namespace
change
ParameterTypeRequiredDetails
action
Action
 String yes

Default: null

Validation rules
RuleDetails
Present

Must be supplied and cannot be null. Must not be empty; strings must contain a non-whitespace character.

Validation error message: must be present and non-empty

Include

Allowed values:

  • approve
  • deny
  • ignore
  • request_correction

Validation error message: %{value} cannot be used
reason
Reason
 Text no

Default: null
change_reason
Change reason
 String no

Why do you wish to make the change?

Default: null

Validation rules
RuleDetails
Length
  • Maximum length: 255 characters (inclusive).

Validation error message: length must be at most 255
full_name
Full name
 String no

First and last name

Default: null

Validation rules
RuleDetails
Length
  • Minimum length: 2 characters (inclusive).

Validation error message: length must be at least 2
email
E-mail
 String no

Administrator of this zone

Default: null

Validation rules
RuleDetails
Format

Must match this regular expression:

@

null

Validation error message: not a valid e-mail address
address
Address
 String no

Default: null

Output parameters

No parameters.

Show

Path
GET /v7.0/user_request/changes/{change_id}
Description
Authentication required
yes
Scope
user_request.change#show
Aliases
find
Blocking
no

Input parameters

No parameters.

Output parameters

Layout
object
Namespace
change
ParameterTypeDescription
id
Id
 Integer
user
User
 Resource
raw_user_id
Raw_user_id
 Integer
state
State
 String
api_ip_addr
API IP address
 String
api_ip_ptr
API IP PTR
 String
client_ip_addr
Client IP address
 String
client_ip_ptr
Client IP PTR
 String
admin
Admin
 Resource Filter users with administrator privileges
admin_response
Admin's response
 String
created_at
Created at
 Datetime
updated_at
Updated at
 Datetime
label
Label
 String
change_reason
Change reason
 String Why do you wish to make the change?
full_name
Full name
 String First and last name
email
E-mail
 String Administrator of this zone
address
Address
 String