Skip to navigation
Custom EventsUpdate a custom event

Update a custom event

Pre-release

Updates the name or the post filters of a custom event. Send only the fields you want to change, and the others keep their values. To remove all post filters, send an empty post_filter_properties array. A request with neither field returns the custom event unchanged.

Each post filter property must be one that the custom event’s template lists in post_filter_properties.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

custom_event_idstringRequired

Request

This endpoint expects an object.
post_filter_propertieslist of objectsOptional

Device targeting of this custom event, from the template’s post_filter_properties. Replaces the existing post filters. Each coverage policy, service profile, and tag ID must belong to your organization.

namestringOptional

Response

organisationobject
templateobject
configuration_propertieslist of objects
idstring
descriptionstring
The template's description, or an empty string if the template is turned off.
translation_key_namestring
Portal translation key of the template's name, or an empty string if the template is turned off.
translation_key_descriptionstring
Portal translation key of the template's description, or an empty string if the template is turned off.
supported_targeting_parameterslist of objects
namestringOptional
post_filter_propertieslist of objectsOptional

Device targeting of this custom event, from the template’s post_filter_properties.

supported_action_idslist of stringsOptional

Action IDs this event declares support for, used to decide which actions are offered for it.

  • Field absent: no restriction is declared, so every action whose required_event_output_parameters the event emits is offered.
  • Empty array: a declaration in its own right, so no actions are offered.
  • Non-empty list: intersected with the parameter check, so a listed action is offered only if the event also emits every parameter that action requires.

The list can only narrow what’s offered, never widen it.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error