Authentication
Handles access to your SMS authentications
| API | Description |
|---|---|
| GET api/authentications |
Gives you a list of your SMS authentications |
| GET api/authentications/{authentication} |
Gives you a given SMS authentication |
| POST api/authentications |
Creates and sends a new SMS authentication with the given information |
| DELETE api/authentications/{authentication} |
Deletes a given SMS authentication |
| POST api/authentications/validate |
Validates a given SMS authentication code, a valid code is considered used |
| GET api/authentications/settings |
Gets your current default settings for new SMS authentications |
| PUT api/authentications/settings |
Updates your default settings for new SMS authentications |
Blacklist
Handles access to your blacklist
| API | Description |
|---|---|
| GET api/blacklist |
Gives you your blacklist |
| GET api/blacklist/{entry} |
Gives you a given blacklist entry |
| POST api/blacklist |
Creates a new blacklist entry with the given information |
| POST api/blacklist?multiple={multiple} |
Creates multiple new blacklist entries with the given information |
| DELETE api/blacklist/{entry} |
Deletes a given blacklist entry |
Contact
Handles access to your contacts
| API | Description |
|---|---|
| GET api/contacts?PhoneNumbers[0]={PhoneNumbers[0]}&PhoneNumbers[1]={PhoneNumbers[1]} |
Gives you a list of your contacts |
| GET api/groups/{group}/contacts |
Gives you a list of your contacts in a given contact group |
| GET api/groups/{group}/contacts/extra |
Gives you a list of the extra fields of your contacts in a given contact group |
| GET api/contacts/{contact} |
Gives you a summary of a given contact |
| POST api/contacts |
Creates a new contact with the given information |
| POST api/contacts?multiple={multiple} |
Adds a number of contacts with the collection of contacts given |
| PUT api/contacts/{contact} |
Updates a given contact with the given information. NOTE! Existing information is replaced entirely with the new information set. |
| DELETE api/contacts/{contact} |
Deletes a given contact. NOTE! Also deletes its group memberships, if any. |
| GET api/contacts/{contact}/extra |
Gets the extra fields of a given contact |
| POST api/contacts/{contact}/extra |
Creates a new extra field for a given contact with the given information |
| GET api/contacts/extra |
Gets the extra fields of all contacts |
| GET api/contacts/extra/{extra} |
Gives you a summary of a given extra field |
| PUT api/contacts/extra/{extra} |
Updates a given extra field with the given information. NOTE! Existing information is replaced entirely with the new information set. |
| DELETE api/contacts/extra/{extra} |
Deletes a given extra field |
Group
Handles access to your contact groups
| API | Description |
|---|---|
| GET api/groups?Names[0]={Names[0]}&Names[1]={Names[1]} |
Gives you a list of your contact groups |
| GET api/contacts/{contact}/groups |
Gives you a list of your contact groups that a given contact is a member of |
| GET api/groups/{group} |
Gives you a summary of a given contact group |
| POST api/groups |
Creates a new contact group with the given information |
| POST api/groups?multiple={multiple} |
Creates a new contact group with the given information |
| PUT api/groups/{group} |
Updates a given contact group with the given information. NOTE! Existing information is replaced entirely with the new information set. |
| DELETE api/groups/{group} |
Deletes a given contact group. NOTE! Also deletes its group memberships, if any. |
Me
Handles access to your account information
| API | Description |
|---|---|
| GET api/me |
Gives you a summary of your account |
| GET api/me/account |
Gives you your account information (Requires HTTPS) |
| GET api/me/prices |
Gives you your SMS prices by country |
| GET api/me/children |
Gives you a list of your accounts' child accounts (Requires HTTPS) |
| GET api/me/children/{child} |
Gives you the account information of one of your accounts' child accounts (Requires HTTPS) |
| POST api/me/children |
Creates a new child account with the given information (Requires HTTPS) |
| PUT api/me/children/{child} |
Updates a given child account with the given information. (Requires HTTPS) NOTE! Existing information is replaced entirely with the new information set. |
Membership
Handles access to your contact group memberships
| API | Description |
|---|---|
| GET api/memberships |
Gives you a list of your contact group memberships |
| GET api/contacts/{contact}/memberships |
Gives you a list of your contact group memberships that a given contact is part of |
| GET api/groups/{group}/memberships |
Gives you a list of your contact group memberships that a given contact group is part of |
| GET api/memberships/{membership} |
Gives you a summary of a given contact group membership |
| POST api/memberships |
Creates a new contact group membership with the given information |
| POST api/memberships?multiple={multiple} |
Creates a collection of contact group membership with the given information. This is an all or nothing enpoint meaning if one membership is invalid none will be added. |
| DELETE api/memberships/{membership} |
Deletes a given contact group membership |
NKI
Handles access to your NKIs
| API | Description |
|---|---|
| GET api/nkis |
Gives you a list of your NKIs |
| GET api/nkis/{nki} |
Gives you a summary of a given NKI |
| GET api/nkis/{nki}/summary?begin={begin}&end={end} |
Gives you a result summary of a given NKI during a given time period |
| GET api/nkis/{nki}/timeseries/{interval}?begin={begin}&end={end} |
Gives you a time series for the results of a given NKI during a given time period |
| POST api/nkis |
Creates a new empty NKI with the given information |
| PUT api/nkis/{nki} |
Updates a given NKI with the given information. NOTE! Existing information is replaced entirely with the new information set. |
| DELETE api/nkis/{nki} |
Deletes a given NKI. NOTE! Also deletes its NKI questions, if any. |
| POST api/nkis/{nki}/send |
Send an NKI with the given information directly |
| POST api/nkis/{nki}/users/send |
Send an NKI with the given NKI user information directly |
NKIQuestion
Handles access to your NKI questions
| API | Description |
|---|---|
| GET api/nkis/{nki}/questions |
Gives you a list of questions in a given NKI |
| GET api/nkis/questions/{question} |
Gives you a summary of a given NKI question |
| POST api/nkis/{nki}/questions |
Creates a new empty NKI question in a given NKI with the given information |
| PUT api/nkis/questions/{question} |
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. |
| DELETE api/nkis/questions/{question} |
Deletes a given NKI question. |
PhoneNumber
Utility functions for looking up metadata about phone numbers
| API | Description |
|---|---|
| POST api/phonenumber/lookup |
Does a metadata lookup on the given phonenumbers |
Service
Handles access to your service information
| API | Description |
|---|---|
| GET api/me/services |
Gives you the status information of all your services |
| GET api/me/services/sender |
Gives you the status information of your sender service |
| GET api/me/services/phone |
Gives you the status information of your virtual phone number service |
| PUT api/me/services/phone |
Updates your virtual phone number service settings, replacing them entirely with the given information |
| GET api/me/services/stop |
Gives you your stop service settings |
| PUT api/me/services/stop |
Updates your stop service settings, replacing them entirely with the given information |
| GET api/me/services/emailcopy |
Gives you the status information of your email copy service |
| PUT api/me/services/emailcopy |
Updates your email copy service settings, replacing them entirely with the given information |
SimpleForm
Handles access to your simple forms
| API | Description |
|---|---|
| GET api/forms/simple |
Gives you a list of your simple forms |
| GET api/forms/simple/{form} |
Gives you a given simple form |
| PUT api/forms/simple/{form} |
Updates a given simple form with the given information. NOTE! Existing information is replaced entirely with the new information set. |
| POST api/forms/simple |
Creates a new simple form with the given information |
| DELETE api/forms/simple/{form} |
Deletes a given simple form. |
| POST api/forms/simple/{form}/send |
Send a simple form with the given information directly |
SMS
Handles access to your SMS messages
| API | Description |
|---|---|
| GET api/sms/sent?from[0]={from[0]}&from[1]={from[1]}&to[0]={to[0]}&to[1]={to[1]} |
Gives you a list of your sent SMS messages filtered by given URI parameters if given |
| GET api/sms/sent/bundle/{bundle} |
Gives you a list of your sent SMS messages in a given bundle |
| GET api/sms/sent/{sms} |
Gives you a given sent SMS message |
| POST api/sms/send |
Send an sms with the given information directly |
| GET api/sms/received?from[0]={from[0]}&from[1]={from[1]}&to[0]={to[0]}&to[1]={to[1]} |
Gives you a list of your received SMS messages filtered by given URI parameters if given |
| GET api/sms/received/{sms} |
Gives you a given received SMS message |
Survey
Handles access to your surveys
| API | Description |
|---|---|
| GET api/surveys |
Gives you a list of your surveys |
| GET api/surveys/active |
Gives you a list of your active surveys |
| GET api/surveys/ended |
Gives you a list of your ended surveys |
| GET api/surveys/{survey} |
Gives you a summary of a given survey |
| POST api/surveys |
Creates a new empty survey with the given information |
| PUT api/surveys/{survey} |
Updates a given survey with the given information. NOTE! Existing information is replaced entirely with the new information set. |
| DELETE api/surveys/{survey} |
Deletes a given survey. NOTE! Also deletes its survey questions and their survey question alternatives, if any. |
| GET api/surveys/{survey}/contactform |
Gives you the contact form settings of a given survey |
| PUT api/surveys/{survey}/contactform |
Updates the contact form settings of a given survey with the given information |
| GET api/surveys/{survey}/image |
Gives you the image of a given survey, if any |
| POST api/surveys/{survey}/image |
Adds an image to a given survey |
| PUT api/surveys/{survey}/image |
Updates the image of a given survey |
| DELETE api/surveys/{survey}/image |
Deletes the image of a given survey |
| POST api/surveys/{survey}/send |
Send a Survey with the given information directly |
| GET api/surveys/{survey}/statistics |
Gives you the statistics of a given survey |
SurveyQuestion
Handles access to your survey questions
| API | Description |
|---|---|
| GET api/surveys/{survey}/questions |
Gives you a list of questions in a given survey |
| GET api/surveys/questions/{question} |
Gives you a summary of a given survey question |
| POST api/surveys/{survey}/questions |
Creates a new empty survey question in a given survey with the given information |
| PUT api/surveys/questions/{question} |
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. |
| DELETE api/surveys/questions/{question} |
Deletes a given survey question. NOTE! Also deletes its survey question alternatives, if any. |
| GET api/surveys/questions/{question}/slider |
Gives you the slider settings of a given survey question |
| PUT api/surveys/questions/{question}/slider |
Updates the slider settings of a given survey question with the given information |
| GET api/surveys/questions/{question}/multiselect |
Gives you the multiselect settings of a given survey question |
| PUT api/surveys/questions/{question}/multiselect |
Updates the multiselect settings of a given survey question with the given information |
| GET api/surveys/questions/{question}/statistics |
Gives you the statistics of a given survey question |
| GET api/surveys/questions/{question}/answers |
Gives you the answers with comments of a given survey question |
SurveyQuestionAlternative
Handles access to your survey question alternatives
| API | Description |
|---|---|
| GET api/surveys/questions/{question}/alternatives |
Gives you a list of alternatives of a given survey question |
| GET api/surveys/questions/alternatives/{alternative} |
Gives you a summary of a given survey question alternative |
| POST api/surveys/questions/{question}/alternatives |
Creates a new survey question alternative in a given survey question with the given information |
| PUT api/surveys/questions/alternatives/{alternative} |
Updates a given survey question alternative with the given information. NOTE! Existing information is replaced entirely with the new information set. |
| DELETE api/surveys/questions/alternatives/{alternative} |
Deletes a given survey question alternative |
Template
Handles access to your SMS templates
| API | Description |
|---|---|
| GET api/sms/templates |
Gives you a list of your SMS templates |
| GET api/sms/templates/{template} |
Gives you a given SMS template |
| PUT api/sms/templates/{template} |
Updates a given SMS template with the given information. NOTE! Existing information is replaced entirely with the new information set. |
| POST api/sms/templates |
Creates a new SMS template with the given information |
| DELETE api/sms/templates/{template} |
Deletes a given SMS template |