Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Required

...

Columns

  • email

  • or identifier: The user’s ID Number in your system

Optional

...

Columns

  • Custom Field Value
    The column name must exactly match the name of a predefined custom field on your organization

  • cardholderGroupName: the value must exactly match the name of a predefined cardholder group on your organization

  • additionalPhotoRequired

    1. true: this cardholder is required to submit all supporting documents defined by the organization (i.e. driver's license)

    2. false: this cardholder does not need to submit any supporting docs

    3. default: true

  • unsubscribe

    1. true: do not send non-transactional emails, i.e. Welcome Emails

    2. false: send all emails

    3. default: false

  • enabled 

    1. true: the user can access the application

    2. false: the user cannot access the application

    3. default: true

  • managerEmail: the email address of the Person Manager for this cardholder. If a Person Manager with this email address does not already exist, it will be created.

  • sendInvitation

    • TRUE: send the welcome email to this person

    • FALSE: do not send the welcome email to this person

    • null, empty, or any other value: use the default behavior defined by the invitationDefault form parameter

  • action

    • CREATE: only create this person. Throw an error if this person already exists

    • CREATE_OR_UPDATE: create this person or update them if they already exist

...