« Back to Documentation Overview

delete_campaign_domain

Section: Campaigns
Version: 1.5.0


Detach account domain from campaign. Unassigned domain will no longer be used in links in messages sent from this campaign.

Hint: This does not delete domain from account. Domain is still visible in get_account domain result.

Warning: Any messages sent from now on from this campaign will not use this domain in links, even if message was scheduled before domain assignment was deleted.


Parameters
stringAPI_KEY
object
stringcampaignCAMPAIGN_ID
Return Value
integerupdated1

Example Request JSON

[
    "API_KEY",
    {
        "campaign": "CAMPAIGN_ID"
    }
]

Example Response JSON

{
    "updated": 1
}

Example Error Response JSON

{
    "code": -1,
    "message": "Missing campaign"
}
Method-specific Errors
Missing campaign
API-wide Errors
API key verification failed API key verification failed
API client IP not allowed API client IP not allowed
Invalid params Attribute params must be reference to hash