/
Upsert account registrati...

Upsert account registration settings
Experimental

Request

Creates or updates account registration settings with a specified ID.

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

Bodyapplication/jsonrequired

Account registration settings resource.

idstring, <= 50 characters^[a-z0-9\-]+$

ID of the account registration settings. If not provided, the ID is generated from the name.

Example:"eu-registration"
namestring, [ 1 .. 255 ] charactersrequired

Name of the account registration settings.

Example:"EU Registration Requirements"
descriptionstring or null, <= 1000 characters

Description of the account registration settings.

Example:"Account registration settings for EU customers"
isEnabledboolean

Specifies if the account registration settings are active.

Default:true
Example:true
locationsArray of objects

List of locations that the account registration settings apply to. Each location consists of a country and an optional region.

Example:
[
  {
    "country": "CA",
    "region": "ON"
  },
  {
    "country": "GB"
  }
]
fieldsArray of objects(RegistrationField)

List of registration fields that define the registration form.

curl -i -X PUT \
  'https://www.rebilly.com/_mock/catalog/all/account-registration-settings/{id}' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "id": "eu-registration",
    "name": "EU Registration Requirements",
    "description": "Account registration settings for EU customers",
    "isEnabled": true,
    "locations": [
      {
        "country": "CA",
        "region": "ON"
      },
      {
        "country": "GB"
      }
    ],
    "fields": [
      {
        "attribute": "email",
        "displayName": "Email Address",
        "requirementLevel": "required",
        "validationType": "email",
        "validationPattern": "string",
        "minLength": 1,
        "maxLength": 255,
        "helpText": "Enter your email address",
        "minimumAge": 19,
        "inputType": "text",
        "placeholder": "Enter your email address",
        "contentBlock": "For problem gaming assistance call 1-111-111-1111.",
        "order": 0,
        "step": {
          "id": "step-0",
          "displayHeader": "Contact information"
        }
      }
    ]
  }'

Responses

Account registration settings updated.

Headers
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
Bodyapplication/json
idstring, <= 50 characters^[a-z0-9\-]+$

ID of the account registration settings. If not provided, the ID is generated from the name.

Example:"eu-registration"
namestring, [ 1 .. 255 ] charactersrequired

Name of the account registration settings.

Example:"EU Registration Requirements"
descriptionstring or null, <= 1000 characters

Description of the account registration settings.

Example:"Account registration settings for EU customers"
isEnabledboolean

Specifies if the account registration settings are active.

Default:true
Example:true
locationsArray of objects

List of locations that the account registration settings apply to. Each location consists of a country and an optional region.

Example:
[
  {
    "country": "CA",
    "region": "ON"
  },
  {
    "country": "GB"
  }
]
fieldsArray of objects(RegistrationField)

List of registration fields that define the registration form.

realmstring or nullread-only

Keycloak realm associated with the account registration settings.

createdTimestring, (date-time)(CreatedTime)read-only

Date and time when the resource is created. This value is set automatically when the resource is created.

updatedTimestring, (date-time)(UpdatedTime)read-only

Date and time when the resource is updated. This value is set automatically when the resource is updated.

Response
{
  "id": "eu-registration",
  "name": "EU Registration Requirements",
  "description": "Account registration settings for EU customers",
  "isEnabled": true,
  "locations": [
    { … },
    { … }
  ],
  "fields": [
    { … }
  ],
  "realm": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}