Sha256: 258af00ded39009d19ec20643f2aa27cd3e226e8c2b8f31719367fbfa8231633
Contents?: true
Size: 1.54 KB
Versions: 14
Compression:
Stored size: 1.54 KB
Contents
# InboxRegistration
## Example InboxRegistration Object
```
{
"code": "abc123",
"name": "account",
"company": "Action Verb",
"email": "john.doe@files.com",
"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
* `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(
per_page: 1,
folder_behavior_id: 1
)
```
### Parameters
* `cursor` (string): Used for pagination. Send a cursor value to resume an existing list from the point at which you left off. Get a cursor from an existing list via either the X-Files-Cursor-Next header or the X-Files-Cursor-Prev header.
* `per_page` (int64): Number of records to show per page. (Max: 10,000, 1,000 or less is recommended).
* `folder_behavior_id` (int64): ID of the associated Inbox.
Version data entries
14 entries across 14 versions & 1 rubygems