SUsuperwall
Campaigns V2

Update Campaign

Changed on

Updates a campaign's description or notes. Requires campaigns:write scope.

patch/v2/campaigns/{id}

Request

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

Path parameters

idstring required

Request body

descriptionstring

Description of the campaign

notesstring nullable

Internal notes about the campaign

delivery_mode'EMBEDDED' | 'HOSTED' nullable

Deprecated and ignored. Delivery mode lives on each placement; set it through the placement endpoints.

Response

Success

idstring required
object'campaign' required

Object type, always campaign

application_idstring required
descriptionstring required

Description of the campaign

notesstring nullable required

Internal notes about the campaign

is_legacyboolean required

Whether this is a legacy campaign

is_prioritizedboolean required

Whether this campaign is prioritized for config preloading. At most one campaign per application may be prioritized.

delivery_mode'EMBEDDED' | 'HOSTED' nullable required

Deprecated, always null. Delivery mode lives on each placement.

created_atstring required

ISO 8601 timestamp of when the campaign was created

updated_atstring required

ISO 8601 timestamp of when the campaign was last updated

archivedboolean required

Whether the campaign is archived

can_reset_assignmentsboolean

Whether the caller may reset audience assignments. Included on a retrieved campaign.

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

      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

  • bfb85c07a3d3Revision changes
    • info

      added the optional property to the response with the status