# campaigns

Endpoints for creating and managing campaigns. A campaign represents a distribution of funds to multiple beneficiaries.

## Get Campaigns

 - [GET /v2/campaign-manager/campaigns](https://docs.talli.ai/reference/swagger/campaigns/paths/~1v2~1campaign-manager~1campaigns/get.md): Retrieves a paginated list of campaigns, optionally filtered by a payout instruction ID.
To include details about total funds received and statistics on the statuses of the payout instructions, use 'includeDetails' flag.

## Create Campaign

 - [POST /v2/campaign-manager/campaigns](https://docs.talli.ai/reference/swagger/campaigns/paths/~1v2~1campaign-manager~1campaigns/post.md): Creates a new campaign with the specified data.

## Patch Campaign

 - [PATCH /v2/campaign-manager/campaigns/{id}](https://docs.talli.ai/reference/swagger/campaigns/paths/~1v2~1campaign-manager~1campaigns~1%7Bid%7D/patch.md): Patches an existing campaign with the provided data.
Note: The icon needs to be patched separately.

## Get Campaign

 - [GET /v2/campaign-manager/campaigns/{id}](https://docs.talli.ai/reference/swagger/campaigns/paths/~1v2~1campaign-manager~1campaigns~1%7Bid%7D/get.md): Retrieves a single campaign based on provided identifier

## Patch Campaign icon

 - [PATCH /v2/campaign-manager/campaigns/{id}/campaign-icon](https://docs.talli.ai/reference/swagger/campaigns/paths/~1v2~1campaign-manager~1campaigns~1%7Bid%7D~1campaign-icon/patch.md): Patches an existing campaign with the provided icon file.

## Upload a file with payout instructions

 - [POST /v2/campaign-manager/campaigns/{id}/payout-instructions/:upload](https://docs.talli.ai/reference/swagger/campaigns/paths/~1v2~1campaign-manager~1campaigns~1%7Bid%7D~1payout-instructions~1:upload/post.md): Uploads a file with payout instructions to the given campaign. The maximum size of the file is 262144000 bytes

## Download a sample beneficiaries file

 - [GET /v2/campaign-manager/campaigns/payout-instructions/:get-sample-file](https://docs.talli.ai/reference/swagger/campaigns/paths/~1v2~1campaign-manager~1campaigns~1payout-instructions~1:get-sample-file/get.md): Retrieves a sample beneficiaries file in the expected format

## Send reminders for given campaign

 - [POST /v2/campaign-manager/campaigns/{campaignId}/payout-instructions/:send-reminders](https://docs.talli.ai/reference/swagger/campaigns/paths/~1v2~1campaign-manager~1campaigns~1%7Bcampaignid%7D~1payout-instructions~1:send-reminders/post.md): Sends reminders for a given campaign.
The endpoint allows send reminders either to the specified list of IDs or to payout instructions in the specified statuses.
If neither of the above is specified, reminders will be sent to the payout instructions that have not been excluded, requested or fulfilled.
If the list of ids is specified, you can also schedule the sending window with the 'distributionPeriodInSeconds' parameter.
The schedule window will be automatically calculated based on the number of payout instructions found.

## Set password for given campaign

 - [POST /v2/campaign-manager/campaigns/{campaignId}/:set-password](https://docs.talli.ai/reference/swagger/campaigns/paths/~1v2~1campaign-manager~1campaigns~1%7Bcampaignid%7D~1:set-password/post.md): Allows to set a password for the campaign.
From that moment on, each beneficiary will be asked to enter the password when attempting to redeem funds.
Once set, the password cannot be removed, it can only be changed.