Returns list of mailing lists
name | type | description |
---|---|---|
direction | query | |
filter | query | |
nameLike | query | |
orderBy | query | |
page | query | |
project | query | |
project-uuid | query | |
size | query |
media type | data type | description |
---|---|---|
application/json | array of MailingListListRecord (JSON) | list of mailing lists |
GET /mailing-lists
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"name" : "...",
"guid" : "...",
"project" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"recipientCount" : 12345
} ]
Create mailing list
name | type | description |
---|---|---|
project-uuid | query |
media type | data type | description |
---|---|---|
application/json | MailingListRequest (JSON) | specify details for new mailing list |
media type | data type | description |
---|---|---|
application/json | MailingListDetails (JSON) | details for newly created mailing list |
POST /mailing-lists
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"project" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"projectUuid" : "...",
"recipients" : [ "...", "..." ]
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"name" : "...",
"guid" : "...",
"project" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"recipients" : [ "...", "..." ]
}
Returns list of detailed mailing lists
name | type | description |
---|---|---|
direction | query | |
filter | query | |
nameLike | query | |
orderBy | query | |
page | query | |
project | query | |
project-uuid | query | |
size | query |
media type | data type | description |
---|---|---|
application/json | array of MailingListDetails (JSON) | list of detailed mailing lists |
GET /mailing-lists/detailed
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"name" : "...",
"guid" : "...",
"project" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"recipients" : [ "...", "..." ]
} ]
Remove mailing list
name | type | description |
---|---|---|
guid | path | specify local unique identifier for mailing list (use by vProtect) |
DELETE /mailing-lists/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single mailing list
name | type | description |
---|---|---|
guid | path | specify local unique identifier for mailing list (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | MailingListDetails (JSON) | mailing list details |
GET /mailing-lists/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"name" : "...",
"guid" : "...",
"project" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"recipients" : [ "...", "..." ]
}
Change mailing list details.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for mailing list (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | MailingListRequest (JSON) | specify mailing list details to update |
media type | data type | description |
---|---|---|
application/json | MailingListDetails (JSON) | updated details for mailing list |
PUT /mailing-lists/{guid}
Content-Type: application/json
Accept: application/json
{
"name" : "...",
"project" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"projectUuid" : "...",
"recipients" : [ "...", "..." ]
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"name" : "...",
"guid" : "...",
"project" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"recipients" : [ "...", "..." ]
}