To import the user's profile into Inbox Suite, send the GET request to the following URL: https://intrust.inboxsuite.com/
https://intrust.inboxsuite.com/?apikey=API_KEY&email=PROFILE-EMAIL&ip=PROFILE-IP-ADDRESS&sourceurl=SUBSCRIBE-SOURCE-URL®date=PROFILE-REGISTRATION-DATE&status=SUBSCRIBE-STATUS
To import real time traffic use status 11, example:
https://intrust.inboxsuite.com/?apikey=API_KEY&email=PROFILE-EMAIL&ip=PROFILE-IP-ADDRESS&sourceurl=SUBSCRIBE-SOURCE-URL®date=PROFILE-REGISTRATION-DATE&status=11
To import legacy traffic (registrations you received earlier and you want to reactivate them) use status 100, example:
https://intrust.inboxsuite.com/?apikey=API_KEY&email=PROFILE-EMAIL&ip=PROFILE-IP-ADDRESS&sourceurl=SUBSCRIBE-SOURCE-URL®date=PROFILE-REGISTRATION-DATE&status=100
Post request example:
https://intrust.inboxsuite.com/?apikey=kgu8s18gibwy2vdv&email=johndoe@gmail.com&ip=125.843.24.29&sourceurl=yourwebsite.com®date= 2019-08-24T16:27:00&status=11
Required parameters
| Name | Description | Example |
|---|---|---|
| apikey | your personal authorization key. Please contact your account manager for the exact value. | kgu8s18gibwy2vdv |
| the profile’s email address. Must conform to RFC 822. | johndoe@gmail.com | |
| ip | the profile’s IP address. Must comply with the format IPv4 or IPv6. | 125.843.24.29 |
| sourceurl | the URL of the website where was the profile subscription event. Should be encoded according to RFC 3986. | yourwebsite.com |
| regdate |
the timestamp of the registration date/time in the "YYYY-MM-DDTHH:MM:SS" format. List of additional supported formats: YYYY-MM-DD 2006-01-02 YYYY-MM-DDTHH:mm:ss 2006-01-02T15:04:05 YYYY-MM-DDTHH:mm:ss.000 2006-01-02T15:04:05.123 YYYY-MM-DDTHH:mm:ss.000000 2006-01-02T15:04:05.123456 YYYY-MM-DD HH:mm:ss 2006-01-02 15:04:05 YYYY-MM-DD HH:mm:ss.000 2006-01-02 15:04:05.123 YYYY-MM-DD HH:mm:ss.000000 2006-01-02 15:04:05.123456 YYYY-MM-DD HH:mm:ss(+/-)TZO 2006-01-02T15:04:05-07:00 M/D/YYYY 1/2/2006 M/D/YYYY HH:mm:ss 1/2/2006 15:04:05 MM/dd/yyyy HH:mm:ss 01/22/2006 15:04:05 |
2019-08-24T16:27:00 |
| status | the profile’s status. Integer. Please pass the following values according to the desired status: | 11 |
| 11 — subscriber | ||
| 12 — confirmer | ||
| 10 — unsubscriber | ||
| 100 - legacy | ||
| 1000 — complainer |
| Name | Description | Example |
|---|---|---|
| token | the profile’s identifier on the website. It helps to identify the profile while using the editorial feeds | 0cc0891c8f9720688f33e86297a370 |
| fname | the profile’s first name | John |
| lname | the profile’s last name | Doe |
| phone | the profile’s phone number | 213-209-9068 |
| gender | the profile’s gender. “M” or “F” values are accepted | M |
| refid | a specially formatted string for the email campaign optimization purposes. It is highly recommended to use this option for later analysis of the results. | ch-cpc_src-direct_lp-yoursite.com |
| site00 - site19 |
custom parameters that could be relevant to your business and desired email mechanics. These parameters should be discussed and pre-configured on the Inbox Suite side. Please contact your account manager for more details. |
site00=5000 |
Please format the refid parameter as follows: ch-{TRAFFIC_CHANNEL}_src-{TRAFFIC_SOURCE}_lp-{LP_NAME}
| referral | traffic from another site |
| traffic from emails | |
| cpc | contextual ads |
| social | social ads |
| display | display ads |
| push | browser push ads |
| cpa | CPA offer traffic |
| directenter | organic traffic |
| coreg | coregistration |
You are required to pass the “direct” string for organic traffic. Only letters and digits are allowed.
List of parameters that are recommended to be passed during import after consultation with Inbox Suite support.
| Name | Description |
|---|---|
| hb | HardBounce status of profile |
| hb_ts | The time when the profile received the status of HardBounce |
| hb_source | Source from where hardbounce statuses were received |
| hb_reason | The reason for which the HardBounce status was received |
| sb | SpamBot status of profile |
| sb_ts | The time when the profile received the status of SpamBot |
| sb_source | The time when the profile received the status of SpamBot |
In some cases, profile fields can be overwritten according to the following table of guidelines:
| Initial status | Final status | Rewritable fields* |
|---|---|---|
| 10 | 11 | All the fields are overwritten as soon as they are passed |
| 11 | 10 | Only fname and lname are overwritten as soon as they are passed |
| 11 | 11 | Only fname and lname are overwritten as soon as they are passed |
| 10 | 10 | Only fname and lname are overwritten as soon as they are passed |
* If the field is not passed, it’s not overwritten. If an empty value is passed, the field is cleared in Inbox Suite.
You can check the status of the subscribers which you have previously imported into Inbox Suite via the Subscriptions API: https://subsman.engagemktg.com/
Example: https://subsman.engagemktg.com/status?apikey=YOUR-API-KEY&email=SUBSCRIBER-EMAIL-ADDRESS
(Please contact your account manager for your API-key)
To test your posting process, you can use the debug version that returns an API response (after testing the correct operation of posting, we strongly recommend not to use the v2 version in production mode due to import speed limitations), for this you need to add v2 to the request,example:
https://intrust.inboxsuite.com/v2?apikey=API_KEY&email=PROFILE-EMAIL&ip=PROFILE-IP-ADDRESS&sourceurl=SUBSCRIBE-SOURCE-URL®date=PROFILE-REGISTRATION-DATE&status=SUBSCRIBE-STATUS
v2 API returns a JSON formatted response message with one of the statuses described in the table:
| HTTP status code | Response | Notes |
|---|---|---|
| 400 | {code: 40, msg: "Bad request"} | The request contains invalid symbols |
| 401 | {code: 41, msg: "Missing apikey"} | API key is a required parameter, please add API key value |
| 401 | {code: 71, msg: "Authorization failed"} | API key is invalid or expired.Please get the correct API key from your account manager |
| 406 | {code: 42, msg: "Missing email"} | The email address is a required parameter, please add email value |
| 406 | {code: 72, msg: "Invalid email"} | The email address has invalid symbols. See the posting instruction for valid format |
| 406 | {code: 43, msg: "Missing mmh"} | MMH is a required parameter for this source |
| 406 | {code: 73, msg: "Invalid mmh"} | MMH has invalid symbols |
| 406 | {code: 74, msg: "Profile by hash not found"} | We can't find the profile by its MMH value |
| 406 | {code: 45, msg: "Missing ip"} | IP is a required parameter |
| 406 | {code: 75, msg: "Invalid ip"} | IP is invalid. See the posting instruction for valid format |
| 406 | {code: 46, msg: "Missing sourceurl"} | Source URL is a required parameter |
| 406 | {code: 76, msg: "Invalid sourceurl"} | Source URL is invalid. See the posting instruction for valid format |
| 406 | {code: 47, msg: "Missing regdate"} | Registration date is a required parameter, please add registration date value |
| 406 | {code: 77, msg: "Invalid regdate"} | Registration date is invalid. Please check this posting instruction for valid format |
| 406 | {code: 48, msg: "Missing status"} | Status is a required parameter for this source |
| 406 | {code: 78, msg: "Invalid status"} | Status is invalid. Please check this posting instruction for valid subscription status format |
| 406 | {code: 79, msg: "Invalid ISP"} | The email address belongs to a forbidden ISP |
| 406 | {code: 80, msg: "Unacceptable status"} | This profile’s status is invalid. See the posting instruction for valid format |
| 200 | {code: 0, msg: ""} | OK. New profile has been successfully created |
| 200 | {code: 100, msg: "Hard bounce detected"} | The profile is marked as ‘Hard Bounce’ in our database (It is not possible to deliver an email to this address) |
| 200 | {code: 101, msg: "Already complainer"} | The profile is marked as ‘Complainer’ for this site in our database |
| 200 | {code: 102, msg: "Already unsubscriber"} | The profile is marked as ‘Unsubscriber’ for this site in our database |
| 200 | {code: 103, msg: "Already halfling"} | The profile is marked as ‘Halfling’ for this site in our database |
| 200 | {code: 104, msg: "Already subscriber"} | The profile is marked as ‘Subscriber’ for this site in our database |
| 200 | {code: 105, msg: "Already confirmer"} | The profile is marked as ‘Confirmer’ for this site in our database |
| 200 | {code: 108, msg: "Spam bot detected"} | The profile is marked as ‘Spam Bot’ for this site in our database |
| 200 | {code: 120, msg: "New hard bounce accepted"} | The new profile has been marked as ‘Hard Bounce’ |
| 200 | {code: 121, msg: "New complainer accepted"} | The new profile has been marked as ‘Complainer’ for this site |
| 200 | {code: 122, msg: "New unsubscriber accepted"} | The new profile has been marked as ‘Unsubscriber’ for this site |
| 200 | {code: 123, msg: "New activated accepted"} | A new halfling has been accepted for this site |
| 200 | {code: 125, msg: "New confirmer accepted"} | A new profile has been created and subscribed and confirmed for this site |
| 200 | {code: 126, msg: "New subscriber accepted as new profile"} | A new profile has been created and subscribed to this site |
| 200 | {code: 127, msg: "New subscription accepted for existing profile"} | An existing profile has subscribed to this site |
| 200 | {code: 128, msg: "New spam bot accepted"} | A new profile has been marked as Spam Bot |
| 500 | {code: 500, msg: "Inner service error"} | Internal service error. Please contact your account manager for a solution |