docs.jsonld
type: ApiDocumentation
title: mynuma.io
entrypoint: /
supported class: Account
supported class: AccountStats
supported class: ContactImportTransaction
supported class: smtp/messages
supported class: smtp/messages/
supported class: Blacklist
supported class: campaigns
supported class: Attribute
supported class: Contact
supported class: Document
supported class: drip-campaigns
supported class: drip-enrollments
supported class: campaign clicks
supported class: Group
supported class: SignUpForm
supported class: Message
supported class: OneTimePassword
supported class: Inbound
supported class: Receiver
supported class: Sender
supported class: Product
supported class: Subscription
supported class: tags
supported class: User
supported class: Webhook
supported class: Entrypoint
supported class: ConstraintViolation
supported class: ConstraintViolationList

Account
type: Class
title: Account
supported operation: Retrieves Account resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Account resource.
  returns: Account

AccountStats
type: Class
title: AccountStats
supported operation: Retrieves AccountStats resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves AccountStats resource.
  returns: AccountStats

ContactImportTransaction
type: Class
title: ContactImportTransaction
supported property: SupportedProperty
  property: groupId
  title: groupId
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: map
  title: map
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: data
  title: data
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: filename
  title: filename
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: duplicateAction
  title: duplicateAction
  required: false
  readable: false
  writeable: true
supported operation: Retrieves ContactImportTransaction resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves ContactImportTransaction resource.
  returns: ContactImportTransaction
supported operation: Replaces the ContactImportTransaction resource.
  type: Operation
  type: ReplaceAction
  expects: ContactImportTransaction
  method: PUT
  title: Replaces the ContactImportTransaction resource.
  returns: ContactImportTransaction
supported operation: Creates a ContactImportTransaction resource.
  type: Operation
  type: CreateAction
  expects: Nothing
  method: POST
  title: Creates a ContactImportTransaction resource.
  returns: ContactImportTransaction
supported operation: Creates a ContactImportTransaction resource.
  type: Operation
  type: CreateAction
  expects: Nothing
  method: POST
  title: Creates a ContactImportTransaction resource.
  returns: ContactImportTransaction

groupId
type: Property
domain: ContactImportTransaction
range: string
domain: Document

map
type: Property
domain: ContactImportTransaction

data
type: Property
domain: ContactImportTransaction

filename
type: Property
domain: ContactImportTransaction
range: string

duplicateAction
type: Property
domain: ContactImportTransaction
range: string

smtp/messages
type: Class
title: smtp/messages
supported property: SupportedProperty
  property: bounceEvents
  title: bounceEvents
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: sentOn
  title: sentOn
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: from
  title: from
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: links
  title: links
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: readEvents
  title: readEvents
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: sender
  title: sender
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: subject
  title: subject
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: to
  title: to
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: from
  title: from
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: to
  title: to
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sentOn
  title: sentOn
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isRead
  title: isRead
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sender
  title: sender
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subject
  title: subject
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isVisited
  title: isVisited
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isBounced
  title: isBounced
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported operation: Retrieves smtp/messages resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves smtp/messages resource.
  returns: smtp/messages

bounceEvents
type: Property
domain: smtp/messages

sentOn
type: Property
domain: smtp/messages
range: dateTime

from
type: Property
domain: smtp/messages
range: string

id
type: Property
domain: smtp/messages
range: string

links
type: Property
domain: smtp/messages

readEvents
type: Property
domain: smtp/messages

sender
type: Property
domain: smtp/messages

subject
type: Property
domain: smtp/messages
range: string

state
type: Property
domain: smtp/messages
range: string

to
type: Property
domain: smtp/messages
range: string

isRead
type: Property
domain: smtp/messages

isVisited
type: Property
domain: smtp/messages

isBounced
type: Property
domain: smtp/messages

smtp/messages/
type: Class
title: smtp/messages/
supported operation: Retrieves smtp/messages/ resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves smtp/messages/ resource.
  returns: smtp/messages/

Blacklist
type: Class
title: Blacklist
supported property: SupportedProperty
  property: email
  title: email
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: reason
  title: reason
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported operation: Creates a Blacklist resource.
  type: Operation
  type: CreateAction
  expects: Blacklist
  method: POST
  title: Creates a Blacklist resource.
  returns: Blacklist
supported operation: Deletes the Blacklist resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Blacklist resource.
  returns: Nothing
supported operation: Retrieves Blacklist resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Blacklist resource.
  returns: Blacklist

email
type: Property
domain: Blacklist
domain: Contact

reason
type: Property
domain: Blacklist

id
type: Property
domain: Blacklist

createdAt
type: Property
domain: Blacklist

campaigns
type: Class
title: campaigns
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subjectLine
  title: subjectLine
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sender
  title: sender
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: message
  title: message
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: recipients
  title: recipients
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: notify
  title: notify
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: notifications
  title: notifications
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: scheduledOn
  title: scheduledOn
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: tags
  title: tags
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: refreshRecipientsAtSend
  title: refreshRecipientsAtSend
  required: false
  readable: true
  writeable: true
  description: Enable dynamic recipient refresh at send time (recipients updated from current groups when sending)
supported property: SupportedProperty
  property: isScheduled
  title: isScheduled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: uniqueRecipients
  title: uniqueRecipients
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: report
  title: report
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: refreshRecipientsAtSend
  title: refreshRecipientsAtSend
  required: false
  readable: true
  writeable: true
  description: Whether dynamic recipient refresh is enabled for this campaign
supported property: SupportedProperty
  property: refreshRecipientsAtSendTimestamp
  title: refreshRecipientsAtSendTimestamp
  required: false
  readable: true
  writeable: true
  description: Timestamp when refresh was enabled (ISO 8601 format)
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subjectLine
  title: subjectLine
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sender
  title: sender
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: message
  title: message
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: recipients
  title: recipients
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: notify
  title: notify
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: notifications
  title: notifications
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: scheduledOn
  title: scheduledOn
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: tags
  title: tags
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported operation: Creates a campaigns resource.
  type: Operation
  type: CreateAction
  expects: Nothing
  method: POST
  title: Creates a campaigns resource.
  returns: Nothing
supported operation: Deletes the campaigns resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the campaigns resource.
  returns: Nothing
supported operation: Retrieves campaigns resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves campaigns resource.
  returns: campaigns
supported operation: Creates a campaigns resource.
  type: Operation
  type: CreateAction
  expects: campaigns
  method: POST
  title: Creates a campaigns resource.
  returns: campaigns
supported operation: Replaces the campaigns resource.
  type: Operation
  type: ReplaceAction
  expects: campaigns
  method: PUT
  title: Replaces the campaigns resource.
  returns: campaigns

name
type: Property
domain: campaigns

subjectLine
type: Property
domain: campaigns

sender
type: Property
domain: campaigns

message
type: Property
domain: campaigns

recipients
type: Property
domain: campaigns

notify
type: Property
domain: campaigns

notifications
type: Property
domain: campaigns

scheduledOn
type: Property
domain: campaigns

tags
type: Property
domain: campaigns

refreshRecipientsAtSend
type: Property
domain: campaigns
range: boolean

isScheduled
type: Property
domain: campaigns

uniqueRecipients
type: Property
domain: campaigns

report
type: Property
domain: campaigns

state
type: Property
domain: campaigns

refreshRecipientsAtSendTimestamp
type: Property
domain: campaigns

createdAt
type: Property
domain: campaigns

id
type: Property
domain: campaigns

Attribute
type: Class
title: Attribute
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: slug
  title: slug
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: slug
  title: slug
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sortOrder
  title: sortOrder
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported operation: Retrieves Attribute resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Attribute resource.
  returns: Attribute
supported operation: Deletes the Attribute resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Attribute resource.
  returns: Nothing
supported operation: Replaces the Attribute resource.
  type: Operation
  type: ReplaceAction
  expects: Attribute
  method: PUT
  title: Replaces the Attribute resource.
  returns: Attribute

name
type: Property
domain: Attribute

slug
type: Property
domain: Attribute

type
type: Property
domain: Attribute
range: string

sortOrder
type: Property
domain: Attribute

id
type: Property
domain: Attribute

createdAt
type: Property
domain: Attribute

Contact
type: Class
title: Contact
supported property: SupportedProperty
  property: group
  title: group
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: attributes
  title: attributes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: group
  title: group
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: attributes
  title: attributes
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported operation: Retrieves Contact resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Contact resource.
  returns: Contact
supported operation: Deletes the Contact resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Contact resource.
  returns: Nothing
supported operation: Replaces the Contact resource.
  type: Operation
  type: ReplaceAction
  expects: Contact
  method: PUT
  title: Replaces the Contact resource.
  returns: Contact

group
type: Property
domain: Contact

attributes
type: Property
domain: Contact

state
type: Property
domain: Contact

id
type: Property
domain: Contact

createdAt
type: Property
domain: Contact

Document
type: Class
title: Document
supported property: SupportedProperty
  property: type
  title: type
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: groupId
  title: groupId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: metadata
  title: metadata
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: groupId
  title: groupId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: metadata
  title: metadata
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: completedAt
  title: completedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: filename
  title: filename
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported operation: Retrieves Document resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Document resource.
  returns: Document
supported operation: Deletes the Document resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Document resource.
  returns: Nothing
supported operation: Retrieves Document resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Document resource.
  returns: Nothing

type
type: Property
domain: Document

metadata
type: Property
domain: Document

groupId
type: Property
domain: Document

status
type: Property
domain: Document

completedAt
type: Property
domain: Document

filename
type: Property
domain: Document

createdAt
type: Property
domain: Document

id
type: Property
domain: Document

drip-campaigns
type: Class
title: drip-campaigns
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: message
  title: message
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subject
  title: subject
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: delayInHours
  title: delayInHours
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isActive
  title: isActive
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: triggerType
  title: triggerType
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: targetGroup
  title: targetGroup
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: watchAttribute
  title: watchAttribute
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sender
  title: sender
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: retakeSnapshot
  title: retakeSnapshot
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: filters
  title: filters
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: report
  title: report
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: enrollments
  title: enrollments
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: baseCampaign
  title: baseCampaign
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: baseCampaign
  title: targetGroup
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: messageName
  title: messageName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: targetGroupName
  title: targetGroupName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: watchAttribute
  title: watchAttribute
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: message
  title: message
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subject
  title: subject
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: delayInHours
  title: delayInHours
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isActive
  title: isActive
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: triggerType
  title: triggerType
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sender
  title: sender
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: retakeSnapshot
  title: retakeSnapshot
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: filters
  title: filters
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported operation: Retrieves drip-campaigns resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves drip-campaigns resource.
  returns: drip-campaigns
supported operation: Replaces the drip-campaigns resource.
  type: Operation
  type: ReplaceAction
  expects: drip-campaigns
  method: PUT
  title: Replaces the drip-campaigns resource.
  returns: drip-campaigns
supported operation: Deletes the drip-campaigns resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the drip-campaigns resource.
  returns: Nothing

name
type: Property
domain: drip-campaigns
range: string

message
type: Property
domain: drip-campaigns
range: string

subject
type: Property
domain: drip-campaigns
range: string

delayInHours
type: Property
domain: drip-campaigns
range: integer

isActive
type: Property
domain: drip-campaigns
range: boolean

triggerType
type: Property
domain: drip-campaigns
range: string

targetGroup
type: Property
domain: drip-campaigns
range: string

watchAttribute
type: Property
domain: drip-campaigns
range: string

sender
type: Property
domain: drip-campaigns
range: string

retakeSnapshot
type: Property
domain: drip-campaigns
range: boolean

filters
type: Property
domain: drip-campaigns

state
type: Property
domain: drip-campaigns
range: string

report
type: Property
domain: drip-campaigns

enrollments
type: Property
domain: drip-campaigns

baseCampaign
type: Property
domain: drip-campaigns
range: string
label: targetGroup
label: contact
domain: drip-enrollments

messageName
type: Property
domain: drip-campaigns
range: string

targetGroupName
type: Property
domain: drip-campaigns
range: string

id
type: Property
domain: drip-campaigns

createdAt
type: Property
domain: drip-campaigns

drip-enrollments
type: Class
title: drip-enrollments
supported property: SupportedProperty
  property: dripCampaignId
  title: dripCampaignId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contactId
  title: contactId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: scheduledSendAt
  title: scheduledSendAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: metrics
  title: metrics
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: scheduledSendAt
  title: scheduledSendAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sentAt
  title: sentAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: enrolledAt
  title: enrolledAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: messageId
  title: messageId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: baseCampaign
  title: contact
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contactEmail
  title: contactEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contactName
  title: contactName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: dripCampaignName
  title: dripCampaignName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: dripCampaignId
  title: dripCampaignId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contactId
  title: contactId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported operation: Retrieves drip-enrollments resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves drip-enrollments resource.
  returns: drip-enrollments
supported operation: Deletes the drip-enrollments resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the drip-enrollments resource.
  returns: Nothing

dripCampaignId
type: Property
domain: drip-enrollments
range: string

contactId
type: Property
domain: drip-enrollments
range: string

scheduledSendAt
type: Property
domain: drip-enrollments
range: string

status
type: Property
domain: drip-enrollments
range: string

metrics
type: Property
domain: drip-enrollments

sentAt
type: Property
domain: drip-enrollments
range: string

enrolledAt
type: Property
domain: drip-enrollments
range: string

messageId
type: Property
domain: drip-enrollments
range: string

contactEmail
type: Property
domain: drip-enrollments
range: string

contactName
type: Property
domain: drip-enrollments
range: string

dripCampaignName
type: Property
domain: drip-enrollments
range: string

id
type: Property
domain: drip-enrollments

createdAt
type: Property
domain: drip-enrollments

campaign clicks
type: Class
title: campaign clicks
supported property: SupportedProperty
  property: campaign
  title: campaign
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: contact
  title: contact
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: timestamp
  title: timestamp
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: ip
  title: ip
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: userAgent
  title: userAgent
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: link
  title: link
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: contact
  title: contact
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: timestamp
  title: timestamp
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported operation: Retrieves campaign clicks resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves campaign clicks resource.
  returns: #campaign clicks

campaign
type: Property
domain: #campaign clicks
max cardinality: 1
range: campaigns

contact
type: Property
domain: #campaign clicks
max cardinality: 1
range: Contact

timestamp
type: Property
domain: #campaign clicks
range: dateTime

ip
type: Property
domain: #campaign clicks
range: string

userAgent
type: Property
domain: #campaign clicks
range: string

link
type: Property
domain: #campaign clicks

user
type: Property
domain: #campaign clicks
max cardinality: 1
range: User

id
type: Property
domain: #campaign clicks

Group
type: Class
title: Group
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: numberOfContacts
  title: numberOfContacts
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: signUpForm
  title: signUpForm
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: groups
  title: groups
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: excludedGroups
  title: excludedGroups
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contacts
  title: contacts
  required: false
  readable: true
  writeable: true
supported operation: Deletes the Group resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Group resource.
  returns: Nothing
supported operation: Retrieves Group resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Group resource.
  returns: Group
supported operation: Replaces the Group resource.
  type: Operation
  type: ReplaceAction
  expects: Group
  method: PUT
  title: Replaces the Group resource.
  returns: Group
supported operation: Creates a Group resource.
  type: Operation
  type: CreateAction
  expects: Group
  method: POST
  title: Creates a Group resource.
  returns: Nothing

name
type: Property
domain: Group

numberOfContacts
type: Property
domain: Group

signUpForm
type: Property
domain: Group

createdAt
type: Property
domain: Group

id
type: Property
domain: Group

groups
type: Property
domain: Group

excludedGroups
type: Property
domain: Group

contacts
type: Property
domain: Group

SignUpForm
type: Class
title: SignUpForm
supported property: SupportedProperty
  property: sender
  title: sender
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: group
  title: group
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: alreadyConfirmedPage
  title: alreadyConfirmedPage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: alreadySignedUpPage
  title: alreadySignedUpPage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: confirmationMail
  title: confirmationMail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: confirmationPage
  title: confirmationPage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: signUpPage
  title: signUpPage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sender
  title: sender
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: group
  title: group
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: alreadyConfirmedPage
  title: alreadyConfirmedPage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: alreadySignedUpPage
  title: alreadySignedUpPage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: confirmationMail
  title: confirmationMail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: confirmationPage
  title: confirmationPage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: signUpPage
  title: signUpPage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported operation: Retrieves SignUpForm resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves SignUpForm resource.
  returns: SignUpForm
supported operation: Deletes the SignUpForm resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the SignUpForm resource.
  returns: Nothing
supported operation: Replaces the SignUpForm resource.
  type: Operation
  type: ReplaceAction
  expects: SignUpForm
  method: PUT
  title: Replaces the SignUpForm resource.
  returns: SignUpForm

sender
type: Property
domain: SignUpForm

group
type: Property
domain: SignUpForm

alreadyConfirmedPage
type: Property
domain: SignUpForm

alreadySignedUpPage
type: Property
domain: SignUpForm

confirmationMail
type: Property
domain: SignUpForm

confirmationPage
type: Property
domain: SignUpForm

signUpPage
type: Property
domain: SignUpForm

id
type: Property
domain: SignUpForm

Message
type: Class
title: Message
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: html
  title: html
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: text
  title: text
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: structured
  title: structured
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: publishState
  title: publishState
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: builder
  title: builder
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: links
  title: links
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: privacy
  title: privacy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: html
  title: html
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: text
  title: text
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: structured
  title: structured
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: publishState
  title: publishState
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: builder
  title: builder
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: links
  title: links
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: privacy
  title: privacy
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported operation: Creates a Message resource.
  type: Operation
  type: CreateAction
  expects: Nothing
  method: POST
  title: Creates a Message resource.
  returns: Nothing
supported operation: Deletes the Message resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Message resource.
  returns: Nothing
supported operation: Creates a Message resource.
  type: Operation
  type: CreateAction
  expects: Message
  method: POST
  title: Creates a Message resource.
  returns: Message
supported operation: Retrieves Message resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Message resource.
  returns: Message
supported operation: Retrieves Message resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Message resource.
  returns: Message
supported operation: Replaces the Message resource.
  type: Operation
  type: ReplaceAction
  expects: Message
  method: PUT
  title: Replaces the Message resource.
  returns: Message
supported operation: Creates a Message resource.
  type: Operation
  type: CreateAction
  expects: Nothing
  method: POST
  title: Creates a Message resource.
  returns: Nothing
supported operation: Creates a Message resource.
  type: Operation
  type: CreateAction
  expects: Nothing
  method: POST
  title: Creates a Message resource.
  returns: Message

name
type: Property
domain: Message

html
type: Property
domain: Message

text
type: Property
domain: Message

structured
type: Property
domain: Message

publishState
type: Property
domain: Message

builder
type: Property
domain: Message

links
type: Property
domain: Message

privacy
type: Property
domain: Message

title
type: Property
domain: Message

createdAt
type: Property
domain: Message

updatedAt
type: Property
domain: Message

id
type: Property
domain: Message

OneTimePassword
type: Class
title: OneTimePassword
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported operation: Retrieves OneTimePassword resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves OneTimePassword resource.
  returns: OneTimePassword

user
type: Property
domain: OneTimePassword

id
type: Property
domain: OneTimePassword

Inbound
type: Class
title: Inbound
supported property: SupportedProperty
  property: message
  title: message
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: receiver
  title: receiver
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: responseCode
  title: responseCode
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: owner
  title: owner
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported operation: Retrieves Inbound resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Inbound resource.
  returns: Inbound
supported operation: Deletes the Inbound resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Inbound resource.
  returns: Nothing

message
type: Property
domain: Inbound

receiver
type: Property
domain: Inbound
max cardinality: 1
range: Receiver

responseCode
type: Property
domain: Inbound
range: integer

owner
type: Property
domain: Inbound
max cardinality: 1
range: User

createdAt
type: Property
domain: Inbound
range: dateTime

updatedAt
type: Property
domain: Inbound
range: dateTime

Receiver
type: Class
title: Receiver
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: url
  title: url
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: secret
  title: secret
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: url
  title: url
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported operation: Retrieves Receiver resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Receiver resource.
  returns: Receiver
supported operation: Replaces the Receiver resource.
  type: Operation
  type: ReplaceAction
  expects: Receiver
  method: PUT
  title: Replaces the Receiver resource.
  returns: Receiver
supported operation: Deletes the Receiver resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Receiver resource.
  returns: Nothing

name
type: Property
domain: Receiver
range: string

url
type: Property
domain: Receiver
range: string

email
type: Property
domain: Receiver
range: string

state
type: Property
domain: Receiver
range: string

secret
type: Property
domain: Receiver
range: string

createdAt
type: Property
domain: Receiver

id
type: Property
domain: Receiver

Sender
type: Class
title: Sender
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: headerValue
  title: headerValue
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: smtpCredentials
  title: smtpCredentials
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported operation: Retrieves Sender resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Sender resource.
  returns: Sender
supported operation: Deletes the Sender resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Sender resource.
  returns: Nothing
supported operation: Creates a Sender resource.
  type: Operation
  type: CreateAction
  expects: Sender
  method: POST
  title: Creates a Sender resource.
  returns: Nothing

name
type: Property
domain: Sender

email
type: Property
domain: Sender

state
type: Property
domain: Sender

headerValue
type: Property
domain: Sender

smtpCredentials
type: Property
domain: Sender

createdAt
type: Property
domain: Sender

id
type: Property
domain: Sender

Product
type: Class
title: Product
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: module
  title: module
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: numberOfContact
  title: numberOfContact
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: numberOfMessages
  title: numberOfMessages
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: complementary
  title: complementary
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: module
  title: module
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: numberOfContact
  title: numberOfContact
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: numberOfMessages
  title: numberOfMessages
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: complementary
  title: complementary
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported operation: Retrieves Product resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Product resource.
  returns: Product

name
type: Property
domain: Product
range: string

module
type: Property
domain: Product

numberOfContact
type: Property
domain: Product
range: integer

numberOfMessages
type: Property
domain: Product
range: integer

complementary
type: Property
domain: Product
range: boolean

id
type: Property
domain: Product

Subscription
type: Class
title: Subscription
supported property: SupportedProperty
  property: user
  title: user
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: product
  title: product
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: startsOn
  title: startsOn
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: startsOn
  title: expiresOn
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: expired
  title: expired
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: user
  title: user
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: product
  title: product
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: startsOn
  title: startsOn
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: startsOn
  title: expiresOn
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported operation: Retrieves Subscription resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Subscription resource.
  returns: Subscription

user
type: Property
domain: Subscription

product
type: Property
domain: Subscription

startsOn
type: Property
domain: Subscription
label: expiresOn

expired
type: Property
domain: Subscription
range: boolean

id
type: Property
domain: Subscription

tags
type: Class
title: tags
supported property: SupportedProperty
  property: label
  title: label
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: label
  title: label
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported operation: Deletes the tags resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the tags resource.
  returns: Nothing
supported operation: Retrieves tags resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves tags resource.
  returns: tags
supported operation: Replaces the tags resource.
  type: Operation
  type: ReplaceAction
  expects: tags
  method: PUT
  title: Replaces the tags resource.
  returns: tags

label
type: Property
domain: tags

id
type: Property
domain: tags

User
type: Class
title: User
supported property: SupportedProperty
  property: firstName
  title: firstName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastName
  title: lastName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: company
  title: company
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: receiveMynumaInformation
  title: receiveMynumaInformation
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: firstName
  title: firstName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastName
  title: lastName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: company
  title: company
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: modules
  title: modules
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: password
  title: password
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: firstName
  title: firstName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastName
  title: lastName
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: company
  title: company
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: receiveMynumaInformation
  title: receiveMynumaInformation
  required: true
  readable: true
  writeable: true
supported operation: Retrieves User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves User resource.
  returns: User
supported operation: Replaces the User resource.
  type: Operation
  type: ReplaceAction
  expects: User
  method: PUT
  title: Replaces the User resource.
  returns: User
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: User
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: User

firstName
type: Property
domain: User

lastName
type: Property
domain: User

company
type: Property
domain: User

email
type: Property
domain: User

receiveMynumaInformation
type: Property
domain: User

modules
type: Property
domain: User

id
type: Property
domain: User

createdAt
type: Property
domain: User

password
type: Property
domain: User

Webhook
type: Class
title: Webhook
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: destination
  title: destination
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: secret
  title: secret
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: destination
  title: destination
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported operation: Retrieves Webhook resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Webhook resource.
  returns: Webhook
supported operation: Deletes the Webhook resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Webhook resource.
  returns: Nothing
supported operation: Replaces the Webhook resource.
  type: Operation
  type: ReplaceAction
  expects: Webhook
  method: PUT
  title: Replaces the Webhook resource.
  returns: Webhook

name
type: Property
domain: Webhook

description
type: Property
domain: Webhook

destination
type: Property
domain: Webhook

type
type: Property
domain: Webhook

state
type: Property
domain: Webhook

secret
type: Property
domain: Webhook

createdAt
type: Property
domain: Webhook

id
type: Property
domain: Webhook

Entrypoint
type: Class
title: The API entrypoint
supported property: SupportedProperty
  property: The collection of ContactImportTransaction resources
  title: The collection of ContactImportTransaction resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of smtp/messages resources
  title: The collection of smtp/messages resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Blacklist resources
  title: The collection of Blacklist resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of campaigns resources
  title: The collection of campaigns resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Attribute resources
  title: The collection of Attribute resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Contact resources
  title: The collection of Contact resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Document resources
  title: The collection of Document resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of drip-campaigns resources
  title: The collection of drip-campaigns resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of drip-enrollments resources
  title: The collection of drip-enrollments resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of campaign clicks resources
  title: The collection of campaign clicks resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Group resources
  title: The collection of Group resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of SignUpForm resources
  title: The collection of SignUpForm resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Message resources
  title: The collection of Message resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of OneTimePassword resources
  title: The collection of OneTimePassword resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Inbound resources
  title: The collection of Inbound resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Receiver resources
  title: The collection of Receiver resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Sender resources
  title: The collection of Sender resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Product resources
  title: The collection of Product resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Subscription resources
  title: The collection of Subscription resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of tags resources
  title: The collection of tags resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of User resources
  title: The collection of User resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Webhook resources
  title: The collection of Webhook resources
  readable: true
  writeable: false
supported operation: The API entrypoint.
  type: Operation
  method: GET
  returns: EntryPoint

The collection of ContactImportTransaction resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ContactImportTransaction
supported operation: Retrieves the collection of ContactImportTransaction resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ContactImportTransaction resources.
  returns: Collection
supported operation: Creates a ContactImportTransaction resource.
  type: Operation
  type: CreateAction
  expects: ContactImportTransaction
  method: POST
  title: Creates a ContactImportTransaction resource.
  returns: ContactImportTransaction

The collection of smtp/messages resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: smtp/messages
supported operation: Retrieves the collection of smtp/messages resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of smtp/messages resources.
  returns: Collection

The collection of Blacklist resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Blacklist
supported operation: Retrieves the collection of Blacklist resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Blacklist resources.
  returns: Collection
supported operation: Creates a Blacklist resource.
  type: Operation
  type: CreateAction
  expects: Blacklist
  method: POST
  title: Creates a Blacklist resource.
  returns: Blacklist
supported operation: Creates a Blacklist resource.
  type: Operation
  type: CreateAction
  expects: Blacklist
  method: POST
  title: Creates a Blacklist resource.
  returns: Blacklist

The collection of campaigns resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: campaigns
supported operation: Retrieves the collection of campaigns resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of campaigns resources.
  returns: Collection
supported operation: Retrieves the collection of campaigns resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of campaigns resources.
  returns: Collection
supported operation: Creates a campaigns resource.
  type: Operation
  type: CreateAction
  expects: campaigns
  method: POST
  title: Creates a campaigns resource.
  returns: campaigns

The collection of Attribute resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Attribute
supported operation: Retrieves the collection of Attribute resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Attribute resources.
  returns: Collection
supported operation: Creates a Attribute resource.
  type: Operation
  type: CreateAction
  expects: Attribute
  method: POST
  title: Creates a Attribute resource.
  returns: Attribute
supported operation: Replaces the Attribute resource.
  type: Operation
  type: ReplaceAction
  expects: Nothing
  method: PUT
  title: Replaces the Attribute resource.
  returns: Nothing

The collection of Contact resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Contact
supported operation: Retrieves the collection of Contact resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Contact resources.
  returns: Collection
supported operation: Creates a Contact resource.
  type: Operation
  type: CreateAction
  expects: Contact
  method: POST
  title: Creates a Contact resource.
  returns: Contact

The collection of Document resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Document
supported operation: Retrieves the collection of Document resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Document resources.
  returns: Collection
supported operation: Creates a Document resource.
  type: Operation
  type: CreateAction
  expects: Document
  method: POST
  title: Creates a Document resource.
  returns: Document

The collection of drip-campaigns resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: drip-campaigns
supported operation: Retrieves the collection of drip-campaigns resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of drip-campaigns resources.
  returns: Collection
supported operation: Creates a drip-campaigns resource.
  type: Operation
  type: CreateAction
  expects: drip-campaigns
  method: POST
  title: Creates a drip-campaigns resource.
  returns: drip-campaigns

The collection of drip-enrollments resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: drip-enrollments
supported operation: Retrieves the collection of drip-enrollments resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of drip-enrollments resources.
  returns: Collection

The collection of campaign clicks resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: campaign clicks
supported operation: Retrieves the collection of campaign clicks resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of campaign clicks resources.
  returns: Collection

The collection of Group resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Group
supported operation: Retrieves the collection of Group resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Group resources.
  returns: Collection
supported operation: Creates a Group resource.
  type: Operation
  type: CreateAction
  expects: Group
  method: POST
  title: Creates a Group resource.
  returns: Group
supported operation: Creates a Group resource.
  type: Operation
  type: CreateAction
  expects: Group
  method: POST
  title: Creates a Group resource.
  returns: Group

The collection of SignUpForm resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: SignUpForm
supported operation: Retrieves the collection of SignUpForm resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of SignUpForm resources.
  returns: Collection
supported operation: Creates a SignUpForm resource.
  type: Operation
  type: CreateAction
  expects: SignUpForm
  method: POST
  title: Creates a SignUpForm resource.
  returns: SignUpForm

The collection of Message resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Message
supported operation: Retrieves the collection of Message resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Message resources.
  returns: Collection
supported operation: Creates a Message resource.
  type: Operation
  type: CreateAction
  expects: Message
  method: POST
  title: Creates a Message resource.
  returns: Message

The collection of OneTimePassword resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: OneTimePassword
supported operation: Creates a OneTimePassword resource.
  type: Operation
  type: CreateAction
  expects: OneTimePassword
  method: POST
  title: Creates a OneTimePassword resource.
  returns: OneTimePassword

The collection of Inbound resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Inbound
supported operation: Retrieves the collection of Inbound resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Inbound resources.
  returns: Collection

The collection of Receiver resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Receiver
supported operation: Retrieves the collection of Receiver resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Receiver resources.
  returns: Collection
supported operation: Creates a Receiver resource.
  type: Operation
  type: CreateAction
  expects: Receiver
  method: POST
  title: Creates a Receiver resource.
  returns: Receiver

The collection of Sender resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Sender
supported operation: Retrieves the collection of Sender resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Sender resources.
  returns: Collection
supported operation: Creates a Sender resource.
  type: Operation
  type: CreateAction
  expects: Sender
  method: POST
  title: Creates a Sender resource.
  returns: Sender

The collection of Product resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Product
supported operation: Retrieves the collection of Product resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Product resources.
  returns: Collection

The collection of Subscription resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Subscription
supported operation: Retrieves the collection of Subscription resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Subscription resources.
  returns: Collection
supported operation: Creates a Subscription resource.
  type: Operation
  type: CreateAction
  expects: Subscription
  method: POST
  title: Creates a Subscription resource.
  returns: Subscription

The collection of tags resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: tags
supported operation: Retrieves the collection of tags resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of tags resources.
  returns: Collection
supported operation: Creates a tags resource.
  type: Operation
  type: CreateAction
  expects: tags
  method: POST
  title: Creates a tags resource.
  returns: tags

The collection of User resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: User
supported operation: Retrieves the collection of User resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of User resources.
  returns: Collection
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: User

The collection of Webhook resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Webhook
supported operation: Retrieves the collection of Webhook resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Webhook resources.
  returns: Collection
supported operation: Creates a Webhook resource.
  type: Operation
  type: CreateAction
  expects: Webhook
  method: POST
  title: Creates a Webhook resource.
  returns: Webhook

ConstraintViolation
type: Class
title: A constraint violation
supported property: SupportedProperty
  property: propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

propertyPath
type: Property
domain: ConstraintViolation
range: string

message
type: Property
domain: ConstraintViolation
range: string

ConstraintViolationList
type: Class
subclass of: Error
title: A constraint violation list
supported property: SupportedProperty
  property: violations
  title: violations
  description: The violations
  readable: true
  writeable: false

violations
type: Property
domain: ConstraintViolationList
range: ConstraintViolation

Retrieves campaigns resource.
type: Operation
type: FindAction
method: GET
title: Retrieves campaigns resource.
returns: campaigns

Creates a campaigns resource.
type: Operation
type: CreateAction
expects: Nothing
method: POST
title: Creates a campaigns resource.
returns: Nothing