NAV

Subscription(Last Updated : 01/04/2017)

PUT Subscription

Results indicating which subscriptions were successfully added or not will be pushed to your designated URL.

Body Parameters

Parameter Description
push_id The key for the specific push message.
request_id The key for the specific request.
subscription_id The subscriber’s unique ID number.
status_code A code notifying the member of the reason for the error. Status Code List
error_data If there is additional data for the status_code, we will give it with this parameter. See Error Data Object table below.

> Error Data Object

Parameter Description
customdata_id The custom data field’s unique ID number.
value The entered value.
max_length This is for errors related to text field. You can check the max_length for the custom data field.
min This is for number-related errors. You can check the minimum value for the custom data field.
max This is for number-related errors. You can check the maximum value for the custom data field.

Code sample for PUT Subscription

"Example (Success):"
[
  {
    "push_id" : 7778889990000,
    "request_id" : "1234561234567asdf123",
    "subscription_id" : "987987987980"
  },
  {
    "push_id" : 7778889990000,
    "request_id" : "1234561234567asdf123",
    "subscription_id" : "987987987981"
  }
]

"Example (Failure):"
[
  {
    "push_id" : 7778889990000,
    "request_id" : "1234561234567asdf123",
    "first_name" : "Subscriber's First Name",
    "mobile" :
    {
      "number" : "2003004000",
      "country_code" : "1"
    },
    "status_code" : "MPSE1201"
  },
  {
    "push_id" : 7778889990000,
    "request_id" : "1234561234567asdf123",
    "landline" :
    {
      "number" : "3004005000",
      "country_code" : "1"
    },
    "last_name" : "Subscriber's Last Name",
    "status_code" : "MPSE1201"
  }
]

"Example (Failure): status_code - MPSE0501. You can get the list of blocked tools via error_data."
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE0501",
  "error_data" :
  [
    "subscriber_email0001@email.com", "2003004000"
  ]
}

"Example (Failure): status_code - MPSE1002. Error_data will identify the customdata_id responsible for the failure."
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE1002",
  "error_data" :
  {
    "customdata_id" : 987987987980,
    "value" : "apple"
  }
}

"Example (Failure): status_code - MPSE1105. Error_data will identify the customdata_id or custom-data-field restrictions responsible for the failure."
{
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE1105",
  "error_data":
  {
    "customdata_id" : 987987987980,
    "max_length" : 20
  }
}

"Example (Failure): status_code – MPSE1205. Error_data will identify the customdata_id responsible for the failure."
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE1205",
  "error_data" :
  {
    "customdata_id" : 987987987980
  }
}

"Example (Failure): status_code - MPSE2110. Error_data will identify the customdata_id responsible for the failure."
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2110",
  "error_data" :
  {
    "customdata_id" : 987987987980
  }
}

"Example (Failure): status_code - MPSE2207. Error_data will identify the customdata_id responsible for the failure."
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2207",
  "error_data" :
  {
    "customdata_id" : 987987987980,
    "valid_format" : "YYYY-MM-DD"
  }
}

"Example (Failure): status_code - MPSE2302. Error_data will identify the invalid list names responsible for the failure."
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2302",
  "error_data" :
  [
    "listname0001", "listname0002"
  ]
}

"Example (Failure): status_code - MPSE2401. Error_data will provide a list of 'already registered' tools."
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2401",
  "error_data" :
  [
    "2003004000"
  ]
}

"Example (Failure): status_code - MPSE2501. Error_data will identify the customdata_id or custom-data-field restrictions responsible for the failure."

"Valid input value : [$min] equal and less than [$input value] equal and less than [$max]"
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2501",
  "error_data" :
  {
    "customdata_id" : 987987987980,
    "min" : 10,
    "max" : 100
  }
}

"Example (Failure): status_code - MPSE2502. Error_data will identify the customdata_id or custom-data-field restrictions responsible for the failure."

"Valid input value : ([$input value] – [$default]) % [$interval] == 0"
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2502",
  "error_data" :
  {
    "customdata_id" : 987987987980,
    "default" : 1,
    "interval" : 5
  }
}

POST Subscription

Results indicating which subscription were successfully updated or not will be pushed to your designated URL.

Body Parameters

Parameter Description
push_id The key for the specific push message.
request_id The key for the specific request.
subscription_id The subscriber’s unique ID number.
status_code A code notifying the member of the reason for the error. Status Code List
error_data If there is additional data for the status_code, we will give it with this parameter. See Error Data Object table below.

> Error Data Object

Parameter Description
customdata_id The custom data field’s unique ID number.
value The entered value.
max_length This is for errors related to text field. You can check the max_length for the custom data field.
min This is for number-related errors. You can check the minimum value for the custom data field.
max This is for number-related errors. You can check the maximum value for the custom data field.

Code sample for POST Subscription

"Example (Success):"
[
  {
    "push_id" : 7778889990000,
    "request_id" : "1234561234567asdf123",
    "subscription_id" : "987987987980"
  },
  {
    "push_id" : 7778889990000,
    "request_id" : "1234561234567asdf123",
    "subscription_id" : "987987987981"
  }
]

"Example (Failure):"
[
  {
    "push_id" : 7778889990000,
    "request_id" : "1234561234567asdf123",
    "first_name" : "Subscriber's First Name",
    "mobile" :
    {
      "number" : "2003004000",
      "country_code" : "1"
    },
    "status_code" : "MPSE1201"
  },
  {
    "push_id" : 7778889990000,
    "request_id" : "1234561234567asdf123",
    "landline" :
    {
      "number" : "3004005000",
      "country_code" : "1"
    },
    "last_name" : "Subscriber's Last Name",
    "status_code" : "MPSE1201"
  }
]

"Example (Failure): status_code - MPSE0501. You can get the list of blocked tools via error_data."
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE0501",
  "error_data" :
  [
    "subscriber_email0001@email.com", "2003004000"
  ]
}

"Example (Failure): status_code - MPSE1002. Error_data will identify the customdata_id responsible for the failure."
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE1002",
  "error_data" :
  {
    "customdata_id" : 987987987980,
    "value" : "apple"
  }
}

"Example (Failure): status_code - MPSE1105. Error_data will identify the customdata_id or custom-data-field restrictions responsible for the failure."
{
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE1105",
  "error_data":
  {
    "customdata_id" : 987987987980,
    "max_length" : 20
  }
}

"Example (Failure): status_code – MPSE1205. Error_data will identify the customdata_id responsible for the failure."
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE1205",
  "error_data" :
  {
    "customdata_id" : 987987987980
  }
}

"Example (Failure): status_code - MPSE2110. Error_data will identify the customdata_id responsible for the failure."
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2110",
  "error_data" :
  {
    "customdata_id" : 987987987980
  }
}

"Example (Failure): status_code - MPSE2207. Error_data will identify the customdata_id responsible for the failure."
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2207",
  "error_data" :
  {
    "customdata_id" : 987987987980,
    "valid_format" : "YYYY-MM-DD"
  }
}

"Example (Failure): status_code - MPSE2302. Error_data will identify the invalid list names responsible for the failure."
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2302",
  "error_data" :
  [
    "listname0001", "listname0002"
  ]
}

"Example (Failure): status_code - MPSE2401. Error_data will provide a list of "already registered" tools."
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2401",
  "error_data" :
  [
    "2003004000"
  ]
}

"Example (Failure): status_code - MPSE2501. Error_data will identify the customdata_id or custom-data-field restrictions responsible for the failure."

"Valid input value : [$min] equal and less than [$input value] equal and less than [$max]"
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2501",
  "error_data" :
  {
    "customdata_id" : 987987987980,
    "min" : 10,
    "max" : 100
  }
}

"Example (Failure): status_code - MPSE2502. Error_data will identify the customdata_id or custom-data-field restrictions responsible for the failure."

"Valid input value : ([$input value] – [$default]) % [$interval] == 0"
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2502",
  "error_data" :
  {
    "customdata_id" : 987987987980,
    "default" : 1,
    "interval" : 5
  }
}

DELETE Subscription

A report indicating whether your subscription was successfully deleted or not will be pushed to your designated URL.

Body Parameters

Parameter Description
push_id The key for the specific push message.
request_id The key for the specific request.
subscription_id The subscriber’s unique ID number.
status_code A code notifying the member of the reason for the error. Status Code List

Code sample DELETE Subscription

"Example (Success):"
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "subscription_id" : "987987987980"
}

"Example (Failure):"
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2303"
}