SUsuperwall
Campaigns V2

Add Placement

Changed on

Adds a new placement to a campaign. Requires campaigns:write scope.

post/v2/campaigns/{id}/placements

Request

  • Base URL
    https://api.superwall.com
  • URL
    https://api.superwall.com/v2/campaigns/{id}/placements
  • Auth
    • HTTP bearer
    • or API key in cookie accounts_superwall_token
    • or HTTP bearer

Path parameters

idstring required

Request body

event_namestring required

Event name that triggers this placement

enabledboolean

Whether this placement is enabled. Defaults to true

remove_from_other_campaignsboolean

If true and this event name exists in another campaign, move it to this campaign. If false and event exists elsewhere, returns a conflict error

delivery_mode'EMBEDDED' | 'HOSTED'

Where this placement's paywall renders: HOSTED = a link on the Superwall subdomain, EMBEDDED = Web SDK iframe on your own site. Omit to default from the application platform (Stripe → HOSTED, webapp → EMBEDDED). Rejected for native applications. $-prefixed names require HOSTED.

Response

Success

idstring required
object'placement' required

Object type, always placement

event_namestring required

Event name that triggers this placement

enabledboolean required

Whether this placement is enabled

delivery_mode'EMBEDDED' | 'HOSTED' nullable

Where this placement's paywall renders. HOSTED = a link on the Superwall subdomain; EMBEDDED = Web SDK iframe on your own site (an in-app placement). Null means unauthored: the runtime resolves it from the application. Web applications only.

Changes

  • 778a11cd2c15Revision changes
    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • warning

      added the new credentials_missing enum value to the / response property for the response status

    • info

      added subschema #1 subschema #2 to the response body anyOf list for the response status

    • info

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 to the response body anyOf list for the response status

    • info

      added subschema #2 subschema #3 to the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response body anyOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 from the response body anyOf list for the response status

    • info

      removed subschema #2 subschema #3 from the response body anyOf list for the response status

  • 7b4c0e9ccb3aRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status