logo

Create a custom deposit property set

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.

SecuritySecretApiKey or JWT
Request
Request Body schema: application/json
required

Custom deposit property set resource.

name
required
string

Name of the custom property set.

properties
required
object

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.

Responses
201

Custom deposit property set created.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
name
required
string

Name of the custom property set.

properties
required
object

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.

id
string <= 50 characters

ID of the deposit property set.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

post/deposit-custom-property-sets
Request samples
application/json
{
  • "name": "string",
  • "properties": {
    }
}
Response samples
application/json
{
  • "id": "dep_prop_0YVJ640MB4CXVB8KXBRW3B79R9",
  • "name": "string",
  • "properties": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}
➔ Next to Retrieve custom deposit properties sets