Mailing List Controller Resource

GET /mailing-lists

Returns list of mailing lists

Request Parameters
name type description
direction query
filter query
nameLike query
orderBy query
page query
project query
project-uuid query
size query
Response Body
media type data type description
application/json array of MailingListListRecordDto (JSON) list of mailing lists

Example

Request
GET /mailing-lists
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
[ { } ]

POST /mailing-lists

Create mailing list

Request Parameters
name type description
project-uuid query
Request Body
media type data type description
application/json MailingListRequest (JSON) specify details for new mailing list
Response Body
media type data type description
application/json ObjectCreationResponseDto (JSON) details for newly created mailing list

Example

Request
POST /mailing-lists
Content-Type: application/json
Accept: application/json

                
{ }
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{ }

DELETE /mailing-lists/{guid}

Remove mailing list

Request Parameters
name type description
guid path specify local unique identifier for mailing list (use by vProtect)

Example

Request
DELETE /mailing-lists/{guid}
Content-Type: */*

                
...
Response
HTTP/1.1 204 No Content

GET /mailing-lists/{guid}

Get a single mailing list

Request Parameters
name type description
guid path specify local unique identifier for mailing list (use by vProtect)
Response Body
media type data type description
application/json MailingListDetailsDto (JSON) mailing list details

Example

Request
GET /mailing-lists/{guid}
Content-Type: */*
Accept: application/json

                
...
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{ }

PUT /mailing-lists/{guid}

Change mailing list details.

Request Parameters
name type description
guid path specify local unique identifier for mailing list (use by vProtect)
Request Body
media type data type description
application/json MailingListRequest (JSON) specify mailing list details to update

Example

Request
PUT /mailing-lists/{guid}
Content-Type: application/json

                
{ }
Response
HTTP/1.1 204 No Content