zendesk.support.user.update

Element details

type: meya.zendesk.support.component.user.update
class: ZendeskSupportUserUpdateComponent
path: /meya/zendesk/support/component/user/update.py
signature: -

Fields

fielddescription               requiredsignaturedefaulttype
specOverride the original spec for this element.○○nullSpec
contextSend context data with this component's event.○○{}dict
sensitive○○truebool
triggersActivate these dynamic triggers when the component runs. Check the component triggers guide for more info.○○[]list
integrationThe reference path to the Zendesk Support integration file. See the integration reference paths documentation for more information.◉○ZendeskSupportIntegrationRef
user_idThe ID of the user to update.○○nullint
nameThe user's name.○○nullstr
detailsAny details you want to store about the user, such as an address○○nullstr
emailThe user's secondary email address. See the Zendesk email address documentation for more information.○○nullstr
verifiedWhether any of the user's identities have been verified.○○nullbool
phoneThe user's primary phone number. See the Zendesk phone number documentation for more information.○○nullstr
tagsAn array of tags to add to the user. This is only present if user tagging is enabled for your Zendesk instance.○○nulllist
user_fieldsValues of custom fields in the user's profile. See the Zendesk user fields documentation for more information.○○nulldict
external_idAn ID you can use to link Zendesk Support users to local records. Note, the Zendesk API treats the ID as case sensitive.○○nullstr

Usage reference

Basic

triggers:
  - keyword: meya.zendesk.support.component.user.update
steps:
  - type: meya.zendesk.support.component.user.update
    integration: integration.zendesk_support

Full

triggers:
  - keyword: meya.zendesk.support.component.user.update
steps:
  - type: meya.zendesk.support.component.user.update
    spec:
      type: STRING
      data:
        STRING: ANY
      timeout: 123
      trigger_when: ANY
    context:
      STRING: ANY
    sensitive: false
    triggers:
      - type: STRING
        data:
          STRING: ANY
        timeout: 123
        trigger_when: ANY
    integration: integration.zendesk_support
    user_id: 123
    name: STRING
    details: STRING
    email: STRING
    verified: false
    phone: STRING
    tags:
      - STRING
    user_fields:
      STRING: ANY
    external_id: STRING