AlphaAlpha Docs
API Reference

Recipient Lists

Recipient Lists API

Create a new recipient list

POST
/communications/recipient-lists

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/communications/recipient-lists" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "staticRecipients": [      {        "email": "string",        "metadata": {          "property1": "string",          "property2": "string"        }      }    ],    "tags": [      "string"    ],    "type": "STATIC"  }'
{
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "dynamicQuery": {
    "entityType": "string",
    "filters": {
      "property1": null,
      "property2": null
    }
  },
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "name": "string",
  "staticRecipients": [
    {
      "email": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "name": "string"
    }
  ],
  "tags": [
    "string"
  ],
  "tenantId": "string",
  "type": "STATIC",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Download Csv_ Recipient List

GET
/communications/recipient-lists/csv-export

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/recipient-lists/csv-export"
"string"
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete a list of entities by their IDs

DELETE
/communications/recipient-lists/delete-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids*array<>

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/communications/recipient-lists/delete-list?ids=string"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Dynamic Search_ Recipient List

GET
/communications/recipient-lists/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

search?array<>
filters?array<>
page?integer
Default0
Formatint32
size?integer
Default20
Formatint32
sort?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/recipient-lists/dynamic-search"
{
  "content": [
    {
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "description": "string",
      "dynamicQuery": {
        "entityType": "string",
        "filters": {
          "property1": null,
          "property2": null
        }
      },
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "name": "string",
      "staticRecipients": [
        {
          "email": "string",
          "metadata": {
            "property1": "string",
            "property2": "string"
          },
          "name": "string"
        }
      ],
      "tags": [
        "string"
      ],
      "tenantId": "string",
      "type": "STATIC",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Dynamic Search Post_ Recipient List

POST
/communications/recipient-lists/dynamic-search

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/communications/recipient-lists/dynamic-search" \  -H "Content-Type: application/json" \  -d '{    "filters": {      "property1": null,      "property2": null    },    "page": 0,    "search": [      "string"    ],    "size": 0,    "sort": [      {        "ascending": true,        "field": "string"      }    ]  }'
{
  "content": [
    {
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "description": "string",
      "dynamicQuery": {
        "entityType": "string",
        "filters": {
          "property1": null,
          "property2": null
        }
      },
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "name": "string",
      "staticRecipients": [
        {
          "email": "string",
          "metadata": {
            "property1": "string",
            "property2": "string"
          },
          "name": "string"
        }
      ],
      "tags": [
        "string"
      ],
      "tenantId": "string",
      "type": "STATIC",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by list of ids in current tenant

GET
/communications/recipient-lists/find

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/recipient-lists/find"
[
  {
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "description": "string",
    "dynamicQuery": {
      "entityType": "string",
      "filters": {
        "property1": null,
        "property2": null
      }
    },
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "name": "string",
    "staticRecipients": [
      {
        "email": "string",
        "metadata": {
          "property1": "string",
          "property2": "string"
        },
        "name": "string"
      }
    ],
    "tags": [
      "string"
    ],
    "tenantId": "string",
    "type": "STATIC",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find all for current tenant

GET
/communications/recipient-lists/find-all

Authorization

AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/recipient-lists/find-all"
[
  {
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "description": "string",
    "dynamicQuery": {
      "entityType": "string",
      "filters": {
        "property1": null,
        "property2": null
      }
    },
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "name": "string",
    "staticRecipients": [
      {
        "email": "string",
        "metadata": {
          "property1": "string",
          "property2": "string"
        },
        "name": "string"
      }
    ],
    "tags": [
      "string"
    ],
    "tenantId": "string",
    "type": "STATIC",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find a list of entities by their IDs

GET
/communications/recipient-lists/find-list

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

ids?array<>

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/recipient-lists/find-list"
[
  {
    "created": "2019-08-24T14:15:22Z",
    "createdBy": "string",
    "description": "string",
    "dynamicQuery": {
      "entityType": "string",
      "filters": {
        "property1": null,
        "property2": null
      }
    },
    "events": [
      {
        "authorId": "string",
        "date": "2019-08-24T14:15:22Z",
        "description": "string",
        "id": "string",
        "type": "CREATE"
      }
    ],
    "id": "string",
    "name": "string",
    "staticRecipients": [
      {
        "email": "string",
        "metadata": {
          "property1": "string",
          "property2": "string"
        },
        "name": "string"
      }
    ],
    "tags": [
      "string"
    ],
    "tenantId": "string",
    "type": "STATIC",
    "updated": "2019-08-24T14:15:22Z",
    "updatedBy": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Find by id in current tenant

GET
/communications/recipient-lists/find/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/recipient-lists/find/string"
{
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "dynamicQuery": {
    "entityType": "string",
    "filters": {
      "property1": null,
      "property2": null
    }
  },
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "name": "string",
  "staticRecipients": [
    {
      "email": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "name": "string"
    }
  ],
  "tags": [
    "string"
  ],
  "tenantId": "string",
  "type": "STATIC",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Import recipients from CSV

POST
/communications/recipient-lists/import

Authorization

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/communications/recipient-lists/import" \  -H "Content-Type: application/json" \  -d '{    "csvContent": "string",    "emailColumn": 0,    "hasHeader": true  }'
{
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "dynamicQuery": {
    "entityType": "string",
    "filters": {
      "property1": null,
      "property2": null
    }
  },
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "name": "string",
  "staticRecipients": [
    {
      "email": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "name": "string"
    }
  ],
  "tags": [
    "string"
  ],
  "tenantId": "string",
  "type": "STATIC",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Get page by page number and size with optional sorting based on field to sortBy and direction

GET
/communications/recipient-lists/page

Authorization

AuthorizationBearer <token>

In: header

Query Parameters

pageNumber?integer
Formatint32
pageSize?integer
Formatint32
sortBy?string
direction?string
Value in"ASC" | "DESC"
search?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/recipient-lists/page"
{
  "content": [
    {
      "created": "2019-08-24T14:15:22Z",
      "createdBy": "string",
      "description": "string",
      "dynamicQuery": {
        "entityType": "string",
        "filters": {
          "property1": null,
          "property2": null
        }
      },
      "events": [
        {
          "authorId": "string",
          "date": "2019-08-24T14:15:22Z",
          "description": "string",
          "id": "string",
          "type": "CREATE"
        }
      ],
      "id": "string",
      "name": "string",
      "staticRecipients": [
        {
          "email": "string",
          "metadata": {
            "property1": "string",
            "property2": "string"
          },
          "name": "string"
        }
      ],
      "tags": [
        "string"
      ],
      "tenantId": "string",
      "type": "STATIC",
      "updated": "2019-08-24T14:15:22Z",
      "updatedBy": "string"
    }
  ],
  "empty": true,
  "first": true,
  "last": true,
  "number": 0,
  "numberOfElements": 0,
  "pageable": {
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 0,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 0,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 0,
  "totalPages": 0
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Delete by id in current tenant

DELETE
/communications/recipient-lists/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/communications/recipient-lists/string"
Empty
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Update an existing recipient list

PUT
/communications/recipient-lists/{id}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "http://localhost:18080/api/v1/communications/recipient-lists/string" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "staticRecipients": [      {        "email": "string",        "metadata": {          "property1": "string",          "property2": "string"        }      }    ],    "tags": [      "string"    ],    "type": "STATIC"  }'
{
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "dynamicQuery": {
    "entityType": "string",
    "filters": {
      "property1": null,
      "property2": null
    }
  },
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "name": "string",
  "staticRecipients": [
    {
      "email": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "name": "string"
    }
  ],
  "tags": [
    "string"
  ],
  "tenantId": "string",
  "type": "STATIC",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Add a comment to an entity

POST
/communications/recipient-lists/{id}/comment

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

body*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/communications/recipient-lists/string/comment" \  -H "Content-Type: application/json" \  -d 'string'
{}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Add recipients to a static list

POST
/communications/recipient-lists/{id}/recipients

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:18080/api/v1/communications/recipient-lists/string/recipients" \  -H "Content-Type: application/json" \  -d '{    "recipients": [      {        "email": "string",        "metadata": {          "property1": "string",          "property2": "string"        }      }    ]  }'
{
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "dynamicQuery": {
    "entityType": "string",
    "filters": {
      "property1": null,
      "property2": null
    }
  },
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "name": "string",
  "staticRecipients": [
    {
      "email": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "name": "string"
    }
  ],
  "tags": [
    "string"
  ],
  "tenantId": "string",
  "type": "STATIC",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Remove recipients from a static list

DELETE
/communications/recipient-lists/{id}/recipients

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "http://localhost:18080/api/v1/communications/recipient-lists/string/recipients" \  -H "Content-Type: application/json" \  -d '{    "emails": [      "string"    ]  }'
{
  "created": "2019-08-24T14:15:22Z",
  "createdBy": "string",
  "description": "string",
  "dynamicQuery": {
    "entityType": "string",
    "filters": {
      "property1": null,
      "property2": null
    }
  },
  "events": [
    {
      "authorId": "string",
      "date": "2019-08-24T14:15:22Z",
      "description": "string",
      "id": "string",
      "type": "CREATE"
    }
  ],
  "id": "string",
  "name": "string",
  "staticRecipients": [
    {
      "email": "string",
      "metadata": {
        "property1": "string",
        "property2": "string"
      },
      "name": "string"
    }
  ],
  "tags": [
    "string"
  ],
  "tenantId": "string",
  "type": "STATIC",
  "updated": "2019-08-24T14:15:22Z",
  "updatedBy": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Resolve a list to its recipients

GET
/communications/recipient-lists/{id}/resolve

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "http://localhost:18080/api/v1/communications/recipient-lists/string/resolve"
[
  {
    "email": "string",
    "metadata": {
      "property1": "string",
      "property2": "string"
    },
    "name": "string"
  }
]
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}
{
  "detail": "string",
  "time": "2019-08-24T14:15:22Z",
  "title": "string"
}

Queue Job

Previous Page

Reporting

Next Page