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 MailingListListRecord (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

                
[ {
  "name" : "...",
  "guid" : "...",
  "project" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "recipientCount" : 12345
} ]
                
              

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 MailingListDetails (JSON) details for newly created mailing list

Example

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

                
{
  "name" : "...",
  "project" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "projectUuid" : "...",
  "recipients" : [ "...", "..." ]
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "name" : "...",
  "guid" : "...",
  "project" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "recipients" : [ "...", "..." ]
}
                
              

GET /mailing-lists/detailed

Returns list of detailed 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 MailingListDetails (JSON) list of detailed mailing lists

Example

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

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

                
[ {
  "name" : "...",
  "guid" : "...",
  "project" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "recipients" : [ "...", "..." ]
} ]
                
              

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 MailingListDetails (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

                
{
  "name" : "...",
  "guid" : "...",
  "project" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "recipients" : [ "...", "..." ]
}
                
              

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
Response Body
media type data type description
application/json MailingListDetails (JSON) updated details for mailing list

Example

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

                
{
  "name" : "...",
  "project" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "projectUuid" : "...",
  "recipients" : [ "...", "..." ]
}
                
              
Response
HTTP/1.1 204 No Content
Content-Type: application/json

                
{
  "name" : "...",
  "guid" : "...",
  "project" : {
    "guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
    "name" : "Entity name"
  },
  "recipients" : [ "...", "..." ]
}