API reference
Campaigns API
One-off email and SMS sends: the campaign, its messages, its audience and when it goes out.
Endpoints
- POSTCopy a campaign audience/api/campaign-audience-clone
- POSTCreate a campaign audience/api/campaign-audiences
- POSTCopy a campaign/api/campaign-clone
- POSTGive a campaign message its own copy of a template/api/campaign-message-assign-template
- POSTCopy a campaign message to an audience/api/campaign-message-clone
- POSTSchedule a campaign message/api/campaign-message-schedule
- GETList campaign messages/api/campaign-messages
- POSTCreate a campaign message/api/campaign-messages
- POSTStart a recipient estimate for a campaign/api/campaign-recipient-estimation-jobs
- POSTSend a campaign/api/campaign-send-jobs
- POSTAdd a variation to a campaign message/api/campaign-variations
- GETList campaigns/api/campaigns
- POSTCreate a campaign/api/campaigns
- GETGet a campaign audience/api/campaign-audiences/{id}
- PATCHUpdate a campaign audience/api/campaign-audiences/{id}
- DELDelete a campaign audience/api/campaign-audiences/{id}
- PATCHCancel a scheduled message or return it to draft/api/campaign-message-schedule/{id}
- GETGet a campaign message/api/campaign-messages/{id}
- PATCHUpdate a campaign message/api/campaign-messages/{id}
- DELDelete a campaign message/api/campaign-messages/{id}
- GETGet a recipient estimate job/api/campaign-recipient-estimation-jobs/{id}
- GETGet a campaign's estimated recipients/api/campaign-recipient-estimations/{id}
- GETGet a campaign's send job/api/campaign-send-jobs/{id}
- PATCHCancel a campaign's send or return it to draft/api/campaign-send-jobs/{id}
- GETGet a campaign variation/api/campaign-variations/{id}
- PATCHUpdate a campaign variation/api/campaign-variations/{id}
- DELDelete a campaign variation/api/campaign-variations/{id}
- GETGet a campaign/api/campaigns/{id}
- PATCHUpdate a campaign/api/campaigns/{id}
- DELDelete a campaign/api/campaigns/{id}
- GETGet an audience's campaign/api/campaign-audiences/{id}/campaign
- GETGet an audience's messages/api/campaign-audiences/{id}/campaign-messages
- GETGet a message's campaign/api/campaign-messages/{id}/campaign
- GETGet a message's audience/api/campaign-messages/{id}/campaign-audience
- GETGet a message's variations/api/campaign-messages/{id}/campaign-variations
- GETGet a message's image/api/campaign-messages/{id}/image
- GETGet a message's tags (its campaign's)/api/campaign-messages/{id}/tags
- GETGet a message's template/api/campaign-messages/{id}/template
- GETGet a variation's message/api/campaign-variations/{id}/campaign-message
- GETGet a variation's image/api/campaign-variations/{id}/image
- GETGet a variation's translation/api/campaign-variations/{id}/translation
- GETGet a campaign's audiences/api/campaigns/{id}/campaign-audiences
- GETGet a campaign's messages/api/campaigns/{id}/campaign-messages
- GETGet a campaign's tags/api/campaigns/{id}/tags
- GETGet an audience's campaign id/api/campaign-audiences/{id}/relationships/campaign
- GETGet an audience's message ids/api/campaign-audiences/{id}/relationships/campaign-messages
- GETGet a message's campaign id/api/campaign-messages/{id}/relationships/campaign
- GETGet a message's audience id/api/campaign-messages/{id}/relationships/campaign-audience
- GETGet a message's variation ids/api/campaign-messages/{id}/relationships/campaign-variations
- GETGet a message's image id/api/campaign-messages/{id}/relationships/image
- PATCHSet a message's image/api/campaign-messages/{id}/relationships/image
- GETGet a message's tag ids (its campaign's)/api/campaign-messages/{id}/relationships/tags
- GETGet a message's template id/api/campaign-messages/{id}/relationships/template
- GETGet a variation's message id/api/campaign-variations/{id}/relationships/campaign-message
- GETGet a variation's image id/api/campaign-variations/{id}/relationships/image
- GETGet a variation's translation id/api/campaign-variations/{id}/relationships/translation
- GETGet a campaign's audience ids/api/campaigns/{id}/relationships/campaign-audiences
- GETGet a campaign's message ids/api/campaigns/{id}/relationships/campaign-messages
- GETGet a campaign's tag ids/api/campaigns/{id}/relationships/tags
Access
A private key with these scopes reaches every endpoint here. Each endpoint page lists the scopes it needs.
campaigns:readcampaigns:writeimages:readtags:readtemplates:readCoverage
59 of the 59 operations in this area of Klaviyo's API are built here.
Complete
Every operation in this area of Klaviyo's API is built.