/
Create a custom deposit p...

Create a custom deposit property set
Experimental

Request

Creates a custom deposit property set. A custom property set is a JSON-schema to extend the request form with extra form fields. The collected information is stored at the deposit request.

Security
SecretApiKey or JWT
Bodyapplication/jsonrequired

Custom deposit property set resource.

namestringrequired

Name of the custom property set.

propertiesobjectrequired

Defines properties the user can complete when they use the hosted deposit form. This field accepts JSON-schema drafts 4, 6, and 7. Accepted properties types are: string, number, integer, array, and enum. For more information, see Configure custom hosted deposit properties.

Example:
{
  "type": "object",
  "properties": {
    "email": { … },
    "max": { … }
  },
  "required": [
    "email"
  ]
}
curl -i -X POST \
  https://www.rebilly.com/_mock/catalog/all/deposit-custom-property-sets \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "properties": {
      "type": "object",
      "properties": {
        "email": {
          "type": "string"
        },
        "max": {
          "type": "integer",
          "minimum": 0,
          "exclusiveMaximum": 100
        }
      },
      "required": [
        "email"
      ]
    }
  }'

Responses

Custom deposit property set created.

Headers
Locationstring, (uri)

Location of the related resource.

Example:"https://api.rebilly.com/example"
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 charactersread-only

ID of the deposit property set.

Example:"dep_prop_0YVJ640MB4CXVB8KXBRW3B79R9"
namestringrequired

Name of the custom property set.

propertiesobjectrequired

Defines properties the user can complete when they use the hosted deposit form. This field accepts JSON-schema drafts 4, 6, and 7. Accepted properties types are: string, number, integer, array, and enum. For more information, see Configure custom hosted deposit properties.

Example:
{
  "type": "object",
  "properties": {
    "email": { … },
    "max": { … }
  },
  "required": [
    "email"
  ]
}
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": "dep_prop_0YVJ640MB4CXVB8KXBRW3B79R9",
  "name": "string",
  "properties": {
    "type": "object",
    "properties": { … },
    "required": [ … ]
  },
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}