# info.description
These APIs lets you use our message services from your applications.

# paths./api/authentications.get.summary
Gives you a list of your SMS authentications

# paths./api/authentications.get.description
Gives you a list of your SMS authentications

# paths./api/authentications.post.summary
Creates and sends a new SMS authentication with the given information

# paths./api/authentications.post.description
Creates and sends a new SMS authentication with the given information

# paths./api/authentications/validate.post.summary
Validates a given SMS authentication code, a valid code is considered used

# paths./api/authentications/validate.post.description
Validates a given SMS authentication code, a valid code is considered used

# paths./api/authentications/settings.get.summary
Gets your current default settings for new SMS authentications

# paths./api/authentications/settings.get.description
Gets your current default settings for new SMS authentications

# paths./api/authentications/settings.put.summary
Updates your default settings for new SMS authentications

# paths./api/authentications/settings.put.description
Updates your default settings for new SMS authentications

# paths./api/blacklist.post.summary
Creates a new blacklist entry with the given information

# paths./api/blacklist.post.description
Can also be used to create multiple entries. Add the query parameter multiple and format the body as an array.

# paths./api/contacts.post.summary
Creates a new contact with the given information

# paths./api/contacts.post.description
Can also be used to create multiple contacts. Add the query parameter multiple and format the body as an array.

# paths./api/groups/{group}/contacts.get.summary
Gives you a list of your contacts in a given contact group

# paths./api/groups/{group}/contacts.get.description
Gives you a list of your contacts in a given contact group

# paths./api/contacts/{contact}.put.summary
Updates a given contact with the given information. NOTE! Existing information is
replaced entirely with the new information set.

# paths./api/contacts/{contact}.put.description
Updates a given contact with the given information. NOTE! Existing information is
replaced entirely with the new information set.

# paths./api/contacts/{contact}.delete.summary
Deletes a given contact. NOTE! Also deletes its group memberships, if any.

# paths./api/contacts/{contact}.delete.description
Deletes a given contact. NOTE! Also deletes its group memberships, if any.

# paths./api/contacts/{contact}/extra.get.summary
Gets the extra fields of a given contact

# paths./api/contacts/{contact}/extra.get.description
Gets the extra fields of a given contact

# paths./api/contacts/{contact}/extra.post.summary
Creates a new extra field for a given contact with the given information

# paths./api/contacts/{contact}/extra.post.description
Creates a new extra field for a given contact with the given information

# paths./api/contacts/extra/{extra}.get.summary
Gives you a summary of a given extra field

# paths./api/contacts/extra/{extra}.get.description
Gives you a summary of a given extra field

# paths./api/contacts/extra/{extra}.put.summary
Updates a given extra field with the given information. NOTE! Existing information is
replaced entirely with the new information set.

# paths./api/contacts/extra/{extra}.put.description
Updates a given extra field with the given information. NOTE! Existing information is
replaced entirely with the new information set.

# paths./api/groups.post.summary
Creates a new contact group with the given information

# paths./api/groups.post.description
Can also be used to create multiple groups. Add the query parameter multiple and format the body as an array.

# paths./api/contacts/{contact}/groups.get.summary
Gives you a list of your contact groups that a given contact is a member of

# paths./api/contacts/{contact}/groups.get.description
Gives you a list of your contact groups that a given contact is a member of

# paths./api/groups/{group}.get.summary
Gives you a summary of a given contact group

# paths./api/groups/{group}.get.description
Gives you a summary of a given contact group

# paths./api/groups/{group}.put.summary
Updates a given contact group with the given information. NOTE! Existing information is
replaced entirely with the new information set.

# paths./api/groups/{group}.put.description
Updates a given contact group with the given information. NOTE! Existing information is
replaced entirely with the new information set.

# paths./api/groups/{group}.delete.summary
Deletes a given contact group. NOTE! Also deletes its group memberships, if any.

# paths./api/groups/{group}.delete.description
Deletes a given contact group. NOTE! Also deletes its group memberships, if any.

# paths./api/me/account.get.summary
Gives you your account information (Requires HTTPS)

# paths./api/me/account.get.description
Gives you your account information (Requires HTTPS)

# paths./api/me/children.get.summary
Gives you a list of your accounts' child accounts (Requires HTTPS)

# paths./api/me/children.get.description
Gives you a list of your accounts' child accounts (Requires HTTPS)

# paths./api/me/children.post.summary
Creates a new child account with the given information (Requires HTTPS)

# paths./api/me/children.post.description
Creates a new child account with the given information (Requires HTTPS)

# paths./api/me/children/{child}.get.summary
Gives you the account information of one of your accounts' child accounts (Requires HTTPS)

# paths./api/me/children/{child}.get.description
Gives you the account information of one of your accounts' child accounts (Requires HTTPS)

# paths./api/me/children/{child}.put.summary
Updates a given child account with the given information. (Requires HTTPS) NOTE! Existing
information is replaced entirely with the new information set.

# paths./api/me/children/{child}.put.description
Updates a given child account with the given information. (Requires HTTPS) NOTE! Existing
information is replaced entirely with the new information set.

# paths./api/memberships.get.summary
Gives you a list of your contact group memberships

# paths./api/memberships.get.description
Gives you a list of your contact group memberships

# paths./api/memberships.post.summary
Creates a new contact group membership with the given information

# paths./api/memberships.post.description
Can also be used to create multiple memberships. Add the query parameter multiple and format the body as an array.

# paths./api/contacts/{contact}/memberships.get.summary
Gives you a list of your contact group memberships that a given contact is part of

# paths./api/contacts/{contact}/memberships.get.description
Gives you a list of your contact group memberships that a given contact is part of

# paths./api/groups/{group}/memberships.get.summary
Gives you a list of your contact group memberships that a given contact group is part of

# paths./api/groups/{group}/memberships.get.description
Gives you a list of your contact group memberships that a given contact group is part of

# paths./api/memberships/{membership}.get.summary
Gives you a summary of a given contact group membership

# paths./api/memberships/{membership}.get.description
Gives you a summary of a given contact group membership

# paths./api/memberships/{membership}.delete.summary
Deletes a given contact group membership

# paths./api/memberships/{membership}.delete.description
Deletes a given contact group membership

# paths./api/nkis.post.summary
Creates a new empty NKI with the given information

# paths./api/nkis.post.description
Creates a new empty NKI with the given information

# paths./api/nkis/{nki}.put.summary
Updates a given NKI with the given information. NOTE! Existing information is replaced
entirely with the new information set.

# paths./api/nkis/{nki}.put.description
Updates a given NKI with the given information. NOTE! Existing information is replaced
entirely with the new information set.

# paths./api/nkis/{nki}.delete.summary
Deletes a given NKI. NOTE! Also deletes its NKI questions, if any.

# paths./api/nkis/{nki}.delete.description
Deletes a given NKI. NOTE! Also deletes its NKI questions, if any.

# paths./api/nkis/{nki}/summary.get.summary
Gives you a result summary of a given NKI during a given time period

# paths./api/nkis/{nki}/summary.get.description
Gives you a result summary of a given NKI during a given time period

# paths./api/nkis/{nki}/summary.get.parameters[].description
Format - date-time (as date-time in RFC3339). Start of requested period (UTC, inclusive)

# paths./api/nkis/{nki}/summary.get.parameters[].description
Format - date-time (as date-time in RFC3339). End of requested period (UTC, exclusive)

# paths./api/nkis/{nki}/timeseries/{interval}.get.summary
Gives you a time series for the results of a given NKI during a given time period

# paths./api/nkis/{nki}/timeseries/{interval}.get.description
Gives you a time series for the results of a given NKI during a given time period

# paths./api/nkis/{nki}/timeseries/{interval}.get.parameters[].description
Format - int32. Interval size of each timeseries entry

# paths./api/nkis/{nki}/timeseries/{interval}.get.parameters[].description
Format - date-time (as date-time in RFC3339). Start of requested period (UTC, inclusive)

# paths./api/nkis/{nki}/timeseries/{interval}.get.parameters[].description
Format - date-time (as date-time in RFC3339). End of requested period (UTC, exclusive)

# paths./api/nkis/{nki}/send.post.summary
Send an NKI with the given information directly

# paths./api/nkis/{nki}/send.post.description
Send an NKI with the given information directly

# paths./api/nkis/{nki}/users/send.post.summary
Send an NKI with the given NKI user information directly

# paths./api/nkis/{nki}/users/send.post.description
Send an NKI with the given NKI user information directly

# paths./api/nkis/{nki}/questions.get.summary
Gives you a list of questions in a given NKI

# paths./api/nkis/{nki}/questions.get.description
Gives you a list of questions in a given NKI

# paths./api/nkis/{nki}/questions.post.summary
Creates a new empty NKI question in a given NKI with the given information

# paths./api/nkis/{nki}/questions.post.description
Creates a new empty NKI question in a given NKI with the given information

# paths./api/nkis/questions/{question}.get.summary
Gives you a summary of a given NKI question

# paths./api/nkis/questions/{question}.get.description
Gives you a summary of a given NKI question

# paths./api/nkis/questions/{question}.put.summary
Updates a given NKI question with the given information. NOTE! Existing information is
replaced entirely with the new information set. NOTE! Updating question type from slider
removes slider settings. NOTE! Updating question type to slider adds default slider settings.

# paths./api/nkis/questions/{question}.put.description
Updates a given NKI question with the given information. NOTE! Existing information is
replaced entirely with the new information set. NOTE! Updating question type from slider
removes slider settings. NOTE! Updating question type to slider adds default slider settings.

# paths./api/phonenumber/lookup.post.summary
Does a metadata lookup on the given phonenumbers

# paths./api/phonenumber/lookup.post.description
Does a metadata lookup on the given phonenumbers

# paths./api/phonenumber/lookup.post.requestBody.description
Default region and phone numbers for lookup

# paths./api/me/services/sender.get.summary
Gives you the status information of your sender service

# paths./api/me/services/sender.get.description
Gives you the status information of your sender service

# paths./api/me/services/phone.get.summary
Gives you the status information of your virtual phone number service

# paths./api/me/services/phone.get.description
Gives you the status information of your virtual phone number service

# paths./api/me/services/phone.put.summary
Updates your virtual phone number service settings, replacing them entirely with the given information

# paths./api/me/services/phone.put.description
Updates your virtual phone number service settings, replacing them entirely with the given information

# paths./api/me/services/stop.put.summary
Updates your stop service settings, replacing them entirely with the given information

# paths./api/me/services/stop.put.description
Updates your stop service settings, replacing them entirely with the given information

# paths./api/me/services/emailcopy.get.summary
Gives you the status information of your email copy service

# paths./api/me/services/emailcopy.get.description
Gives you the status information of your email copy service

# paths./api/me/services/emailcopy.put.summary
Updates your email copy service settings, replacing them entirely with the given information

# paths./api/me/services/emailcopy.put.description
Updates your email copy service settings, replacing them entirely with the given information

# paths./api/forms/simple.post.summary
Creates a new simple form with the given information

# paths./api/forms/simple.post.description
Creates a new simple form with the given information

# paths./api/forms/simple/{form}.put.summary
Updates a given simple form with the given information. NOTE! Existing information is
replaced entirely with the new information set.

# paths./api/forms/simple/{form}.put.description
Updates a given simple form with the given information. NOTE! Existing information is
replaced entirely with the new information set.

# paths./api/forms/simple/{form}/send.post.summary
Send a simple form with the given information directly

# paths./api/forms/simple/{form}/send.post.description
Send a simple form with the given information directly

# paths./api/sms/sent.get.summary
Gives you a list of your sent SMS messages filtered by given URI parameters if given

# paths./api/sms/sent.get.description
Gives you a list of your sent SMS messages filtered by given URI parameters if given

# paths./api/sms/sent.get.parameters[].description
Filter by sender name or phone number, case insensitive, accepts multiple, optional

# paths./api/sms/sent.get.parameters[].description
Filter by recipient phone number, case insensitive, accepts multiple, optional

# paths./api/sms/sent/bundle/{bundle}.get.summary
Gives you a list of your sent SMS messages in a given bundle

# paths./api/sms/sent/bundle/{bundle}.get.description
Gives you a list of your sent SMS messages in a given bundle

# paths./api/sms/send.post.summary
Send an sms with the given information directly

# paths./api/sms/send.post.description
Send an sms with the given information directly

# paths./api/sms/received.get.summary
Gives you a list of your received SMS messages filtered by given URI parameters if given

# paths./api/sms/received.get.description
Gives you a list of your received SMS messages filtered by given URI parameters if given

# paths./api/sms/received.get.parameters[].description
Filter by sender name or phone number, case insensitive, accepts multiple, optional

# paths./api/sms/received.get.parameters[].description
Filter by recipient phone number, case insensitive, accepts multiple, optional

# paths./api/surveys.post.summary
Creates a new empty survey with the given information

# paths./api/surveys.post.description
Creates a new empty survey with the given information

# paths./api/surveys/{survey}.put.summary
Updates a given survey with the given information. NOTE! Existing information is replaced
entirely with the new information set.

# paths./api/surveys/{survey}.put.description
Updates a given survey with the given information. NOTE! Existing information is replaced
entirely with the new information set.

# paths./api/surveys/{survey}.delete.summary
Deletes a given survey. NOTE! Also deletes its survey questions and their survey question
alternatives, if any.

# paths./api/surveys/{survey}.delete.description
Deletes a given survey. NOTE! Also deletes its survey questions and their survey question
alternatives, if any.

# paths./api/surveys/{survey}/contactform.get.summary
Gives you the contact form settings of a given survey

# paths./api/surveys/{survey}/contactform.get.description
Gives you the contact form settings of a given survey

# paths./api/surveys/{survey}/contactform.put.summary
Updates the contact form settings of a given survey with the given information

# paths./api/surveys/{survey}/contactform.put.description
Updates the contact form settings of a given survey with the given information

# paths./api/surveys/{survey}/image.get.summary
Gives you the image of a given survey, if any

# paths./api/surveys/{survey}/image.get.description
Gives you the image of a given survey, if any

# paths./api/surveys/{survey}/send.post.summary
Send a Survey with the given information directly

# paths./api/surveys/{survey}/send.post.description
Send a Survey with the given information directly

# paths./api/surveys/{survey}/statistics.get.summary
Gives you the statistics of a given survey

# paths./api/surveys/{survey}/statistics.get.description
Gives you the statistics of a given survey

# paths./api/surveys/{survey}/questions.get.summary
Gives you a list of questions in a given survey

# paths./api/surveys/{survey}/questions.get.description
Gives you a list of questions in a given survey

# paths./api/surveys/{survey}/questions.post.summary
Creates a new empty survey question in a given survey with the given information

# paths./api/surveys/{survey}/questions.post.description
Creates a new empty survey question in a given survey with the given information

# paths./api/surveys/questions/{question}.get.summary
Gives you a summary of a given survey question

# paths./api/surveys/questions/{question}.get.description
Gives you a summary of a given survey question

# paths./api/surveys/questions/{question}.put.summary
Updates a given survey question with the given information.
NOTE! Existing information is replaced entirely with the new information set.
NOTE! Updating question type to text or slider removes any question alternatives.
NOTE! Updating question type from slider removes slider settings.
NOTE! Upda

# paths./api/surveys/questions/{question}.put.description
Updates a given survey question with the given information.
NOTE! Existing information is replaced entirely with the new information set.
NOTE! Updating question type to text or slider removes any question alternatives.
NOTE! Updating question type from slider removes slider settings.
NOTE! Updating question type to slider adds default slider settings.

# paths./api/surveys/questions/{question}.delete.summary
Deletes a given survey question.
NOTE! Also deletes its survey question alternatives, if any.

# paths./api/surveys/questions/{question}.delete.description
Deletes a given survey question.
NOTE! Also deletes its survey question alternatives, if any.

# paths./api/surveys/questions/{question}/slider.get.summary
Gives you the slider settings of a given survey question

# paths./api/surveys/questions/{question}/slider.get.description
Gives you the slider settings of a given survey question

# paths./api/surveys/questions/{question}/slider.put.summary
Updates the slider settings of a given survey question with the given information

# paths./api/surveys/questions/{question}/slider.put.description
Updates the slider settings of a given survey question with the given information

# paths./api/surveys/questions/{question}/multiselect.get.summary
Gives you the multiselect settings of a given survey question

# paths./api/surveys/questions/{question}/multiselect.get.description
Gives you the multiselect settings of a given survey question

# paths./api/surveys/questions/{question}/multiselect.put.summary
Updates the multiselect settings of a given survey question with the given information

# paths./api/surveys/questions/{question}/multiselect.put.description
Updates the multiselect settings of a given survey question with the given information

# paths./api/surveys/questions/{question}/statistics.get.summary
Gives you the statistics of a given survey question

# paths./api/surveys/questions/{question}/statistics.get.description
Gives you the statistics of a given survey question

# paths./api/surveys/questions/{question}/answers.get.summary
Gives you the answers with comments of a given survey question

# paths./api/surveys/questions/{question}/answers.get.description
Gives you the answers with comments of a given survey question

# paths./api/surveys/questions/{question}/alternatives.get.summary
Gives you a list of alternatives of a given survey question

# paths./api/surveys/questions/{question}/alternatives.get.description
Gives you a list of alternatives of a given survey question

# paths./api/surveys/questions/{question}/alternatives.post.summary
Creates a new survey question alternative in a given survey question with the given information

# paths./api/surveys/questions/{question}/alternatives.post.description
Creates a new survey question alternative in a given survey question with the given information

# paths./api/surveys/questions/{question}/alternatives.post.requestBody.description
Alternative data of new question alternative

# paths./api/surveys/questions/alternatives/{alternative}.get.summary
Gives you a summary of a given survey question alternative

# paths./api/surveys/questions/alternatives/{alternative}.get.description
Gives you a summary of a given survey question alternative

# paths./api/surveys/questions/alternatives/{alternative}.put.summary
Updates a given survey question alternative with the given information.
NOTE! Existing information is replaced entirely with the new information set.

# paths./api/surveys/questions/alternatives/{alternative}.put.description
Updates a given survey question alternative with the given information.
NOTE! Existing information is replaced entirely with the new information set.

# paths./api/surveys/questions/alternatives/{alternative}.delete.summary
Deletes a given survey question alternative

# paths./api/surveys/questions/alternatives/{alternative}.delete.description
Deletes a given survey question alternative

# paths./api/sms/templates.post.summary
Creates a new SMS template with the given information

# paths./api/sms/templates.post.description
Creates a new SMS template with the given information

# paths./api/sms/templates/{template}.put.summary
Updates a given SMS template with the given information. NOTE! Existing information is
replaced entirely with the new information set.

# paths./api/sms/templates/{template}.put.description
Updates a given SMS template with the given information. NOTE! Existing information is
replaced entirely with the new information set.

# paths./api/groups/{group}/contacts/extra.get.summary
Gives you a list of the extra fields of your contacts in a given contact group

# paths./api/groups/{group}/contacts/extra.get.description
Gives you a list of the extra fields of your contacts in a given contact group

# paths./api/me/services.get.summary
Gives you the status information of all your services

# paths./api/me/services.get.description
Gives you the status information of all your services

# components.schemas.AuthenticationDTO.properties.Created.description
When the SMS authentication was created/started (UTC/GMT)

# components.schemas.AuthenticationDTO.properties.HasExpired.description
Whether the SMS authentication has expired

# components.schemas.AuthenticationDTO.properties.Expires.description
When the SMS authentication will expire (UTC/GMT)

# components.schemas.AuthenticationDTO.properties.IsUsed.description
Whether the SMS authentication has been used

# components.schemas.AuthenticationDTO.properties.Used.description
When the SMS authentication was used, if used (UTC/GMT)

# components.schemas.AuthenticationNewDTO.properties.From.description
Sending name or phone number, default iP1

# components.schemas.AuthenticationNewDTO.properties.Length.description
SMS authentication code length, default 5

# components.schemas.AuthenticationNewDTO.properties.ExpirationTime.description
Amount of time (in seconds) until the SMS authentication expires, default 1200 (20 minutes)

# components.schemas.AuthenticationNewDTO.properties.NumericOnly.description
Whether to force the code to be only numbers, default false

# components.schemas.AuthenticationNewDTO.description
Data for creating a new SMS authentication

# components.schemas.AuthenticationValidationRequest.description
Represents a request to validate an SMS authentication code

# components.schemas.AuthenticationValidationResponse.properties.Valid.description
Whether the authentication code was valid for the given phone number

# components.schemas.AuthenticationValidationResponse.description
Represents the result of an SMS authentication code validation

# components.schemas.AuthenticationSettingsDTO.properties.ConcurrentLimit.description
The maximum number of allowed active SMS authentications per phone number, default 5

# components.schemas.AuthenticationSettingsDTO.properties.From.description
Sending name or phone number, default iP1

# components.schemas.AuthenticationSettingsDTO.properties.Length.description
SMS authentication code length, default 5

# components.schemas.AuthenticationSettingsDTO.properties.ExpirationTime.description
Amount of time (in seconds) until the SMS authentication expires, default 1200 (20 minutes)

# components.schemas.AuthenticationSettingsDTO.properties.NumericOnly.description
Whether to force the code to be only numbers, default false

# components.schemas.AuthenticationSettingsDTO.description
Represents your account default SMS authentication settings, null = unset. These settings
override system defaults and is overidden by request parameters.

# components.schemas.BlacklistEntryDTO.properties.Created.description
Timestamp when blacklist entry was added

# components.schemas.BlacklistEntryNewDTO.description
Data for creation of an new blacklist entry

# components.schemas.ContactFullDTO.properties.Modified.description
Timestamp when contact was last modified

# components.schemas.ContactFieldNewDTO.description
Data for creation of a new contact extra field

# components.schemas.GroupDTO.properties.Modified.description
Timestamp when contact group was last modified

# components.schemas.GroupDTO.properties.Color.description
Contact group color, hexadecimal (ex. #ffffff)

# components.schemas.GroupNewDTO.properties.Color.description
Contact group color, hexadecimal (ex. #ffffff)

# components.schemas.GroupNewDTO.description
Data for creation of a new contact group

# components.schemas.GroupUpdateDTO.properties.Color.description
Contact group color, hexadecimal (ex. #ffffff)

# components.schemas.MembershipDTO.properties.OwnerID.description
ID of account owning the contact group membership

# components.schemas.MembershipNewDTO.description
Data for creation of a new contact group membership

# components.schemas.NKINewDTO.properties.TextColor.description
Color of NKI text, hexadecimal (ex. #333333)

# components.schemas.NKINewDTO.properties.BackgroundColor.description
Color of NKI background, hexadecimal (ex. #eeeeee)

# components.schemas.NKINewDTO.properties.ButtonColor.description
Color of NKI buttons, hexadecimal (ex. #a1c775)

# components.schemas.NKIFullDTO.properties.TextColor.description
Color of NKI text, hexadecimal (ex. #333333)

# components.schemas.NKIFullDTO.properties.BackgroundColor.description
Color of NKI background, hexadecimal (ex. #eeeeee)

# components.schemas.NKIFullDTO.properties.ButtonColor.description
Color of NKI buttons, hexadecimal (ex. #a1c775)

# components.schemas.NKIUpdateDTO.properties.TextColor.description
Color of NKI text, hexadecimal (ex. #333333)

# components.schemas.NKIUpdateDTO.properties.BackgroundColor.description
Color of NKI background, hexadecimal (ex. #eeeeee)

# components.schemas.NKIUpdateDTO.properties.ButtonColor.description
Color of NKI buttons, hexadecimal (ex. #a1c775)

# components.schemas.NKISummaryDTO.properties.OpenCount.description
Number of recipients that have opened/started the NKI survey

# components.schemas.NKISummaryDTO.properties.OpenPercent.description
Percentage of recipients that have opened/started the NKI survey

# components.schemas.NKISummaryDTO.properties.UnopenCount.description
Number of recipients that have not yet opened/started the NKI survey

# components.schemas.NKISummaryDTO.properties.UnopenPercent.description
Percentage of recipients that have not yet opened/started the NKI survey

# components.schemas.NKISummaryDTO.properties.IncompleteCount.description
Number of recipients that have opened/started the NKI survey but not yet completed it

# components.schemas.NKISummaryDTO.properties.IncompletePercent.description
Percentage of recipients that have opened/started the NKI survey but not yet completed it

# components.schemas.NKISummaryDTO.properties.CompleteCount.description
Number of recipients that have completed the NKI survey

# components.schemas.NKISummaryDTO.properties.CompletePercent.description
Percentage of recipients that have completed the NKI survey

# components.schemas.NKISummaryDTO.properties.PeriodStart.description
Timestamp for the start of the requested period, inclusive

# components.schemas.NKISummaryDTO.properties.PeriodEnd.description
Timestamp for the end of the requested period, exclusive

# components.schemas.NKISummaryDTO.description
Summary of NKI results for a given period of time

# components.schemas.NKITimeSeriesEntryDTO.properties.PeriodStart.description
Timestamp for the start of the requested period, inclusive

# components.schemas.NKITimeSeriesEntryDTO.properties.PeriodEnd.description
Timestamp for the end of the requested period, exclusive

# components.schemas.NKITimeSeriesEntryDTO.description
Periodic entry in an NKI result time series

# components.schemas.OutgoingSMSDTO.properties.Email.description
Whether to send SMS copies by email (for contacts with email addresses)

# components.schemas.ProcessedOutgoingSMSDTO.properties.CountryCode.description
Country code of destination phone number if To field is valid, otherwise null

# components.schemas.ProcessedOutgoingSMSDTO.properties.Currency.description
What currency the SMS was payed in. Is displayed as ISO 4217 Alphabetic code

# components.schemas.ProcessedOutgoingSMSDTO.properties.TotalPrice.description
The price for sending the entire message

# components.schemas.ProcessedOutgoingSMSDTO.properties.Price.description
The price for sending each segment of the message

# components.schemas.ProcessedOutgoingSMSDTO.properties.Encoding.description
Encoding in which the message was encoded

# components.schemas.ProcessedOutgoingSMSDTO.properties.Segments.description
The number of segments the message consists of

# components.schemas.OutgoingNKIDTO.properties.Email.description
Whether to send SMS copies by email (for contacts with email addresses)

# components.schemas.OutgoingNKIDTO.description
Custom SMS message information with NKI users as recipients

# components.schemas.PhoneNumberResponseDTO.properties.PhoneNumbers.description
A collection of checked phonenumbers with metadata

# components.schemas.PhoneNumberDTO.properties.Input.description
The original value provided by the client

# components.schemas.PhoneNumberDTO.properties.NationalFormat.description
The phone number in international format.

# components.schemas.PhoneNumberDTO.properties.InternationalFormat.description
The phone number in national/local format.

# components.schemas.PhoneNumberDTO.properties.CountryCode.description
The country calling code for this number.

# components.schemas.PhoneNumberDTO.properties.IsValid.description
If the phonenumber provided is in the valid format (for the region if applicable)

# components.schemas.SenderServiceStatusDTO.properties.DefaultSender.description
The default sender for SMS messages (non-API), if any

# components.schemas.VirtualPhoneServiceStatusDTO.properties.VirtualPhone.description
The virtual phone number associated with the account, if any

# components.schemas.VirtualPhoneServiceStatusDTO.properties.VirtualPhonePrefix.description
The virtual phone prefix associated with the account, if any

# components.schemas.VirtualPhoneServiceStatusDTO.properties.Email.description
The incoming email address associated with the account, if any

# components.schemas.VirtualPhoneServiceStatusDTO.properties.PlainEmail.description
Whether the email should be plain text or not

# components.schemas.VirtualPhoneServiceStatusDTO.properties.CallbackURL.description
URL that should be called when incoming SMS are received, if any

# components.schemas.VirtualPhoneServiceStatusDTO.description
Current status of a virtual phone number service

# components.schemas.VirtualPhoneSettingsDTO.properties.Email.description
The incoming email address associated with the account, if any

# components.schemas.VirtualPhoneSettingsDTO.properties.PlainEmail.description
Whether the email sent out should be plain text or not

# components.schemas.VirtualPhoneSettingsDTO.properties.CallbackURL.description
URL that should be called when incoming SMS are received, if any

# components.schemas.VirtualPhoneSettingsDTO.description
Data for updating virtual phone number service settings

# components.schemas.StopServiceDTO.properties.Active.description
Whether the Stop service is active or not

# components.schemas.StopServiceDTO.properties.Append.description
Whether the message should be appended to all the messages

# components.schemas.EmailCopyServiceStatusDTO.properties.SenderAddress.description
The address the email should be sent from

# components.schemas.EmailCopyDTO.properties.SenderAddress.description
The address the email should be sent from

# components.schemas.EmailCopyDTO.description
Data for updating email copy service settings

# components.schemas.SimpleFormDTO.properties.Created.description
Timestamp when the simple form was created

# components.schemas.LoggedOutgoingSMSDTO.properties.Modified.description
Date of latest modification/status update

# components.schemas.LoggedOutgoingSMSDTO.properties.CountryCode.description
Country code of destination phone number if To field is valid, otherwise null

# components.schemas.LoggedOutgoingSMSDTO.properties.Currency.description
What currency the SMS was payed in. Is displayed as ISO 4217 Alphabetic code

# components.schemas.LoggedOutgoingSMSDTO.properties.TotalPrice.description
The price for sending the entire message

# components.schemas.LoggedOutgoingSMSDTO.properties.Price.description
The price for sending each segment of the message

# components.schemas.LoggedOutgoingSMSDTO.properties.Encoding.description
Encoding in which the message was encoded

# components.schemas.LoggedOutgoingSMSDTO.properties.Segments.description
The number of segments the message consists of

# components.schemas.SurveyDTO.properties.Modified.description
Timestamp for last modification of survey

# components.schemas.SurveyDTO.properties.Ended.description
Whether the survey has ended or is closed

# components.schemas.SurveyDTO.properties.Ends.description
Timestamp for survey end, or null if not set

# components.schemas.SurveyNewDTO.properties.KeywordResponse.description
If you have a virtual phone number and recieve an SMS beginning with the value of the keyword property this string will be sent as a response.

# components.schemas.SurveyNewDTO.properties.AllowAnonymous.description
Whether to enable recipients to remain anonymous

# components.schemas.SurveyNewDTO.properties.TextColor.description
Color of survey text, hexadecimal (ex. #333333)

# components.schemas.SurveyNewDTO.properties.BackgroundColor.description
Color of survey background, hexadecimal (ex. #eeeeee)

# components.schemas.SurveyNewDTO.properties.ButtonColor.description
Color of survey buttons, hexadecimal (ex. #a1c775)

# components.schemas.SurveyNewDTO.properties.AlarmRecipient.description
Phone number that alarms should be sent to when triggered

# components.schemas.SurveyNewDTO.properties.Ends.description
Timestamp for survey end, or null if not set

# components.schemas.SurveyFullDTO.properties.Modified.description
Timestamp for last modification of survey

# components.schemas.SurveyFullDTO.properties.Ended.description
Whether the survey has ended or is closed

# components.schemas.SurveyFullDTO.properties.KeywordResponse.description
If you have a virtual phone number and recieve an SMS beginning with the value of the keyword property this string will be sent as a response.

# components.schemas.SurveyFullDTO.properties.AllowAnonymous.description
Whether to enable recipients to remain anonymous

# components.schemas.SurveyFullDTO.properties.TextColor.description
Color of survey text, hexadecimal (ex. #333333)

# components.schemas.SurveyFullDTO.properties.BackgroundColor.description
Color of survey background, hexadecimal (ex. #eeeeee)

# components.schemas.SurveyFullDTO.properties.ButtonColor.description
Color of survey buttons, hexadecimal (ex. #a1c775)

# components.schemas.SurveyFullDTO.properties.AlarmRecipient.description
Phone number that alarms should be sent to when triggered

# components.schemas.SurveyFullDTO.properties.Ends.description
Timestamp for survey end, or null if not set

# components.schemas.SurveyUpdateDTO.properties.KeywordResponse.description
If you have a virtual phone number and recieve an SMS beginning with the value of the keyword property this string will be sent as a response.

# components.schemas.SurveyUpdateDTO.properties.AllowAnonymous.description
Whether to enable recipients to remain anonymous

# components.schemas.SurveyUpdateDTO.properties.TextColor.description
Color of survey text, hexadecimal (ex. #333333)

# components.schemas.SurveyUpdateDTO.properties.BackgroundColor.description
Color of survey background, hexadecimal (ex. #eeeeee)

# components.schemas.SurveyUpdateDTO.properties.ButtonColor.description
Color of survey buttons, hexadecimal (ex. #a1c775)

# components.schemas.SurveyUpdateDTO.properties.AlarmRecipient.description
Phone number that alarms should be sent to when triggered

# components.schemas.SurveyUpdateDTO.properties.Ends.description
Timestamp for survey end, or null if not set

# components.schemas.SurveyContactFormDTO.properties.Include.description
Whether to include a contact form in the Survey

# components.schemas.SurveyContactFormDTO.description
Data for updating the contact form settings of a Survey

# components.schemas.SurveyContactFormFieldDTO.properties.Include.description
Whether to include the field in the contact form

# components.schemas.SurveyContactFormFieldDTO.properties.Comment.description
Text explaining to users what to enter in the field

# components.schemas.SurveyContactFormCustomFieldDTO.properties.Include.description
Whether to include the field in the contact form

# components.schemas.SurveyContactFormCustomFieldDTO.properties.Comment.description
Text explaining to users what to enter in the field

# components.schemas.SurveyContactFormCustomFieldDTO.description
Survey contact form custom field settings

# components.schemas.OutgoingSurveyDTO.properties.Email.description
Whether to send SMS copies by email (for contacts with email addresses)

# components.schemas.OutgoingSurveyDTO.properties.Message.description
SMS message contents
null or empty string will be replaced by the survey's {!:SurveyFullDTO.KeywordResponse} or the global default

# components.schemas.SurveyStatisticsDTO.properties.Opened.description
Number of recipients of the survey who has opened it

# components.schemas.SurveyStatisticsDTO.properties.OpenedPercentage.description
Portion of recipients of the survey who has opened it

# components.schemas.SurveyStatisticsDTO.properties.Unfinished.description
Number of recipents of the survey who has opened it but not yet answered it

# components.schemas.SurveyStatisticsDTO.properties.UnfinishedPercentage.description
Portion of recipents of the survey who has opened it but not yet answered it

# components.schemas.SurveyStatisticsDTO.properties.Answered.description
Number of recipients of the survey who has answered it

# components.schemas.SurveyStatisticsDTO.properties.AnsweredPercentage.description
Portion of recipients of the survey who has answered it

# components.schemas.SurveyStatisticsDTO.properties.Modified.description
Timestamp for last modification of survey

# components.schemas.SurveyStatisticsDTO.properties.Ended.description
Whether the survey has ended or is closed

# components.schemas.SurveyStatisticsDTO.properties.Ends.description
Timestamp for survey end, or null if not set

# components.schemas.SurveyQuestionDTO.properties.Commentable.description
Whether a comment can be left along with the answer

# components.schemas.SurveyQuestionNewDTO.properties.Commentable.description
Whether a comment can be left along with the answer

# components.schemas.SurveyQuestionNewDTO.description
Data for creation of a new survey question

# components.schemas.SurveyQuestionUpdateDTO.properties.Commentable.description
Whether a comment can be left along with the answer

# components.schemas.SurveyQuestionSliderDTO.properties.AlarmTriggerLevel.description
Threshold below or equal which alarm should be triggered, if any

# components.schemas.SurveyQuestionMultiselectDTO.properties.Min.description
Minimum number of alternatives to select

# components.schemas.SurveyQuestionMultiselectDTO.properties.Max.description
Maximum number of alternatives to select

# components.schemas.SurveyQuestionStatisticsDTO.properties.AlternativeAnswers.description
Statistics for each alternative answer, if any

# components.schemas.SurveyQuestionStatisticsDTO.properties.NumericalAnswers.description
Statistics for each numerical/slider answer, if any

# components.schemas.SurveyQuestionStatisticsDTO.properties.Commentable.description
Whether a comment can be left along with the answer

# components.schemas.SurveyQuestionStatisticsDTO.description
Survey question answer statistics summary

# components.schemas.SurveyQuestionStatisticsAlternativeDTO.properties.Order.description
Alternative order index in question, alternatives at same index gets shuffled

# components.schemas.SurveyQuestionStatisticsAlternativeDTO.properties.AlarmTrigger.description
Whether the alternative should trigger the survey alarm. Defaults to false.

# components.schemas.SurveyQuestionStatisticsAlternativeDTO.description
Survey question alternative answer statistics

# components.schemas.SurveyQuestionStatisticsNumericalDTO.description
Survey question numerical answer statistics

# components.schemas.SurveyQuestionAnswerDTO.properties.NumericalAnswer.description
Numerical/slider answer, if slider question

# components.schemas.SurveyQuestionAlternativeDTO.properties.Order.description
Alternative order index in question, alternatives at same index gets shuffled

# components.schemas.SurveyQuestionAlternativeDTO.properties.AlarmTrigger.description
Whether the alternative should trigger the survey alarm. Defaults to false.

# components.schemas.SurveyUserDTO.properties.Opened.description
Timestamp when survey was last opened, if opened

# components.schemas.SurveyUserDTO.properties.Answered.description
Timestamp when survey was answered, if answered

# components.schemas.SurveyQuestionAlternativeNewDTO.properties.Order.description
Alternative order index in question, alternatives at same index gets shuffled

# components.schemas.SurveyQuestionAlternativeNewDTO.properties.AlarmTrigger.description
Whether the alternative should trigger the survey alarm. Defaults to false.

# components.schemas.SurveyQuestionAlternativeNewDTO.description
Data for creation of a new survey question alternative

# components.schemas.SurveyQuestionAlternativeUpdateDTO.properties.Order.description
Alternative order index in question, alternatives at same index gets shuffled

# components.schemas.SurveyQuestionAlternativeUpdateDTO.properties.AlarmTrigger.description
Whether the alternative should trigger the survey alarm. Defaults to false.

# components.schemas.SurveyQuestionAlternativeUpdateDTO.description
Data for updating a survey question alternative

# components.schemas.TemplateDTO.properties.Modified.description
Timestamp for latest modification of the SMS template