RUrunconverge

Update Forwarding Destination

Changed on
patch/forwarding/{id}

Request

  • Base URL
    https://app.runconverge.com/api
  • URL
    https://app.runconverge.com/api/forwarding/{id}
  • Auth
    none declared

Path parameters

idinteger required

Headers

Authorizationstring nullable
X-User-Idstring nullable
X-Posthog-Session-Idstring

Cookies

session_idstring nullable

Request body

namestring nullable
descriptionstring nullable
activeboolean nullable
consent_category'analytics' | 'marketing'
consent_mode'off' | 'pixel_only' | 'on' | 'strict'
destination_mode'both' | 'server'

Defines how a forwarding destination should behave

BOTH: Pixel will be installed. Events will be processed according to the event mapping. SERVER: No pixel will be installed. Only server-side forwarding will take place, according to the event mapping.

Response

Successful Response

idinteger required
activeboolean required
namestring required
descriptionstring nullable required
consent_category'analytics' | 'marketing' required
consent_mode'off' | 'pixel_only' | 'on' | 'strict' required
destination_mode'both' | 'server' required

Defines how a forwarding destination should behave

BOTH: Pixel will be installed. Events will be processed according to the event mapping. SERVER: No pixel will be installed. Only server-side forwarding will take place, according to the event mapping.

created_atstring date-time nullable required
updated_atstring date-time nullable required

Changes

  • 118b0bdc2a6aRevision changes
    • breaking

      added to the ///// response property oneOf list for the response status

    • info

      added $city $country_code $state discriminator mapping keys to the ////// request property

    • info

      added to the ////// request property oneOf list

    • info

      added $city $country_code $state discriminator mapping keys to the ///// response property for the response status

  • 92c0299f97b2Revision changes
    • breaking

      added to the response property oneOf list for the response status

    • info

      added impact discriminator mapping keys to the / request property

    • info

      added to the / request property oneOf list

    • info

      added impact discriminator mapping keys to the response property for the response status