Element details

type: meya.front.component.contact.create_or_update
class: FrontContactCreateOrUpdateComponent
path: /meya/front/component/contact/create_or_update.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:`<source>`:`<handle>` (e.g. alt☎️+12345678900)	○	○	null	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
name		○	○	null	str
description	A description of the contact	○	○	null	str
avatar_url	The URL of an image to use as the contact's avatar	○	○	null	str
group_names	List of all the group names the contact belongs to. Missing groups will be created automatically.	○	○	null	list
is_spammer	Indicates whether or not the contact is marked as a spammer	○	○	null	bool
links	A list of all the links of the contact	○	○	null	list
custom_fields	Custom field attributes for this contact. Leave empty if you do not wish to update the attributes. Not sending existing attributes will automatically remove them.	○	○	{}	dict
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
contact_id	The Front Contact ID	○	○	null	str
link	Link the current Meya user to this integration user	○	○	true	bool

Usage reference

Basic

triggers:
  - keyword: meya.front.component.contact.create_or_update
steps:
  - type: meya.front.component.contact.create_or_update
    integration: integration.front

Full

triggers:
  - keyword: meya.front.component.contact.create_or_update
steps:
  - type: meya.front.component.contact.create_or_update
    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
    name: STRING
    description: STRING
    avatar_url: STRING
    group_names:
      - STRING
    is_spammer: false
    links:
      - STRING
    custom_fields:
      STRING: ANY
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    contact_id: STRING
    link: false