Element details

type: meya.front.component.contact.handle.delete
class: FrontContactHandleDeleteComponent
path: /meya/front/component/contact/handle/delete.py
signature: -

Fields

field	description	required	signature	default	type
spec	Override the original spec for this element.	○	○	null	Spec
integration	A string identifier for the Front integration (e.g. integration.front)	◉	○		FrontIntegrationRef
handle	A human readable alias for the Front contact. The format is alt:: (e.g. alt+12345678900)	◉	○		str
source	Front contact source. e.g. `email`. Front enforces contact handle format depending on the contact source, e.g., for Twitter the contact handle must start with `@` This value will only be used in case of contact creation.	○	○	"custom"	FrontSource
contact_id	The Front Contact ID	○	○	null	str
context	Send context data with this component's event.	○	○	{}	dict
sensitive		○	○	true	bool
triggers	Activate these dynamic triggers when the component runs. Check the component triggers guide for more info.	○	○	[]	list
force	Setting force to true will delete the contact if the handle to delete is the last one of the contact	○	○	false	bool

Usage reference

Basic

triggers:
  - keyword: meya.front.component.contact.handle.delete
steps:
  - type: meya.front.component.contact.handle.delete
    integration: integration.front
    handle: STRING

Full

triggers:
  - keyword: meya.front.component.contact.handle.delete
steps:
  - type: meya.front.component.contact.handle.delete
    spec:
      type: STRING
      data:
        STRING: ANY
      timeout: 123
      trigger_when: ANY
    integration: integration.front
    handle: STRING
    source: email|phone|twitter|facebook|intercom|front_chat|custom
    contact_id: STRING
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    force: false