POST /deposit-custom-property-sets
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.
Servers
- https://api-sandbox.rebilly.com/organizations/{organizationId}
- https://api.rebilly.com/organizations/{organizationId}
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | No |
ID of the deposit property set. |
_links[] |
Array | No |
Related links. |
_links[].href |
String | No |
Link URL. |
_links[].rel |
String | No |
Type of link. Valid values:
|
name |
String | Yes |
Name of the custom property set. |
updatedTime |
String | No |
Date and time when the resource is updated. This value is set automatically when the resource is updated. |
properties |
Object | Yes |
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: |
createdTime |
String | No |
Date and time when the resource is created. This value is set automatically when the resource is created. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.