Sign in

Update Forwarding Destination

patch/forwarding/{id}

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

No recorded changes to this endpoint across all 1 revision of this API.