Update Event Definition

Update an existing custom event definition by adding new fields or modifying the title and description. Only supports additive changes—you can add new fields but cannot remove existing fields or change their types. This ensures backward compatibility with historical events. Standard (internal) definitions and template-inherited properties cannot be modified.

post/peopleevents/2/definitions/{definitionId}

Request

Base URL
https://api.infobip.com (the document declares no server; this is the origin it was published from)
Auth
- HTTP basic
- or API key in header Authorization
- or API key in header Authorization
- or OAuth 2
  Client credentials
  Token URL: https://api.infobip.com/auth/1/oauth2/token

Path parameters

definitionIdstring required

Event definition identifier.

Request body

titlestring required

Event definition title. Must not be empty. Maximum length: 100 characters.<br>Note: The title cannot be changed for a template definition. If the client tries to update the value, it will be overwritten with the standard title from the template.

descriptionstring nullable

Event definition description. Maximum length: 2000 characters.<br>Note: The description cannot be changed for a template definition. If the client tries to update the value, it will be overwritten with the standard description from the template.

Response

isInternalDefinitionboolean

Indicates whether this is a standard (internal) event definition provided by the system, or a custom (external) definition created by the user.

category'external' | 'person' | 'channel' | 'product' | 'template'

Event definition category.

Event definition subcategory.

definitionIdstring nullable

Event definition identifier.

titlestring nullable

Event definition title.

descriptionstring nullable

Event definition description.

Changes

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