Create Document

Creates a new Document and sends it to given recipients.

Body Parameters

Key	Type	Description
document.title	string
document.description	string
document.message_channel	enum: `['sms', 'email', 'push']`	The channel for sending a notification and reminders
document.recipients	integer[]	IDs of members that should receive the document - max. 1000
document.confirmable	boolean	Is document meant to be confirmed by recipients? Default: `false`
document.public_access	boolean	Does document have public access Default: `false` Incompatible with confirmed document & recipient list

When the document is confirmable:

Key	Type	Description
document.deadline_at	datetime	Date until the document should be confirmed
document.first_reminder.days_before_deadline	integer	Number of days before the deadline the first reminder should be sent
document.second_reminder.days_before_deadline	integer	Number of days before the deadline the second reminder should be sent

Response Body

Key	Type	Description
document	Document	See: Document model

Error Responses

Status	Description
`422`	Invalid parameters - see Invalid parameters errors model

Specific Validation Errors

Key	Error
`document.second_reminder`	`cannot_be_present_without_first_reminder`
`document.second_reminder.days_before_deadline`	`cannot_be_before_first_reminder`

Example

When successful, returns object containing created document

{
  "document": {} // Document - see: 'Document model'
}

Request

Header Params

Content-Type

enum<string>

required

Details

Allowed value:

application/json

Default:

application/json

X-User-Agent

string

required

Arbitrary identifier of your client. Details

Default:

X-Product-Name

string

required

API Product for API context. Details

Default:

X-Loyalty-Club-Slug

string

required

LoyaltyClub for API context. Details

Default:

X-Customer

string

required

Customer for API context. Details

Default:

Authorization

string

required

Member or User Authorization.

Default:

Bearer {{_OAUTH_TOKEN}}

X-Client-Authorization

string

optional

Default:

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Body Parameters#

Response Body#

Error Responses#

Specific Validation Errors#

Example#

Request

Request samples

Responses

Body Parameters

Response Body

Error Responses

Specific Validation Errors

Example