Campaigns

Update campaign goal

Changed on

Replaces the editable configuration for an existing email-campaign goal. SMS campaigns are not supported.

patch/campaigns/{campaignId}/goals/{goalId}

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/campaigns/{campaignId}/goals/{goalId}
  • Auth
    HTTP bearer

Path parameters

campaignIdstring required
goalIdstring required

Request body

namestring
descriptionstring nullable
triggerType'event' | 'attribute_change' | 'tag_added'
triggerEventNamestring nullable
triggerTagNamestring nullable
attributePathstring nullable
attributeCondition'changed' | 'changed_to' | 'changed_from_to' | 'null' nullable
attributeValuestring nullable
attributePreviousValuestring nullable
eventPropertyNamestring nullable
eventPropertyLabelstring nullable
attributionWindowHoursinteger
isActiveboolean

Response

Campaign goal updated successfully

successboolean

Changes

  • db3873ca3d4dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • f1d8cfd9faafRevision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • warning

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

    • info

      added the new undefined enum value to the request property