Skip to content
API Docs

createRequestedFormInput

Autogenerated input type of createRequestedForm

Fields

clientMutationId · String · DO NOT USE
deprecated DO NOT USE
form · String · The ID of the custom form OR the name of the generic form (e.g 'billing_info')
metadata · String · A serialized JSON string of metadata. Maximum character limit of 128,000.
recipient_ids · [ID] · A list of user IDs and/or user group IDs. If passing user group IDs, they should take the following format: ["group-1", "group-2", "group-3"] You can pass both user IDs and user group IDs. Example: ["1", "2", "3", "group-1", "group-2"] If you pass a user group ID, all users in that group will be sent the form.
skip_notification_email · Boolean · True to skip sending the notifying email to clients, default false

Used By

Definition 

"""
Autogenerated input type of createRequestedForm
"""
input createRequestedFormInput {
  """
  DO NOT USE
  """
  clientMutationId: String @deprecated(reason: "DO NOT USE")
  custom_module_form_id: ID
  item_type: String
  recipient_id: ID
  ends_on: String


  """
  The ID of the custom form OR the name of the generic form (e.g 'billing_info')
  """
  form: String
  frequency: String
  hour: String
  is_recurring: Boolean


  """
  A serialized JSON string of metadata. Maximum character limit of 128,000.
  """
  metadata: String
  minute: String
  monthday: String
  period: String


  """
  A list of user IDs and/or user group IDs. If passing user group IDs, they should take the following format: ["group-1", "group-2", "group-3"] You can pass both user IDs and user group IDs. Example: ["1", "2", "3", "group-1", "group-2"] If you pass a user group ID, all users in that group will be sent the form.
  """
  recipient_ids: [ID]
  recurrence_ends: Boolean
  weekday: String


  """
  True to skip sending the notifying email to clients, default false
  """
  skip_notification_email: Boolean = false
}