front.contact.handle.delete

Element details

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

Fields

fielddescription               requiredsignaturedefaulttype
specOverride the original spec for this element.nullSpec
integrationA string identifier for the Front integration (e.g. integration.front)FrontIntegrationRef
handleA human readable alias for the Front contact. The format is alt:: (e.g. alt☎️+12345678900)str
sourceFront 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_idThe Front Contact IDnullstr
contextSend context data with this component's event.{}
dict
sensitivetruebool
triggersActivate these dynamic triggers when the component runs. Check the component triggers guide for more info.[]list
forceSetting force to true will delete the contact if the handle to delete is the last one of the contactfalsebool

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