Sha256: 321ef64b7aa2a713b55dba07e4ab3f933c465680964dccb5275cdc0b3b79da95

Contents?: true

Size: 1.36 KB

Versions: 3

Compression:

Stored size: 1.36 KB

Contents

# InboxRegistration

## Example InboxRegistration Object

```
{
  "code": "abc123",
  "name": "account",
  "company": "Action Verb",
  "email": "john.doe@files.com",
  "clickwrap_body": "",
  "form_field_set_id": 1,
  "form_field_data": "",
  "inbox_id": 1,
  "inbox_recipient_id": 1,
  "inbox_title": ""
}
```

* `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


---

## 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 the X-Files-Cursor-Next 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

3 entries across 3 versions & 1 rubygems

Version Path
files.com-1.0.228 docs/inbox_registration.md
files.com-1.0.227 docs/inbox_registration.md
files.com-1.0.226 docs/inbox_registration.md