Sha256: 80d439e3fac99c2c3c4723e5adf90898a988d8e17a2390dc222ec6d136bdaa51
Contents?: true
Size: 1.76 KB
Versions: 5
Compression:
Stored size: 1.76 KB
Contents
# InboxRegistration
## Example InboxRegistration Object
```
{
"code": "abc123",
"name": "account",
"company": "Action Verb",
"email": "john.doe@files.com",
"ip": "10.1.1.1",
"clickwrap_body": "example",
"form_field_set_id": 1,
"form_field_data": {
"key": "example value"
},
"inbox_id": 1,
"inbox_recipient_id": 1,
"inbox_title": "example",
"created_at": "2000-01-01T01:00:00Z"
}
```
* `code` (string): Registration cookie code
* `name` (string): Registrant name
* `company` (string): Registrant company name
* `email` (string): Registrant email address
* `ip` (string): Registrant IP Address
* `clickwrap_body` (string): Clickwrap text that was shown to the registrant
* `form_field_set_id` (int64): Id of associated form field set
* `form_field_data` (object): Data for form field set with form field ids as keys and user data as values
* `inbox_id` (int64): Id of associated inbox
* `inbox_recipient_id` (int64): Id of associated inbox recipient
* `inbox_title` (string): Title of associated inbox
* `created_at` (date-time): Registration creation date/time
---
## List Inbox Registrations
```
Files::InboxRegistration.list(
folder_behavior_id: 1
)
```
### Parameters
* `cursor` (string): Used for pagination. When a list request has more records available, cursors are provided in the response headers `X-Files-Cursor-Next` and `X-Files-Cursor-Prev`. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
* `action` (string):
* `page` (int64):
* `folder_behavior_id` (int64): ID of the associated Inbox.
Version data entries
5 entries across 5 versions & 1 rubygems