Modify Single Custom Behavioral Event Definition
PATCH {{baseUrl}}/events/v3/event-definitions/:eventName
Modify a single custom behavioral event definition
Request Body
{"description"=>"<string>", "label"=>"<string>"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"archived":"\u003cboolean\u003e","associations":[{"allowsCustomLabels":"\u003cboolean\u003e","cardinality":"ONE_TO_MANY","category":"INTEGRATOR_DEFINED","fromObjectTypeId":"\u003cstring\u003e","hasAllAssociatedObjects":"\u003cboolean\u003e","hasCascadingDeletes":"\u003cboolean\u003e","hasUserEnforcedMaxFromObjectIds":"\u003cboolean\u003e","hasUserEnforcedMaxToObjectIds":"\u003cboolean\u003e","hidden":"\u003cboolean\u003e","id":"\u003cinteger\u003e","inverseAllowsCustomLabels":"\u003cboolean\u003e","inverseCardinality":"ONE_TO_ONE","inverseHasAllAssociatedObjects":"\u003cboolean\u003e","inverseId":"\u003cinteger\u003e","inverseName":"\u003cstring\u003e","isInversePrimary":"\u003cboolean\u003e","isPrimary":"\u003cboolean\u003e","maxFromObjectIds":"\u003cinteger\u003e","maxToObjectIds":"\u003cinteger\u003e","name":"\u003cstring\u003e","toObjectTypeId":"\u003cstring\u003e","inverseLabel":"\u003cstring\u003e","fromObjectType":"BLOG_POST","toObjectType":"INVOICE","label":"\u003cstring\u003e"},{"allowsCustomLabels":"\u003cboolean\u003e","cardinality":"ONE_TO_MANY","category":"USER_DEFINED","fromObjectTypeId":"\u003cstring\u003e","hasAllAssociatedObjects":"\u003cboolean\u003e","hasCascadingDeletes":"\u003cboolean\u003e","hasUserEnforcedMaxFromObjectIds":"\u003cboolean\u003e","hasUserEnforcedMaxToObjectIds":"\u003cboolean\u003e","hidden":"\u003cboolean\u003e","id":"\u003cinteger\u003e","inverseAllowsCustomLabels":"\u003cboolean\u003e","inverseCardinality":"ONE_TO_MANY","inverseHasAllAssociatedObjects":"\u003cboolean\u003e","inverseId":"\u003cinteger\u003e","inverseName":"\u003cstring\u003e","isInversePrimary":"\u003cboolean\u003e","isPrimary":"\u003cboolean\u003e","maxFromObjectIds":"\u003cinteger\u003e","maxToObjectIds":"\u003cinteger\u003e","name":"\u003cstring\u003e","toObjectTypeId":"\u003cstring\u003e","inverseLabel":"\u003cstring\u003e","fromObjectType":"LEAD","toObjectType":"SITE_PAGE","label":"\u003cstring\u003e"}],"fullyQualifiedName":"\u003cstring\u003e","id":"\u003cstring\u003e","labels":{"singular":"\u003cstring\u003e","plural":"\u003cstring\u003e"},"name":"\u003cstring\u003e","objectTypeId":"\u003cstring\u003e","properties":[{"description":"\u003cstring\u003e","fieldType":"\u003cstring\u003e","groupName":"\u003cstring\u003e","label":"\u003cstring\u003e","name":"\u003cstring\u003e","options":[{"hidden":"\u003cboolean\u003e","label":"\u003cstring\u003e","value":"\u003cstring\u003e","displayOrder":"\u003cinteger\u003e","description":"\u003cstring\u003e"},{"hidden":"\u003cboolean\u003e","label":"\u003cstring\u003e","value":"\u003cstring\u003e","displayOrder":"\u003cinteger\u003e","description":"\u003cstring\u003e"}],"type":"\u003cstring\u003e","createdUserId":"\u003cstring\u003e","hidden":"\u003cboolean\u003e","modificationMetadata":{"archivable":"\u003cboolean\u003e","readOnlyDefinition":"\u003cboolean\u003e","readOnlyValue":"\u003cboolean\u003e","readOnlyOptions":"\u003cboolean\u003e"},"displayOrder":"\u003cinteger\u003e","showCurrencySymbol":"\u003cboolean\u003e","hubspotDefined":"\u003cboolean\u003e","formField":"\u003cboolean\u003e","createdAt":"\u003cdateTime\u003e","archivedAt":"\u003cdateTime\u003e","archived":"\u003cboolean\u003e","referencedObjectType":"\u003cstring\u003e","calculationFormula":"\u003cstring\u003e","hasUniqueValue":"\u003cboolean\u003e","updatedUserId":"\u003cstring\u003e","calculated":"\u003cboolean\u003e","externalOptions":"\u003cboolean\u003e","updatedAt":"\u003cdateTime\u003e"},{"description":"\u003cstring\u003e","fieldType":"\u003cstring\u003e","groupName":"\u003cstring\u003e","label":"\u003cstring\u003e","name":"\u003cstring\u003e","options":[{"hidden":"\u003cboolean\u003e","label":"\u003cstring\u003e","value":"\u003cstring\u003e","displayOrder":"\u003cinteger\u003e","description":"\u003cstring\u003e"},{"hidden":"\u003cboolean\u003e","label":"\u003cstring\u003e","value":"\u003cstring\u003e","displayOrder":"\u003cinteger\u003e","description":"\u003cstring\u003e"}],"type":"\u003cstring\u003e","createdUserId":"\u003cstring\u003e","hidden":"\u003cboolean\u003e","modificationMetadata":{"archivable":"\u003cboolean\u003e","readOnlyDefinition":"\u003cboolean\u003e","readOnlyValue":"\u003cboolean\u003e","readOnlyOptions":"\u003cboolean\u003e"},"displayOrder":"\u003cinteger\u003e","showCurrencySymbol":"\u003cboolean\u003e","hubspotDefined":"\u003cboolean\u003e","formField":"\u003cboolean\u003e","createdAt":"\u003cdateTime\u003e","archivedAt":"\u003cdateTime\u003e","archived":"\u003cboolean\u003e","referencedObjectType":"\u003cstring\u003e","calculationFormula":"\u003cstring\u003e","hasUniqueValue":"\u003cboolean\u003e","updatedUserId":"\u003cstring\u003e","calculated":"\u003cboolean\u003e","externalOptions":"\u003cboolean\u003e","updatedAt":"\u003cdateTime\u003e"}],"createdUserId":"\u003cinteger\u003e","trackingType":"IMPORT","description":"\u003cstring\u003e","primaryObjectId":"\u003cstring\u003e","primaryObject":"\u003cstring\u003e","createdAt":"\u003cdateTime\u003e"}