API - Corsair

Every snapchat.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Actions

addSegmentUsers

actions.addSegmentUsers Add Segment Users Risk: write

await corsair.snapchat.api.actions.addSegmentUsers({});

Input

Name	Type	Required	Description
`users`	`string[] \| string`	Yes	User identifiers (SHA-256 hashed email, phone, or mobile ad ID)
`segment_id`	`string`	Yes	Unique identifier for segment_id

Output: object

Output full type

{
}

copyMedia

actions.copyMedia Copy Media Risk: write

await corsair.snapchat.api.actions.copyMedia({});

Input

Name	Type	Required	Description
`media_copy`	`object[]`	Yes	Parameter media_copy
`destination_ad_account_id`	`string`	Yes	Unique identifier for destination_ad_account_id

media_copy full type

string | {
} | any[]

Output: object

Output full type

{
}

createAccountRole

actions.createAccountRole Create Account Role Risk: write

await corsair.snapchat.api.actions.createAccountRole({});

Input

Name	Type	Required	Description
`roles`	`object[]`	Yes	Parameter roles
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

roles full type

string | {
} | any[]

Output: object

Output full type

{
}

createAdAccount

actions.createAdAccount Create Ad Account Risk: write

await corsair.snapchat.api.actions.createAdAccount({});

Input

Name	Type	Required	Description
`adaccounts`	`object[]`	Yes	Parameter adaccounts
`organization_id`	`string`	Yes	Unique identifier for organization_id

adaccounts full type

string | {
} | any[]

Output: object

Output full type

{
}

createAdaccountsAudienceSizeV2

actions.createAdaccountsAudienceSizeV2 Create Adaccounts Audience Size V2 Risk: write

await corsair.snapchat.api.actions.createAdaccountsAudienceSizeV2({});

Input

Name	Type	Required	Description
`targeting`	`object`	Yes	Targeting or delivery specification for targeting
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

targeting full type

{
} | string

Output: object

Output full type

{
}

createAdaccountsCreativeElements

actions.createAdaccountsCreativeElements Create Adaccounts Creative Elements Risk: write

await corsair.snapchat.api.actions.createAdaccountsCreativeElements({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	Unique identifier for id
`creative_elements`	`object[]`	Yes	Parameter creative_elements

creative_elements full type

string | {
} | any[]

Output: object

Output full type

{
}

createAdaccountsDynamicTemplates

actions.createAdaccountsDynamicTemplates Create Adaccounts Dynamic Templates Risk: write

await corsair.snapchat.api.actions.createAdaccountsDynamicTemplates({});

Input

Name	Type	Required	Description
`adaccount_id`	`string`	Yes	Unique identifier for adaccount_id
`dynamic_templates`	`object[]`	Yes	Parameter dynamic_templates

dynamic_templates full type

string | {
} | any[]

Output: object

Output full type

{
}

createAdaccountsEventDetails

actions.createAdaccountsEventDetails Create Adaccounts Event Details Risk: write

await corsair.snapchat.api.actions.createAdaccountsEventDetails({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id
`event_details`	`object[]`	Yes	Parameter event_details

event_details full type

string | {
} | any[]

Output: object

Output full type

{
}

createAdaccountsInteractionZones

actions.createAdaccountsInteractionZones Create Adaccounts Interaction Zones Risk: write

await corsair.snapchat.api.actions.createAdaccountsInteractionZones({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id
`interaction_zones`	`object[]`	Yes	Parameter interaction_zones

interaction_zones full type

string | {
} | any[]

Output: object

Output full type

{
}

createAdaccountsOfferDisclaimers

actions.createAdaccountsOfferDisclaimers Create Adaccounts Offer Disclaimers Risk: write

await corsair.snapchat.api.actions.createAdaccountsOfferDisclaimers({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	Unique identifier for id
`offer_disclaimers`	`object[]`	Yes	Parameter offer_disclaimers

offer_disclaimers full type

string | {
} | any[]

Output: object

Output full type

{
}

createAdaccountsReservedForecasting

actions.createAdaccountsReservedForecasting Create Adaccounts Reserved Forecasting Risk: write

await corsair.snapchat.api.actions.createAdaccountsReservedForecasting({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	Unique identifier for id
`end_time`	`string \| Date`	Yes	Timestamp for end_time
`targeting`	`object`	Yes	Targeting or delivery specification for targeting
`start_time`	`string \| Date`	Yes	Timestamp for start_time
`placement_v2`	`object`	Yes	Targeting or delivery specification for placement_v2
`optimization_goal`	`object[]`	Yes	Parameter optimization_goal
`delivery_constraint`	`object`	Yes	Targeting or delivery specification for delivery_constraint
`cap_and_exclusion_config`	`object`	Yes	Targeting or delivery specification for cap_and_exclusion_config

targeting full type

{
} | string

placement_v2 full type

{
} | string

optimization_goal full type

string | {
} | any[]

delivery_constraint full type

{
} | string

cap_and_exclusion_config full type

{
} | string

Output: object

Output full type

{
}

createAdaccountsTargetingInsights

actions.createAdaccountsTargetingInsights Create Adaccounts Targeting Insights Risk: write

await corsair.snapchat.api.actions.createAdaccountsTargetingInsights({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	Unique identifier for id
`base_spec`	`object`	Yes	Targeting or delivery specification for base_spec
`targeting_spec`	`object`	Yes	Targeting or delivery specification for targeting_spec

base_spec full type

{
} | string

targeting_spec full type

{
} | string

Output: object

Output full type

{
}

createAdSquad

actions.createAdSquad Create Ad Squad Risk: write

await corsair.snapchat.api.actions.createAdSquad({});

Input

Name	Type	Required	Description
`adsquads`	`object[]`	Yes	Parameter adsquads
`campaign_id`	`string`	Yes	Unique identifier for campaign_id

adsquads full type

string | {
} | any[]

Output: object

Output full type

{
}

createBillingCenter

actions.createBillingCenter Create Billing Center Risk: write

await corsair.snapchat.api.actions.createBillingCenter({});

Input

Name	Type	Required	Description
`billingcenters`	`object[]`	Yes	Parameter billingcenters
`organization_id`	`string`	Yes	Unique identifier for organization_id

billingcenters full type

string | {
} | any[]

Output: object

Output full type

{
}

createCampaign

actions.createCampaign Create Campaign Risk: write

await corsair.snapchat.api.actions.createCampaign({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	Value for name
`start_time`	`string \| Date`	Yes	Timestamp for start_time
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

createCatalogRole

actions.createCatalogRole Create Catalog Role Risk: write

await corsair.snapchat.api.actions.createCatalogRole({});

Input

Name	Type	Required	Description
`roles`	`object[]`	Yes	Parameter roles
`catalog_id`	`string`	Yes	Unique identifier for catalog_id

roles full type

string | {
} | any[]

Output: object

Output full type

{
}

createCatalogsFacets

actions.createCatalogsFacets Create Catalogs Facets Risk: write

await corsair.snapchat.api.actions.createCatalogsFacets({});

Input

Name	Type	Required	Description
`facets`	`object[]`	Yes	Parameter facets
`catalog_id`	`string`	Yes	Unique identifier for catalog_id

facets full type

string | {
} | any[]

Output: object

Output full type

{
}

createCatalogsFlightsSearch

actions.createCatalogsFlightsSearch Create Catalogs Flights Search Risk: write

await corsair.snapchat.api.actions.createCatalogsFlightsSearch({});

Input

Name	Type	Required	Description
`catalog_id`	`string`	Yes	Unique identifier for catalog_id

Output: object

Output full type

{
}

createCatalogsProductFeeds

actions.createCatalogsProductFeeds Create Catalogs Product Feeds Risk: write

await corsair.snapchat.api.actions.createCatalogsProductFeeds({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	Value for name
`catalog_id`	`string`	Yes	Unique identifier for catalog_id
`default_currency`	`string`	Yes	Value for default_currency

Output: object

Output full type

{
}

createCatalogsProductSets

actions.createCatalogsProductSets Create Catalogs Product Sets Risk: write

await corsair.snapchat.api.actions.createCatalogsProductSets({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	Value for name
`catalog_id`	`string`	Yes	Unique identifier for catalog_id

Output: object

Output full type

{
}

createMedia

actions.createMedia Create Media Risk: write

await corsair.snapchat.api.actions.createMedia({});

Input

Name	Type	Required	Description
`media`	`object[]`	Yes	Parameter media
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

media full type

string | {
} | any[]

Output: object

Output full type

{
}

createOrganizationsCatalogs

actions.createOrganizationsCatalogs Create Organizations Catalogs Risk: write

await corsair.snapchat.api.actions.createOrganizationsCatalogs({});

Input

Name	Type	Required	Description
`catalogs`	`object[]`	Yes	Parameter catalogs
`organization_id`	`string`	Yes	Unique identifier for organization_id

catalogs full type

string | {
} | any[]

Output: object

Output full type

{
}

createOrgRole

actions.createOrgRole Create Org Role Risk: write

await corsair.snapchat.api.actions.createOrgRole({});

Input

Name	Type	Required	Description
`roles`	`object[]`	Yes	Parameter roles
`organization_id`	`string`	Yes	Unique identifier for organization_id

roles full type

string | {
} | any[]

Output: object

Output full type

{
}

createSegment

actions.createSegment Create Segment Risk: write

await corsair.snapchat.api.actions.createSegment({});

Input

Name	Type	Required	Description
`segments`	`object[]`	Yes	Parameter segments
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

segments full type

string | {
} | any[]

Output: object

Output full type

{
}

deleteAdaccountsOfferDisclaimers

actions.deleteAdaccountsOfferDisclaimers Delete Adaccounts Offer Disclaimers Risk: destructive

await corsair.snapchat.api.actions.deleteAdaccountsOfferDisclaimers({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id
`offer_disclaimer_id`	`string`	Yes	Unique identifier for offer_disclaimer_id

Output: object

Output full type

{
}

deleteAdsquads

actions.deleteAdsquads Delete Adsquads Risk: destructive

await corsair.snapchat.api.actions.deleteAdsquads({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	Unique identifier for id

Output: object

Output full type

{
}

deleteAllSegmentUsers

actions.deleteAllSegmentUsers Delete All Segment Users Risk: destructive

await corsair.snapchat.api.actions.deleteAllSegmentUsers({});

Input

Name	Type	Required	Description
`segment_id`	`string`	Yes	Unique identifier for segment_id

Output: object

Output full type

{
}

deleteCampaign

actions.deleteCampaign Delete Campaign Risk: destructive

await corsair.snapchat.api.actions.deleteCampaign({});

Input

Name	Type	Required	Description
`campaign_id`	`string`	Yes	Unique identifier for campaign_id

Output: object

Output full type

{
}

deleteCatalogs

actions.deleteCatalogs Delete Catalogs Risk: destructive

await corsair.snapchat.api.actions.deleteCatalogs({});

Input

Name	Type	Required	Description
`catalog_id`	`string`	Yes	Unique identifier for catalog_id

Output: object

Output full type

{
}

deleteEventDetails

actions.deleteEventDetails Delete Event Details Risk: destructive

await corsair.snapchat.api.actions.deleteEventDetails({});

Input

Name	Type	Required	Description
`event_details_id`	`string`	Yes	Unique identifier for event_details_id

Output: object

Output full type

{
}

deleteMember

actions.deleteMember Delete Member Risk: destructive

await corsair.snapchat.api.actions.deleteMember({});

Input

Name	Type	Required	Description
`member_id`	`string`	Yes	Unique identifier for member_id

Output: object

Output full type

{
}

deleteProductFeeds

actions.deleteProductFeeds Delete Product Feeds Risk: destructive

await corsair.snapchat.api.actions.deleteProductFeeds({});

Input

Name	Type	Required	Description
`product_feed_id`	`string`	Yes	Unique identifier for product_feed_id

Output: object

Output full type

{
}

deleteRole

actions.deleteRole Delete Role Risk: destructive

await corsair.snapchat.api.actions.deleteRole({});

Input

Name	Type	Required	Description
`role_id`	`string`	Yes	Unique identifier for role_id

Output: object

Output full type

{
}

deleteSegment

actions.deleteSegment Delete Segment Risk: destructive

await corsair.snapchat.api.actions.deleteSegment({});

Input

Name	Type	Required	Description
`segment_id`	`string`	Yes	Unique identifier for segment_id

Output: object

Output full type

{
}

deleteSegmentUsers

actions.deleteSegmentUsers Delete Segment Users Risk: destructive

await corsair.snapchat.api.actions.deleteSegmentUsers({});

Input

Name	Type	Required	Description
`users`	`string[] \| string`	Yes	User identifiers (SHA-256 hashed email, phone, or mobile ad ID)
`segment_id`	`string`	Yes	Unique identifier for segment_id

Output: object

Output full type

{
}

getAdAccount

actions.getAdAccount Get Ad Account Risk: read

await corsair.snapchat.api.actions.getAdAccount({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

getAdaccountsAdsquads

actions.getAdaccountsAdsquads Get Adaccounts Adsquads Risk: read

await corsair.snapchat.api.actions.getAdaccountsAdsquads({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

getAdaccountsAdSquadUiRenderData

actions.getAdaccountsAdSquadUiRenderData Get Adaccounts Ad Squad Ui Render Data Risk: read

await corsair.snapchat.api.actions.getAdaccountsAdSquadUiRenderData({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

getAdaccountsDynamicTemplates

actions.getAdaccountsDynamicTemplates Get Adaccounts Dynamic Templates Risk: read

await corsair.snapchat.api.actions.getAdaccountsDynamicTemplates({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

getAdaccountsEventDetails

actions.getAdaccountsEventDetails Get Adaccounts Event Details Risk: read

await corsair.snapchat.api.actions.getAdaccountsEventDetails({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

getAdaccountsInteractionZones

actions.getAdaccountsInteractionZones Get Adaccounts Interaction Zones Risk: read

await corsair.snapchat.api.actions.getAdaccountsInteractionZones({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

getAdAccountsLeadGenerationForms

actions.getAdAccountsLeadGenerationForms Get Ad Accounts Lead Generation Forms Risk: read

await corsair.snapchat.api.actions.getAdAccountsLeadGenerationForms({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

getAdaccountsLeadsReport

actions.getAdaccountsLeadsReport Get Adaccounts Leads Report Risk: read

await corsair.snapchat.api.actions.getAdaccountsLeadsReport({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	Unique identifier for id
`report_run_id`	`string`	Yes	Unique identifier for report_run_id

Output: object

Output full type

{
}

getAdaccountsMobileApps

actions.getAdaccountsMobileApps Get Adaccounts Mobile Apps Risk: read

await corsair.snapchat.api.actions.getAdaccountsMobileApps({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

getAdaccountsOfferDisclaimers

actions.getAdaccountsOfferDisclaimers Get Adaccounts Offer Disclaimers Risk: read

await corsair.snapchat.api.actions.getAdaccountsOfferDisclaimers({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

getAdaccountsSpendGuidance

actions.getAdaccountsSpendGuidance Get Adaccounts Spend Guidance Risk: read

await corsair.snapchat.api.actions.getAdaccountsSpendGuidance({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

getAdAccountsStats

actions.getAdAccountsStats Get Ad Accounts Stats Risk: read

await corsair.snapchat.api.actions.getAdAccountsStats({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

getAdaccountsStatsReport

actions.getAdaccountsStatsReport Get Adaccounts Stats Report Risk: read

await corsair.snapchat.api.actions.getAdaccountsStatsReport({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id
`report_run_id`	`string`	Yes	Unique identifier for report_run_id

Output: object

Output full type

{
}

getAdSquad

actions.getAdSquad Get Ad Squad Risk: read

await corsair.snapchat.api.actions.getAdSquad({});

Input

Name	Type	Required	Description
`ad_squad_id`	`string`	Yes	Unique identifier for ad_squad_id

Output: object

Output full type

{
}

getAdSquadRestrictions

actions.getAdSquadRestrictions Get Ad Squad Restrictions Risk: read

await corsair.snapchat.api.actions.getAdSquadRestrictions({});

Input

Name	Type	Required	Description
`ad_squad_id`	`string`	Yes	Unique identifier for ad_squad_id

Output: object

Output full type

{
}

getAdsquadsAudienceSizeV2

actions.getAdsquadsAudienceSizeV2 Get Adsquads Audience Size V2 Risk: read

await corsair.snapchat.api.actions.getAdsquadsAudienceSizeV2({});

Input

Name	Type	Required	Description
`ad_squad_id`	`string`	Yes	Unique identifier for ad_squad_id

Output: object

Output full type

{
}

getAdsquadsStatsReport

actions.getAdsquadsStatsReport Get Adsquads Stats Report Risk: read

await corsair.snapchat.api.actions.getAdsquadsStatsReport({});

Input

Name	Type	Required	Description
`ad_squad_id`	`string`	Yes	Unique identifier for ad_squad_id
`report_run_id`	`string`	Yes	Unique identifier for report_run_id

Output: object

Output full type

{
}

getAdSquadStats

actions.getAdSquadStats Get Ad Squad Stats Risk: read

await corsair.snapchat.api.actions.getAdSquadStats({});

Input

Name	Type	Required	Description
`ad_squad_id`	`string`	Yes	Unique identifier for ad_squad_id

Output: object

Output full type

{
}

getAdSquadTargeting

actions.getAdSquadTargeting Get Ad Squad Targeting Risk: read

await corsair.snapchat.api.actions.getAdSquadTargeting({});

Input

Name	Type	Required	Description
`ad_squad_id`	`string`	Yes	Unique identifier for ad_squad_id

Output: object

Output full type

{
}

getAdStats

actions.getAdStats Get Ad Stats Risk: read

await corsair.snapchat.api.actions.getAdStats({});

Input

Name	Type	Required	Description
`ad_id`	`string`	Yes	Unique identifier for ad_id

Output: object

Output full type

{
}

getAuthenticatedUser

actions.getAuthenticatedUser Get Authenticated User Risk: read

await corsair.snapchat.api.actions.getAuthenticatedUser({});

Input: empty object Output: object

Output full type

{
}

getBillingCenter

actions.getBillingCenter Get Billing Center Risk: read

await corsair.snapchat.api.actions.getBillingCenter({});

Input

Name	Type	Required	Description
`billing_center_id`	`string`	Yes	Unique identifier for billing_center_id

Output: object

Output full type

{
}

getCampaign

actions.getCampaign Get Campaign Risk: read

await corsair.snapchat.api.actions.getCampaign({});

Input

Name	Type	Required	Description
`campaign_id`	`string`	Yes	Unique identifier for campaign_id

Output: object

Output full type

{
}

getCampaignChangelog

actions.getCampaignChangelog Get Campaign Changelog Risk: read

await corsair.snapchat.api.actions.getCampaignChangelog({});

Input

Name	Type	Required	Description
`campaign_id`	`string`	Yes	Unique identifier for campaign_id

Output: object

Output full type

{
}

getCampaignsByIds

actions.getCampaignsByIds Get Campaigns By Ids Risk: read

await corsair.snapchat.api.actions.getCampaignsByIds({});

Input

Name	Type	Required	Description
`entity_ids`	`string[] \| string`	Yes	List of entity identifiers or single identifier
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

getCampaignStats

actions.getCampaignStats Get Campaign Stats Risk: read

await corsair.snapchat.api.actions.getCampaignStats({});

Input

Name	Type	Required	Description
`campaign_id`	`string`	Yes	Unique identifier for campaign_id

Output: object

Output full type

{
}

getCatalogs

actions.getCatalogs Get Catalogs Risk: read

await corsair.snapchat.api.actions.getCatalogs({});

Input

Name	Type	Required	Description
`catalog_id`	`string`	Yes	Unique identifier for catalog_id

Output: object

Output full type

{
}

getCatalogsProductSets

actions.getCatalogsProductSets Get Catalogs Product Sets Risk: read

await corsair.snapchat.api.actions.getCatalogsProductSets({});

Input

Name	Type	Required	Description
`catalog_id`	`string`	Yes	Unique identifier for catalog_id

Output: object

Output full type

{
}

getDynamicTemplate

actions.getDynamicTemplate Get Dynamic Template Risk: read

await corsair.snapchat.api.actions.getDynamicTemplate({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	Unique identifier for id

Output: object

Output full type

{
}

getDynamicTemplatesExternalChangelogs

actions.getDynamicTemplatesExternalChangelogs Get Dynamic Templates External Changelogs Risk: read

await corsair.snapchat.api.actions.getDynamicTemplatesExternalChangelogs({});

Input

Name	Type	Required	Description
`dynamic_template_id`	`string`	Yes	Unique identifier for dynamic_template_id

Output: object

Output full type

{
}

getEventDetails

actions.getEventDetails Get Event Details Risk: read

await corsair.snapchat.api.actions.getEventDetails({});

Input

Name	Type	Required	Description
`event_details_id`	`string`	Yes	Unique identifier for event_details_id

Output: object

Output full type

{
}

getFundingSource

actions.getFundingSource Get Funding Source Risk: read

await corsair.snapchat.api.actions.getFundingSource({});

Input

Name	Type	Required	Description
`funding_source_id`	`string`	Yes	Unique identifier for funding_source_id

Output: object

Output full type

{
}

getInteractionZone

actions.getInteractionZone Get Interaction Zone Risk: read

await corsair.snapchat.api.actions.getInteractionZone({});

Input

Name	Type	Required	Description
`interaction_zone_id`	`string`	Yes	Unique identifier for interaction_zone_id

Output: object

Output full type

{
}

getInvoice

actions.getInvoice Get Invoice Risk: read

await corsair.snapchat.api.actions.getInvoice({});

Input

Name	Type	Required	Description
`invoice_id`	`string`	Yes	Unique identifier for invoice_id
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

getMedia

actions.getMedia Get Media Risk: read

await corsair.snapchat.api.actions.getMedia({});

Input

Name	Type	Required	Description
`media_id`	`string`	Yes	Unique identifier for media_id

Output: object

Output full type

{
}

getMediaByIds

actions.getMediaByIds Get Media By Ids Risk: read

await corsair.snapchat.api.actions.getMediaByIds({});

Input

Name	Type	Required	Description
`entity_ids`	`string[] \| string`	Yes	List of entity identifiers or single identifier
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

getMediaStats

actions.getMediaStats Get Media Stats Risk: read

await corsair.snapchat.api.actions.getMediaStats({});

Input

Name	Type	Required	Description
`media_id`	`string`	Yes	Unique identifier for media_id

Output: object

Output full type

{
}

getMember

actions.getMember Get Member Risk: read

await corsair.snapchat.api.actions.getMember({});

Input

Name	Type	Required	Description
`member_id`	`string`	Yes	Unique identifier for member_id

Output: object

Output full type

{
}

getOrganization

actions.getOrganization Get Organization Risk: read

await corsair.snapchat.api.actions.getOrganization({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Unique identifier for organization_id

Output: object

Output full type

{
}

getOrganizationsCatalogs

actions.getOrganizationsCatalogs Get Organizations Catalogs Risk: read

await corsair.snapchat.api.actions.getOrganizationsCatalogs({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Unique identifier for organization_id

Output: object

Output full type

{
}

getOrganizationsMobileApps

actions.getOrganizationsMobileApps Get Organizations Mobile Apps Risk: read

await corsair.snapchat.api.actions.getOrganizationsMobileApps({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Unique identifier for organization_id

Output: object

Output full type

{
}

getOrganizationsPublicProfiles

actions.getOrganizationsPublicProfiles Get Organizations Public Profiles Risk: read

await corsair.snapchat.api.actions.getOrganizationsPublicProfiles({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Unique identifier for organization_id

Output: object

Output full type

{
}

getPixels

actions.getPixels Get Pixels Risk: read

await corsair.snapchat.api.actions.getPixels({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

getProductFeeds

actions.getProductFeeds Get Product Feeds Risk: read

await corsair.snapchat.api.actions.getProductFeeds({});

Input

Name	Type	Required	Description
`product_feed_id`	`string`	Yes	Unique identifier for product_feed_id

Output: object

Output full type

{
}

getProductFeedsFeedUploads

actions.getProductFeedsFeedUploads Get Product Feeds Feed Uploads Risk: read

await corsair.snapchat.api.actions.getProductFeedsFeedUploads({});

Input

Name	Type	Required	Description
`product_feed_id`	`string`	Yes	Unique identifier for product_feed_id

Output: object

Output full type

{
}

getProductSets

actions.getProductSets Get Product Sets Risk: read

await corsair.snapchat.api.actions.getProductSets({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	Unique identifier for id

Output: object

Output full type

{
}

getSegment

actions.getSegment Get Segment Risk: read

await corsair.snapchat.api.actions.getSegment({});

Input

Name	Type	Required	Description
`segment_id`	`string`	Yes	Unique identifier for segment_id

Output: object

Output full type

{
}

getTargetingCarriers

actions.getTargetingCarriers Get Targeting Carriers Risk: read

await corsair.snapchat.api.actions.getTargetingCarriers({});

Input

Name	Type	Required	Description
`country_code`	`string`	Yes	Value for country_code

Output: object

Output full type

{
}

getTargetingConnectionTypes

actions.getTargetingConnectionTypes Get Targeting Connection Types Risk: read

await corsair.snapchat.api.actions.getTargetingConnectionTypes({});

Input

Name	Type	Required	Description
`country_code`	`string`	Yes	Value for country_code

Output: object

Output full type

{
}

getTargetingDemographicsAdvancedDemographics

actions.getTargetingDemographicsAdvancedDemographics Get Targeting Demographics Advanced Demographics Risk: read

await corsair.snapchat.api.actions.getTargetingDemographicsAdvancedDemographics({});

Input

Name	Type	Required	Description
`country_code`	`string`	Yes	Value for country_code

Output: object

Output full type

{
}

getTargetingDemographicsAgeGroup

actions.getTargetingDemographicsAgeGroup Get Targeting Demographics Age Group Risk: read

await corsair.snapchat.api.actions.getTargetingDemographicsAgeGroup({});

Input

Name	Type	Required	Description
`country_code`	`string`	Yes	Value for country_code

Output: object

Output full type

{
}

getTargetingDemographicsGender

actions.getTargetingDemographicsGender Get Targeting Demographics Gender Risk: read

await corsair.snapchat.api.actions.getTargetingDemographicsGender({});

Input

Name	Type	Required	Description
`country_code`	`string`	Yes	Value for country_code

Output: object

Output full type

{
}

getTargetingDemographicsLanguages

actions.getTargetingDemographicsLanguages Get Targeting Demographics Languages Risk: read

await corsair.snapchat.api.actions.getTargetingDemographicsLanguages({});

Input

Name	Type	Required	Description
`country_code`	`string`	Yes	Value for country_code

Output: object

Output full type

{
}

getTargetingDeviceIosOsVersion

actions.getTargetingDeviceIosOsVersion Get Targeting Device Ios Os Version Risk: read

await corsair.snapchat.api.actions.getTargetingDeviceIosOsVersion({});

Input

Name	Type	Required	Description
`country_code`	`string`	Yes	Value for country_code

Output: object

Output full type

{
}

getTargetingDeviceMarketingNames

actions.getTargetingDeviceMarketingNames Get Targeting Device Marketing Names Risk: read

await corsair.snapchat.api.actions.getTargetingDeviceMarketingNames({});

Input

Name	Type	Required	Description
`country_code`	`string`	Yes	Value for country_code

Output: object

Output full type

{
}

getTargetingGeoPostalCode

actions.getTargetingGeoPostalCode Get Targeting Geo Postal Code Risk: read

await corsair.snapchat.api.actions.getTargetingGeoPostalCode({});

Input

Name	Type	Required	Description
`country_code`	`string`	Yes	Value for country_code

Output: object

Output full type

{
}

getTargetingGeoRegion

actions.getTargetingGeoRegion Get Targeting Geo Region Risk: read

await corsair.snapchat.api.actions.getTargetingGeoRegion({});

Input

Name	Type	Required	Description
`country_code`	`string`	Yes	Value for country_code

Output: object

Output full type

{
}

getTargetingGeoUsPostalCode

actions.getTargetingGeoUsPostalCode Get Targeting Geo Us Postal Code Risk: read

await corsair.snapchat.api.actions.getTargetingGeoUsPostalCode({});

Input: empty object Output: object

Output full type

{
}

getTargetingGeoUsRegion

actions.getTargetingGeoUsRegion Get Targeting Geo Us Region Risk: read

await corsair.snapchat.api.actions.getTargetingGeoUsRegion({});

Input: empty object Output: object

Output full type

{
}

getTargetingInterestsDlxc

actions.getTargetingInterestsDlxc Get Targeting Interests Dlxc Risk: read

await corsair.snapchat.api.actions.getTargetingInterestsDlxc({});

Input: empty object Output: object

Output full type

{
}

getTargetingInterestsDlxp

actions.getTargetingInterestsDlxp Get Targeting Interests Dlxp Risk: read

await corsair.snapchat.api.actions.getTargetingInterestsDlxp({});

Input: empty object Output: object

Output full type

{
}

getTargetingInterestsDlxs

actions.getTargetingInterestsDlxs Get Targeting Interests Dlxs Risk: read

await corsair.snapchat.api.actions.getTargetingInterestsDlxs({});

Input: empty object Output: object

Output full type

{
}

getTargetingInterestsNln

actions.getTargetingInterestsNln Get Targeting Interests Nln Risk: read

await corsair.snapchat.api.actions.getTargetingInterestsNln({});

Input: empty object Output: object

Output full type

{
}

getTargetingInterestsPlc

actions.getTargetingInterestsPlc Get Targeting Interests Plc Risk: read

await corsair.snapchat.api.actions.getTargetingInterestsPlc({});

Input

Name	Type	Required	Description
`country_code`	`string`	Yes	Value for country_code

Output: object

Output full type

{
}

getTargetingLocationCategoriesLoi

actions.getTargetingLocationCategoriesLoi Get Targeting Location Categories Loi Risk: read

await corsair.snapchat.api.actions.getTargetingLocationCategoriesLoi({});

Input

Name	Type	Required	Description
`country_code`	`string`	Yes	Value for country_code

Output: object

Output full type

{
}

getTargetingMetros

actions.getTargetingMetros Get Targeting Metros Risk: read

await corsair.snapchat.api.actions.getTargetingMetros({});

Input

Name	Type	Required	Description
`country_code`	`string`	Yes	Value for country_code

Output: object

Output full type

{
}

getTargetingOsTypes

actions.getTargetingOsTypes Get Targeting Os Types Risk: read

await corsair.snapchat.api.actions.getTargetingOsTypes({});

Input: empty object Output: object

Output full type

{
}

getTargetingOsVersions

actions.getTargetingOsVersions Get Targeting Os Versions Risk: read

await corsair.snapchat.api.actions.getTargetingOsVersions({});

Input: empty object Output: object

Output full type

{
}

getTargetingV1InterestsScLs

actions.getTargetingV1InterestsScLs Get Targeting V1 Interests Sc Ls Risk: read

await corsair.snapchat.api.actions.getTargetingV1InterestsScLs({});

Input

Name	Type	Required	Description
`country_code`	`string`	Yes	Value for country_code

Output: object

Output full type

{
}

getTargetingV1InterestsShp

actions.getTargetingV1InterestsShp Get Targeting V1 Interests Shp Risk: read

await corsair.snapchat.api.actions.getTargetingV1InterestsShp({});

Input

Name	Type	Required	Description
`country_code`	`string`	Yes	Value for country_code

Output: object

Output full type

{
}

getTargetingV1InterestsVac

actions.getTargetingV1InterestsVac Get Targeting V1 Interests Vac Risk: read

await corsair.snapchat.api.actions.getTargetingV1InterestsVac({});

Input: empty object Output: object

Output full type

{
}

getTargetingV1Options

actions.getTargetingV1Options Get Targeting V1 Options Risk: read

await corsair.snapchat.api.actions.getTargetingV1Options({});

Input: empty object Output: object

Output full type

{
}

listAccountRoles

actions.listAccountRoles List Account Roles Risk: read

await corsair.snapchat.api.actions.listAccountRoles({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

listAdAccounts

actions.listAdAccounts List Ad Accounts Risk: read

await corsair.snapchat.api.actions.listAdAccounts({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Unique identifier for organization_id

Output: object

Output full type

{
}

listAdsByAccount

actions.listAdsByAccount List Ads By Account Risk: read

await corsair.snapchat.api.actions.listAdsByAccount({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

listAdsByAdSquad

actions.listAdsByAdSquad List Ads By Ad Squad Risk: read

await corsair.snapchat.api.actions.listAdsByAdSquad({});

Input

Name	Type	Required	Description
`ad_squad_id`	`string`	Yes	Unique identifier for ad_squad_id

Output: object

Output full type

{
}

listAdsByCampaign

actions.listAdsByCampaign List Ads By Campaign Risk: read

await corsair.snapchat.api.actions.listAdsByCampaign({});

Input

Name	Type	Required	Description
`campaign_id`	`string`	Yes	Unique identifier for campaign_id

Output: object

Output full type

{
}

listAdSquads

actions.listAdSquads List Ad Squads Risk: read

await corsair.snapchat.api.actions.listAdSquads({});

Input

Name	Type	Required	Description
`campaign_id`	`string`	Yes	Unique identifier for campaign_id

Output: object

Output full type

{
}

listBillingCenters

actions.listBillingCenters List Billing Centers Risk: read

await corsair.snapchat.api.actions.listBillingCenters({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Unique identifier for organization_id

Output: object

Output full type

{
}

listCampaigns

actions.listCampaigns List Campaigns Risk: read

await corsair.snapchat.api.actions.listCampaigns({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

listCatalogRoles

actions.listCatalogRoles List Catalog Roles Risk: read

await corsair.snapchat.api.actions.listCatalogRoles({});

Input

Name	Type	Required	Description
`catalog_id`	`string`	Yes	Unique identifier for catalog_id

Output: object

Output full type

{
}

listCreatives

actions.listCreatives List Creatives Risk: read

await corsair.snapchat.api.actions.listCreatives({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

listFundingSources

actions.listFundingSources List Funding Sources Risk: read

await corsair.snapchat.api.actions.listFundingSources({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Unique identifier for organization_id

Output: object

Output full type

{
}

listInvoices

actions.listInvoices List Invoices Risk: read

await corsair.snapchat.api.actions.listInvoices({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

listMedia

actions.listMedia List Media Risk: read

await corsair.snapchat.api.actions.listMedia({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

listMemberRoles

actions.listMemberRoles List Member Roles Risk: read

await corsair.snapchat.api.actions.listMemberRoles({});

Input

Name	Type	Required	Description
`member_id`	`string`	Yes	Unique identifier for member_id

Output: object

Output full type

{
}

listMembers

actions.listMembers List Members Risk: read

await corsair.snapchat.api.actions.listMembers({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Unique identifier for organization_id

Output: object

Output full type

{
}

listOrganizations

actions.listOrganizations List Organizations Risk: read

await corsair.snapchat.api.actions.listOrganizations({});

Input: empty object Output: object

Output full type

{
}

listOrgPixels

actions.listOrgPixels List Org Pixels Risk: read

await corsair.snapchat.api.actions.listOrgPixels({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Unique identifier for organization_id

Output: object

Output full type

{
}

listOrgRoles

actions.listOrgRoles List Org Roles Risk: read

await corsair.snapchat.api.actions.listOrgRoles({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Unique identifier for organization_id

Output: object

Output full type

{
}

listPhoneNumbers

actions.listPhoneNumbers List Phone Numbers Risk: read

await corsair.snapchat.api.actions.listPhoneNumbers({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

listSegments

actions.listSegments List Segments Risk: read

await corsair.snapchat.api.actions.listSegments({});

Input

Name	Type	Required	Description
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

listSponsoredContent

actions.listSponsoredContent List Sponsored Content Risk: read

await corsair.snapchat.api.actions.listSponsoredContent({});

Input: empty object Output: object

Output full type

{
}

listTransactions

actions.listTransactions List Transactions Risk: read

await corsair.snapchat.api.actions.listTransactions({});

Input

Name	Type	Required	Description
`organization_id`	`string`	Yes	Unique identifier for organization_id

Output: object

Output full type

{
}

searchAdsLibrarySponsoredContent

actions.searchAdsLibrarySponsoredContent Search Ads Library Sponsored Content Risk: read

await corsair.snapchat.api.actions.searchAdsLibrarySponsoredContent({});

Input

Name	Type	Required	Description
`creator_name`	`string`	Yes	Value for creator_name

Output: object

Output full type

{
}

searchCatalogProducts

actions.searchCatalogProducts Search Catalog Products Risk: read

await corsair.snapchat.api.actions.searchCatalogProducts({});

Input

Name	Type	Required	Description
`catalog_id`	`string`	Yes	Unique identifier for catalog_id

Output: object

Output full type

{
}

searchCatalogsHotels

actions.searchCatalogsHotels Search Catalogs Hotels Risk: read

await corsair.snapchat.api.actions.searchCatalogsHotels({});

Input

Name	Type	Required	Description
`catalog_id`	`string`	Yes	Unique identifier for catalog_id

Output: object

Output full type

{
}

updateAdAccount

actions.updateAdAccount Update Ad Account Risk: write

await corsair.snapchat.api.actions.updateAdAccount({});

Input

Name	Type	Required	Description
`adaccounts`	`object[]`	Yes	Parameter adaccounts
`organization_id`	`string`	Yes	Unique identifier for organization_id

adaccounts full type

string | {
} | any[]

Output: object

Output full type

{
}

updateAdSquad

actions.updateAdSquad Update Ad Squad Risk: write

await corsair.snapchat.api.actions.updateAdSquad({});

Input

Name	Type	Required	Description
`adsquads`	`object[]`	Yes	Parameter adsquads
`campaign_id`	`string`	Yes	Unique identifier for campaign_id

adsquads full type

string | {
} | any[]

Output: object

Output full type

{
}

updateBillingCenter

actions.updateBillingCenter Update Billing Center Risk: write

await corsair.snapchat.api.actions.updateBillingCenter({});

Input

Name	Type	Required	Description
`billingcenters`	`object[]`	Yes	Parameter billingcenters
`organization_id`	`string`	Yes	Unique identifier for organization_id

billingcenters full type

string | {
} | any[]

Output: object

Output full type

{
}

updateCampaign

actions.updateCampaign Update Campaign Risk: write

await corsair.snapchat.api.actions.updateCampaign({});

Input

Name	Type	Required	Description
`campaign_id`	`string`	Yes	Unique identifier for campaign_id
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

Output: object

Output full type

{
}

updateSegment

actions.updateSegment Update Segment Risk: write

await corsair.snapchat.api.actions.updateSegment({});

Input

Name	Type	Required	Description
`segments`	`object[]`	Yes	Parameter segments
`ad_account_id`	`string`	Yes	Unique identifier for ad_account_id

segments full type

string | {
} | any[]

Output: object

Output full type

{
}

uploadMediaMultipart

actions.uploadMediaMultipart Upload Media Multipart Risk: write

await corsair.snapchat.api.actions.uploadMediaMultipart({});

Input

Name	Type	Required	Description
`media_id`	`string`	Yes	Unique identifier for media_id

Output: object

Output full type

{
}

validateConversionEvent

actions.validateConversionEvent Validate Conversion Event Risk: write

await corsair.snapchat.api.actions.validateConversionEvent({});

Input

Name	Type	Required	Description
`events`	`object`	Yes	Conversion events array, object, or string to validate
`pixel_id`	`string`	Yes	Unique identifier for pixel_id

events full type

{
}[] | {
} | string

Output: object

Output full type

{
}

​Actions

​addSegmentUsers

​copyMedia

​createAccountRole

​createAdAccount

​createAdaccountsAudienceSizeV2

​createAdaccountsCreativeElements

​createAdaccountsDynamicTemplates

​createAdaccountsEventDetails

​createAdaccountsInteractionZones

​createAdaccountsOfferDisclaimers

​createAdaccountsReservedForecasting

​createAdaccountsTargetingInsights

​createAdSquad

​createBillingCenter

​createCampaign

​createCatalogRole

​createCatalogsFacets

​createCatalogsFlightsSearch

​createCatalogsProductFeeds

​createCatalogsProductSets

​createMedia

​createOrganizationsCatalogs

​createOrgRole

​createSegment

​deleteAdaccountsOfferDisclaimers

​deleteAdsquads

​deleteAllSegmentUsers

​deleteCampaign

​deleteCatalogs

​deleteEventDetails

​deleteMember

​deleteProductFeeds

​deleteRole

​deleteSegment

​deleteSegmentUsers

​getAdAccount

​getAdaccountsAdsquads

​getAdaccountsAdSquadUiRenderData

​getAdaccountsDynamicTemplates

​getAdaccountsEventDetails

​getAdaccountsInteractionZones

​getAdAccountsLeadGenerationForms

​getAdaccountsLeadsReport

​getAdaccountsMobileApps

​getAdaccountsOfferDisclaimers

​getAdaccountsSpendGuidance

​getAdAccountsStats

​getAdaccountsStatsReport

​getAdSquad

​getAdSquadRestrictions

​getAdsquadsAudienceSizeV2

​getAdsquadsStatsReport

​getAdSquadStats

​getAdSquadTargeting

​getAdStats

​getAuthenticatedUser

​getBillingCenter

​getCampaign

​getCampaignChangelog

​getCampaignsByIds

​getCampaignStats

​getCatalogs

​getCatalogsProductSets

​getDynamicTemplate

​getDynamicTemplatesExternalChangelogs

​getEventDetails

​getFundingSource

​getInteractionZone

​getInvoice

​getMedia

​getMediaByIds

​getMediaStats

​getMember

​getOrganization

​getOrganizationsCatalogs

​getOrganizationsMobileApps

​getOrganizationsPublicProfiles

​getPixels

​getProductFeeds

Actions

addSegmentUsers

copyMedia

createAccountRole

createAdAccount

createAdaccountsAudienceSizeV2

createAdaccountsCreativeElements

createAdaccountsDynamicTemplates

createAdaccountsEventDetails

createAdaccountsInteractionZones

createAdaccountsOfferDisclaimers

createAdaccountsReservedForecasting

createAdaccountsTargetingInsights

createAdSquad

createBillingCenter

createCampaign

createCatalogRole

createCatalogsFacets

createCatalogsFlightsSearch

createCatalogsProductFeeds

createCatalogsProductSets

createMedia

createOrganizationsCatalogs

createOrgRole

createSegment

deleteAdaccountsOfferDisclaimers

deleteAdsquads

deleteAllSegmentUsers

deleteCampaign

deleteCatalogs

deleteEventDetails

deleteMember

deleteProductFeeds

deleteRole

deleteSegment

deleteSegmentUsers

getAdAccount

getAdaccountsAdsquads

getAdaccountsAdSquadUiRenderData

getAdaccountsDynamicTemplates

getAdaccountsEventDetails

getAdaccountsInteractionZones

getAdAccountsLeadGenerationForms

getAdaccountsLeadsReport

getAdaccountsMobileApps

getAdaccountsOfferDisclaimers

getAdaccountsSpendGuidance

getAdAccountsStats

getAdaccountsStatsReport

getAdSquad

getAdSquadRestrictions

getAdsquadsAudienceSizeV2

getAdsquadsStatsReport

getAdSquadStats

getAdSquadTargeting

getAdStats

getAuthenticatedUser

getBillingCenter

getCampaign

getCampaignChangelog

getCampaignsByIds

getCampaignStats

getCatalogs

getCatalogsProductSets

getDynamicTemplate

getDynamicTemplatesExternalChangelogs

getEventDetails

getFundingSource

getInteractionZone

getInvoice

getMedia

getMediaByIds

getMediaStats

getMember

getOrganization

getOrganizationsCatalogs

getOrganizationsMobileApps

getOrganizationsPublicProfiles

getPixels

getProductFeeds