Add Recipients to the Document

Pending

POST

https://api.mpc.dev.placewise.com/v1/operations/documents/{id}/recipients

API Permit:Operations:Api:DocumentRecipients:Create

API Context:Loyalty Club

Authorizations:UserToken

Adds recipients to the recipients and sends them a notification.

URL Parameters

Parameter	Type	Description
id	integer	Document ID

Body Parameters

Key	Type	Description
recipients	integer[]	IDs of members that should receive the document - max. 1000

Error Responses

Status	Description
`404`	Document not found
`422`	Invalid parameters - see Invalid parameters errors model

Example

When successful, returns object containing created document recipients

{
  "document_recipients": [] // List of document recipients - see: 'DocumentRecipient model'
}

Request

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.mpc.dev.placewise.com/v1/operations/documents/1/recipients' \
--header 'X-User-Agent;' \
--header 'X-Product-Name;' \
--header 'X-Loyalty-Club-Slug;' \
--header 'X-Customer;' \
--header 'Authorization;' \
--header 'X-Client-Authorization: '

Responses

🟢200Success

application/json

Body

Example

{}

Modified at 2024-05-07 15:49:13

Update Document

Destroy Document

Add Recipients to the Document

URL Parameters#

Body Parameters#

Error Responses#

Example#

Request

Request Code Samples

Responses

URL Parameters

Body Parameters

Error Responses

Example