Upsert a custom deposit property set
Creates or updates (upserts) a custom deposit property set with a specified ID.
Request Body schema: application/jsonrequired
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: |
Custom deposit property updated.
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: |
| 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. | |
Custom deposit property set created.
| 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: |
| 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. | |
Unauthorized access. Invalid credentials used.
Access forbidden.
Conflict.
Invalid data sent.
- Payload
- curl
- Node.js
- C#
- Python
- Java
- Go
- Ruby
- PHP
{- "name": "string",
- "properties": {
- "type": "object",
- "properties": {
- "email": {
- "type": "string"
}, - "max": {
- "type": "integer",
- "minimum": 0,
- "exclusiveMaximum": 100
}
}, - "required": [
- "email"
]
}
}- 200
- 201
- 401
- 403
- 409
- 422
{- "id": "dep_prop_0YVJ640MB4CXVB8KXBRW3B79R9",
- "name": "string",
- "properties": {
- "type": "object",
- "properties": {
- "email": {
- "type": "string"
}, - "max": {
- "type": "integer",
- "minimum": 0,
- "exclusiveMaximum": 100
}
}, - "required": [
- "email"
]
}, - "createdTime": "2019-08-24T14:15:22Z",
- "updatedTime": "2019-08-24T14:15:22Z",
- "_links": [
- {
- "href": "string",
- "rel": "self"
}
]
}