Assign Tags to Mailboxes

This endpoint lets you push an authoritative list of tags onto an existing mailbox (campaign) in Mailivery. All tags you send become the new, definitive set:

Tags not included in the request are removed from the campaign.

New tags present in the body are added.

Use it whenever your product maintains its own label or folder system and you need Mailivery’s mailbox (campaign) record to mirror that taxonomy exactly.

Request essentials

  • Method: PATCH

  • Path: /campaigns/{campaignId}/sync-tags-to-campaign

  • Authentication: Bearer API key

  • Body: a comma‑separated string in the tags field, e.g. "agency123, client-gold, november"

Safe to repeat: If you need to change the warm‑up sending window, use PATCH /campaigns/{campaignId}/update-sending-schedule instead; it provides a dedicated schedule structure.

This endpoint lets you push an authoritative list of tags onto an existing mailbox (campaign) in Mailivery. All tags you send become the new, definitive set:

Tags not included in the request are removed from the campaign.

New tags present in the body are added.

Use it whenever your product maintains its own label or folder system and you need Mailivery’s mailbox (campaign) record to mirror that taxonomy exactly.

Request essentials

  • Method: PATCH
  • Path: /campaigns/{campaignId}/sync-tags
  • Authentication: Bearer API key
  • Body: a JSON array of strings representing the final tag list, e.g. ["agency123", "client-gold", "november"]

Safe to repeat: If you need to change the warm‑up sending window, use PATCH /campaigns/{campaignId}/update-sending-schedule instead; it provides a dedicated schedule structure.

Path Params
integer
required

Campaign Id

Form Data

Please note that

string
required
length ≤ 255

Comma separated string of tags

Headers
string
required

Any Uniquie string, timestap or UUID for Logging

string
required
Defaults to multipart/form-data

Request Content-Type

string
required
Defaults to application/json

Expected Type for response

Response

Language
Credentials
Bearer
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json