SMS API Banner

Trumpia REST API
PUSH Notification

(Last Updated: 09/28/2016)
List
PUT Receive a report of whether your list was successfully added or not.
POST Receive a report of whether your list was successfully updated or not.
DELETE Receive a report of whether your list was successfully deleted or not.
Subscription
PUT Receive a report of whether your subscription(s) was successfully added or not.
POST Receive a report of whether your subscription was successfully updated or not.
DELETE Receive a report of whether your subscription was deleted or not.
Message
PUT Receive a detailed report of the success or failure of your message.
DELETE Receive a report of whether your scheduled message was canceled or not.
Keyword
PUT Receive a report of whether your mobile keyword was created or not.
POST Receive a report of whether your mobile keyword was updated or not.
DELETE Receive a report of whether your mobile keyword was deleted or not.
Publication
PUT Receive a detailed report of successful publication posts.
SNS Account
PUT Notification of a registered facebook, twitter account or facebook page request or confirmation.
DELETE Notification of a deleted facebook, twitter account or facebook page request or confirmation.
Custom Data Field
PUT Receive a report of whether your custom data field was created or not.
POST Receive a report of whether your custom data field was updated or not.
DELETE Receive a report of whether your custom data field was deleted or not.
Email Sender Address
PUT Receive a report of whether your email sender address was registered or not.
POST Receive a report of whether your email sender address was updated or not.
DELETE Receive a report of whether your email sender address was deleted or not.
Organization Name
PUT Receive a report of whether your organization name was registered or not.
POST Receive a report of whether your organization name was updated or not.
DELETE Receive a report of whether your organization name was deleted or not.

Push

Instead of a manual GET Status Report, you can have results automatically sent to you once our system has finished processing your resource call. Results will be delivered as JSON data to a URL you provide. To enable this functionality, contact our support team.

PUT List

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

Body Parameters
push_id
The key for the specific push message.
request_id
The key for the specific request.
list_id
The key for the created distribution list.
status
The result of the request.
error_message
A message notifying the member the reason for the error.
status_code
A code notifying the member of the reason for the error. Status Code List
This is the same as error_message, which will be removed.
Example (Success):
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "list_id" : "987987987980",
  "status" : "Create list success."
}
Example (Failure):
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPLE2401",
  "error_message" : "Invalid list_name : This list name is already registered."
}
TOP
POST List

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

Body Parameters
push_id
The key for the specific push message.
request_id
The key for the specific request.
list_id
The key for the updated distribution list.
status
The result of the request.
error_message
A message notifying the member the reason for the error.
status_code
A code notifying the member of the reason for the error. Status Code List
This is the same as error_message, which will be removed.
Example (Success):
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "list_id" : "987987987980",
  "status" : "Update list success."
}
Example (Failure):
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPLE2401",
  "error_message" : "Invalid list_name : This list name is already registered."
} 
TOP
DELETE List

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

Body Parameters
push_id
The key for the specific push message.
request_id
The key for the specific request.
list_id
The key for the deleted distribution list.
status
The result of the request.
error_message
A message notifying the member the reason for the error.
status_code
A code notifying the member of the reason for the error. Status Code List
This is the same as error_message, which will be removed.
Example (Success):
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "list_id" : "987987987980",
  "status" : "Delete list success."
}
Example (Failure):
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPLE2301",
  "error_message" : "List_id was not found."
} 
TOP
PUT Subscription

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

Body Parameters
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.
error_message
A message notifying the member the reason for the error.
status_code
A code notifying the member of the reason for the error. Status Code List
This is the same as error_message, which will be removed.
error_data
If there is additional data for the status_code, we will give it with this parameter.
customdata_id
The custom data field's unique ID number.
value
The entered value.
max_length
This is for text field related errors. 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.
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",
    "error_message" : "Invalid list_name : Special characters are not allowed."
  },
  {
    "push_id" : 7778889990000,
    "request_id" : "1234561234567asdf123",
    "landline" :
    {
      "number" : "3004005000",
      "country_code" : "1"
    },
    "last_name" : "Subscriber's Last Name",
    "status_code" : "MPSE1201",
    "error_message" : "Invalid list_name : Special characters are not allowed."
  }
]
Example (Failure): status_code - MPSE0501. You can get the blocked tool list via error_data.
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE0501",
  "error_data" : 
  [ 
    "subscriber_email0001@email.com", "2003004000"
  ],
  "error_message":"Blocked tools : subscriber_email0001@email.com, 2003004000"
}
Example (Failure): status_code - MPSE1002. You can get the problematic customdata_id via error_data.
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE1002",
  "error_data" :
  {
    "customdata_id" : 987987987980,
    "value" : "apple"
  },
  "error_message" : "Entered value does not match custom data field. Entered values : apple (Customdata_id : 987987987980)"
}
Example (Failure): status_code - MPSE1105. You can get the problematic customdata_id and restrictions for the custom data field via error_data.
{
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE1105",
  "error_data":
  {
    "customdata_id" : 987987987980,
    "max_length" : 20
  },
  "error_message":"Invalid value : You have exceeded the maximum length of 20characters. (Customdata_id : 987987987980)"
}
Example (Failure): status_code – MPSE1205. You can get the problematic customdata_id via error_data.
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE1205",
  "error_data" :
  {
    "customdata_id" : 987987987980
  },
  "error_message" : "Invalid value : Special characters are not allowed. (Customdata_id : 987987987980)"
}
Example (Failure): status_code - MPSE2110. You can get the problematic customdata_id via error_data.
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2110",
  "error_data" :
  {
    "customdata_id" : 987987987980
  },
  "error_message" : "Value is empty. (Customdata_id : 987987987980)"
}
Example (Failure): status_code - MPSE2207. You can get the problematic customdata_id via error_data.
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2207",
  "error_data" :
  {
    "customdata_id" : 987987987980,
    "valid_format" : "YYYY-MM-DD" 
  },
  "error_message" : "Invalid value : Format must be YYYY-MM-DD. (Customdata_id : 987987987980)"
}
Example (Failure): status_code - MPSE2302. You can get the invalid list names via error_data.
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2302",
  "error_data" : 
  [
    "listname0001", "listname0002"
  ],
  "error_message":"Invalid list_name : listname0001,listname0002"
}
Example (Failure): status_code - MPSE2401. You can get “already registered” tool list via error_data.
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2401",
  "error_data" : 
  [ 
    "2003004000"
  ],
  "error_message":"Already Registered Tools : 2003004000"
}
Example (Failure): status_code - MPSE2501. You can get the problematic customdata_id and restrictions for the custom data field via error_data.

Valid input value : [$min] <= [$input value] <= [$max]
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2501",
  "error_data" :
  {
    "customdata_id" : 987987987980,
    "min" : 10,
    "max" : 100
  },
  "error_message" : "Invalid value: Value should be numerical with 10-100. (Customdata_id : 987987987980)"
}
Example (Failure): status_code - MPSE2502. You can get the problematic customdata_id and restrictions for the custom data field via error_data.

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
  },
  "error_message" : "Invalid value : The valid value is defined by both the default(1) value and interval(5) value. (Customdata_id : 987987987980)"
}
TOP
POST Subscription

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

Body Parameters
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.
message
The result of the request.
error_message
A message notifying the member the reason for the error.
status_code
A code notifying the member of the reason for the error. Status Code List
This is the same as error_message, which will be removed.
error_data
If there is additional data for the status_code, we will give it with this parameter.
customdata_id
The custom data field's unique ID number.
value
The entered value.
max_length
This is for text field related errors. 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.
Example (Success):
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "subscription_id" : "987987987980",
  "message" : "Success Update Subscription."
}
Example (Failure):
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123", 
  "status_code" : "MPSE1201",
  "error_message" : "Invalid list_name : Special characters are not allowed."
}
Example (Failure): status_code - MPSE0501. You can get the blocked tool list via error_data.
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE0501",
  "error_data" : 
  [ 
    "aaa@aaa.com", "7778880000"
  ],
  "error_message":"Blocked tools : aaa@aaa.com, 7778880000"
}
Example (Failure): status_code - MPSE1002. You can get the problematic customdata_id via error_data.
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE1002",
  "error_data" :
  {
    "customdata_id" : 987987987980,
    "value" : "apple"
  },
  "error_message" : "Entered value does not match custom data field. Entered values : apple (Customdata_id : 987987987980)"
}
Example (Failure): status_code - MPSE1105. You can get the problematic customdata_id and restrictions for the custom data field via error_data.
{
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE1105",
  "error_data":
  {
    "customdata_id" : 987987987980,
    "max_length" : 20
  },
  "error_message":"Invalid value : You have exceeded the maximum length of 20characters. (Customdata_id : 987987987980)"
}
Example (Failure): status_code – MPSE1205. You can get the problematic customdata_id via error_data.
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE1205",
  "error_data" :
  {
    "customdata_id" : 987987987980
  },
  "error_message" : "Invalid value : Special characters are not allowed. (Customdata_id : 987987987980)"
}
Example (Failure): status_code - MPSE2110. You can get the problematic customdata_id via error_data.
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2110",
  "error_data" :
  {
    "customdata_id" : 987987987980
  },
  "error_message" : "Value is empty. (Customdata_id : 987987987980)"
}
Example (Failure): status_code - MPSE2207. You can get the problematic customdata_id via error_data.
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2207",
  "error_data" :
  {
    "customdata_id" : 987987987980,
    "valid_format" : "YYYY-MM-DD" 
  },
  "error_message" : "Invalid value : Format must be YYYY-MM-DD. (Customdata_id : 987987987980)"
}
Example (Failure): status_code - MPSE2302. You can get invalid list names via error_data.
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2302",
  "error_data" : 
  [
    "listname0001", "listname0002"
  ],
  "error_message":"Invalid list_name : listname0001,listname0002"
}
Example (Failure): status_code - MPSE2401. You can get the “already registered” tool list via error_data.
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2401",
  "error_data" : 
  [ 
    "2003004000"
  ],
  "error_message":"Already Registered Tools : 2003004000"
}
Example (Failure): status_code - MPSE2501. You can get the problematic customdata_id and restrictions for the custom data field via error_data.

Valid input value : [$min] <= [$input value] <= [$max]
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2501",
  "error_data" :
  {
    "customdata_id" : 987987987980,
    "min" : 10,
    "max" : 100
  },
  "error_message" : "Invalid value: Value should be numerical with 10-100. (Customdata_id : 987987987980)"
}
Example (Failure): status_code - MPSE2502. You can get the problematic customdata_id and restrictions for the custom data field via error_data.

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
  },
  "error_message" : "Invalid value : The valid value is defined by both the default(1) value and interval(5) value. (Customdata_id : 987987987980)"
}
TOP
DELETE Subscription

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

Body Parameters
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.
message
The result of the request.
error_message
A message notifying the member the reason for the error.
status_code
A code notifying the member of the reason for the error. Status Code List
This is the same as error_message, which will be removed.
Example (Success):
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "subscription_id" : "987987987980",
  "message" : "Success Delete Subscription."
}
Example (Failure):
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPSE2303",
  "error_message" : "Invalid subscription_id."
}
TOP
PUT Message

Receive a detailed report of the success or failure of your message blast including tallies of the total messages in your blast, the number of messages successfully delivered, and the number of failed messages.

Sometimes, the delivery report will be updated by the carrier after the first PUSH message. We will send additional PUSH messages with updated DR Codes whenever we receive an updated delivery report from the carrier.

Body Parameters
push_id
The key for the specific push message.
request_id
The key for the specific request.
message_id
The message’s unique ID number.
status
The result of the request.
email
The result of the sent email.
total
Total amount sent.
sent
Total messages successfully sent.
failed
Total failed messages.
sms/mms
The result of the sent SMS/MMS.
total
Total amount sent.
sent
Total messages successfully sent.
failed
Total failed messages.
blocked_subscription_list
The list of mobile numbers blocked by carrier.
id
The subscriber’s unique ID number.
number
Mobile phone number.
country_code
Country code of the number.
used_credit
The amount of credits used for the message.
domestic
Used domestic credits.
international
Used international credits.
delivery_report
The result of a sent message including any reason for failure.
sms/mms
task_id
The message's unique ID number.
number
Mobile phone number.
country_code
Country code of the number.
dr_code
Delivery report code of the sent message. DR Code List
email
task_id
The message's unique ID number.
address
Email address.
dr_code
Delivery report code of the sent message. DR Code List
error_message
A message notifying the member the reason for the error.
status_code
A code notifying the member of the reason for the error. Status Code List
This is the same as error_message, which will be removed.
error_data
If there is additional data for the status_code, we will give it with this parameter.
Example (Success):
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "message_id" : 987987987987,
  "status" : "sent",
  "sms":
  {
    "total" : 2,
    "sent" : 1,
    "failed" : 1,
    "blocked_subscription_list" : 
    [ 
      { 
        "id" : 987987987980,
        "number" : " 4564564562",
        "country_code" : 1
      }
    ]
  },
  "email":
  {
    "total" : 3,
    "sent" : 2,
    "failed" : 1
  },
  "used_credit" : 
  {
    "domestic" : 100,
    "international" : 20
  },
  "delivery_report" :
  {
    "sms" :
    [
      { 
        "task_id" : 987987987980,
        "number" : "4564564562",
        "country_code" : 1,
        "dr_code" : "DR001"
      }
    ], 
    "email" : 
    [
      { 
        "task_id" : 789789789002,
        "address" : "subscriber_email0001@email.com",
        "dr_code" : "DR110"
      }
    ]
  }
}
Example (Success): When the delivery report is updated by the recipient's carrier after the first push message is sent.
{
  "push_id" : 7778889990001,
  "request_id" : "1234561234567asdf123",
  "message_id" : 987987987987,
  "status" : "sent",
  "sms":
  {
    "total" : 2,
    "sent" : 2,
    "failed" : 0
  },
  "delivery_report" :
  {
    "sms" :
    [
      { 
        "task_id" : 987987987980,
        "number" : "4564564562",
        "country_code" : 1,
        "dr_code" : "DR000"
      }
    ]
  }
}
Example (Failure):
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPCE3201",
  "error_message" : "Account error : You have insufficient Domestic Text Credits." 
}
Example (Failure): status_code - MPME1002. You can get the invalid file url via error_data.
{
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPME1002",
  "error_data" :
  {
    "resource" : "http://yourdomain.com/image.zip"
  },
  "error_message":"Invalid file type : zip is not supported."
}
Example (Failure): status_code - MPME2301. You can get the invalid subscription_id via error_data.
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPME2301",
  "error_data" : 
  [
    "2003004000", "2003004001"
  ]
  "error_message" : " Invalid subscription_id selected."
}
Example (Failure): status_code - MPME2302. You can get the invalid list_id via error_data.
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPME2302",
  "error_data" : 
  [
    "987987987980", "987987987981"
  ]
  "error_message" : "Invalid list_id selected."
}
Example (Failure): status_code - MPME2021. You can get information about the error for the custom data field via the error_data parameter.
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPME2021",
  "error_data" : 
  [ 
    "[$CustomData-INVALIDNAME]"
  ],
  "error_message":"Invalid mail merge data entered in the SMS message. Problem Value: [$CustomData-INVALIDNAME]"
}
Example (Failure): status_code - MPME2022. You can get information about the error for the custom data field via the error_data parameter.
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPME2022",
  "error_data" : 
  [ 
    "[$CustomData-INVALIDNAME]"
  ],
  "error_message":"Invalid mail merge data entered in the MMS message. Problem Value: [$CustomData-INVALIDNAME]"
}
Example (Failure): status_code - MPME2023. You can get information about the error for the custom data field via the error_data parameter.
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPME2023",
  "error_data" : 
  [ 
    "[$CustomData-INVALIDNAME]"
  ],
  "error_message":"Invalid mail merge data entered in the email. Problem Value: [$CustomData-INVALIDNAME]"
}
TOP
DELETE Message

A report indicating whether your scheduled message was successfully canceled or not will be pushed to your designated URL.

Body Parameters
push_id
The key for the specific push message.
request_id
The key for the specific request.
message_id
The message’s unique ID number.
status_code
A code notifying the member of the reason for the error. Status Code List
This is the same as error_message, which will be removed.
Example (Success):
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "message_id" : 987987987980,
  "status_code" : "MPCE0000"
}
Example (Failure):
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPME2019",
}
TOP
PUT Keyword

A report indicating whether your mobile keyword was successfully created or not will be pushed to your designated URL.

Body Parameters
push_id
The key for the specific push message.
request_id
The key for the specific request.
keyword_id
The keyword's unique ID number.
status
The result of the request.
error_message
A message notifying the member the reason for the error.
status_code
A code notifying the member of the reason for the error. Status Code List
This is the same as error_message, which will be removed.
error_data
If there is additional data for the status_code, we will give it with this parameter.
Example (Success):
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "keyword_id" : "987987987980",
  "status" : "Create keyword success."
}
Example (Failure):
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPKE2401",
  "error_message" : "The keyword is already exists."
}
Example (Failure): status_code - MPKE2301. You can get the invalid list id’s via error_data.
{
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPKE2301",
  "error_data" : 
  [
    "987987987980"
  ],
  "error_message":"Invalid list selected : 987987987980"
}
TOP
POST Keyword

A report indicating whether your mobile keyword was successfully updated or not will be pushed to your designated URL.

Body Parameters
push_id
The key for the specific push message.
request_id
The key for the specific request.
keyword_id
The keyword's unique ID number.
status
The result of the request.
error_message
A message notifying the member the reason for the error.
status_code
A code notifying the member of the reason for the error. Status Code List
This is the same as error_message, which will be removed.
error_data
If there is additional data for the status_code, we will give it with this parameter.
Example (Success):
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "keyword_id" : "987987987980",
  "status" : "Update keyword success."
}
Example (Failure):
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPKE2201",
  "error_message" : "Invalid mobile number format."
}
Example (Failure): status_code - MPKE2301. You can get the invalid list id’s via error_data.
{
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPKE2301",
  "error_data" : 
  [
    "987987987980"
  ],
  "error_message":"Invalid list selected : 987987987980"
}
TOP
DELETE Keyword

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

Body Parameters
push_id
The key for the specific push message.
request_id
The key for the specific request.
keyword_id
The keyword's unique ID number.
status
The result of the request.
error_message
A message notifying the member the reason for the error.
status_code
A code notifying the member of the reason for the error. Status Code List
This is the same as error_message, which will be removed.
Example (Success):
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "keyword_id" : "987987987980",
  "status" : "Delete keyword success."
}
Example (Failure):
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPCE0101",
  "error_message" : "Authentication failed."
}
TOP
PUT Publication

A report indicating whether your PUT Publication request was successfully posted or not will be pushed to your designated URL. If the post is successful, a summary of results will be returned for all the social-networking services that were included. If the post has failed, an error message will be returned that provides the reason for the failure.

Body Parameters
push_id
The key for the specific push message.
request_id
The key for the specific request.
publication_id
The publication's unique ID number.
status
The result of the request.
twitter
The result of the Twitter post.
total
Total amount of tweets posted.
posted
Total number of tweets successfully posted.
failed
Total number of failed tweets.
facebook
The result of the Facebook posts.
total
Total post amount.
posted
Total number of successful posts.
failed
Total number of failed posts.
error_message
A message notifying the member the reason for the error.
status_code
A code notifying the member of the reason for the error. Status Code List
This is the same as error_message, which will be removed.
Example (Success):
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "publication_id" : 987987987987,
  "status" : "posted",
  "twitter" :
  {
    "total" : 2,
    "posted" : 2,
    "failed" : 0
  },
  "facebook" :
  {
    "total" : 2,
    "posted" : 2,
    "failed" : 0
  }
}
Example (Failure):
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "status" : "failed",
  "status_code" : "MPPE2002",
  "error_message" : "All of the account names from at least one of the publishing target are no longer valid."
}
TOP
PUT SNS Account

Receive a notification once the system has processed your request to register facebook, twitter account or facebook page. If the request was successful, request_id, sns_id, or page_id will be returned. If the request was unsuccessful, request_id will be returned along with the appropriate error message.

Body Parameters
push_id
The key for the specific push message.
request_id
The key for the specific request.
service
The SNS type.
sns_id
The SNS’s unique ID number.
page_id
The Facebook Page’s unique ID number.
status
The result of the request.
error_message
A message notifying the member the reason for the error.
status_code
A code notifying the member of the reason for the error. Status Code List
This is the same as error_message, which will be removed.
Example (Success): Register a Facebook account.
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "service" : "facebook",
  "sns_id" : "987987987980",
  "status" : "Success - Register facebook account."
}
Example (Success): Register a Facebook page.
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "service" : "facebook_page",
  "page_id" : "456456456000",
  "status" : "Success - Register facebook page."
}
Example (Success): Register a Facebook page and a Facebook account.
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "service" : "facebook_page",
  "page_id" : "456456456000",
  "facebook_id" : "987987987980",
  "status" : "Success - Register facebook page."
}
Example (Failure):
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPAE1201",
  "error_message" : "Invalid facebook_page_id : Only numerical values are valid."
}
TOP
DELETE SNS Account

Receive a notification once the system has processed your request to delete a Facebook account, Facebook page, or Twitter account. If the request is successful, request_id, sns_id, or page_id will be returned. If the request is unsuccessful, request_id will be returned along with the appropriate error message.

Body Parameters
push_id
The key for the specific push message.
request_id
The key for the specific request.
service
The SNS type.
sns_id
The SNS’s unique ID number.
page_id
The Facebook Page’s unique ID number.
status
The result of the request.
error_message
A message notifying the member the reason for the error.
status_code
A code notifying the member of the reason for the error. Status Code List
This is the same as error_message, which will be removed.
Example (Success): Delete a Facebook account.
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "service" : "facebook",
  "sns_id" : "987987987980", 
  "status" : "Success - Delete facebook account."
}
Example (Success): Delete a Facebook page.
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "service" : "facebook_page",
  "page_id" : "456456456001",
  "status" : "Success - Delete facebook page."
}
Example (Success): Delete a Facebook account and one or multiple Facebook pages.
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "service" : "facebook",
  "sns_id" : "987987987980", 
  "facebook_page_id_list" :  
  [ 
    "456456456000", "456456456001", "456456456002", "456456456003", "456456456004"
  ],    
  "status" : "Success - Delete facebook account."
}
Example (Failure):
{
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPAE2303",
  "error_message" : "Sns_id was not found."
}
TOP
PUT Custom Data Field

A report indicating whether your custom data field was successfully added or not will be pushed to your designated URL.

Body Parameters
push_id
The key for the specific push message.
request_id
The key for the specific request.
customdata_id
The custom data field's unique ID number.
status
The result of the request.
error_message
A message notifying the member the reason for the error.
status_code
A code notifying the member of the reason for the error. Status Code List
This is the same as error_message, which will be removed.
Example (Success):
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "customdata_id" : 987987987980,
  "status" : "Create Custom Data Field success."
}
Example (Failure):
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPFE1001",
  "error_message" : "Input type can only be 1 for text field, 3 for radio button, 4 for drop-down list, 5 for date&time, 6 for text area, or 7 for number."
}
TOP
POST Custom Data Field

A report indicating whether your custom data field was successfully updated or not will be pushed to your designated URL.

Body Parameters
push_id
The key for the specific push message.
request_id
The key for the specific request.
customdata_id
The custom data field's unique ID number.
status
The result of the request.
error_message
A message notifying the member the reason for the error.
status_code
A code notifying the member of the reason for the error. Status Code List
This is the same as error_message, which will be removed.
Example (Success):
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "customdata_id" : 987987987980,
  "status" : "Update Custom Data Field success."
}
Example (Failure):
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPFE1002",
  "error_message" : "Required can only be 1 for required, or 2 for optional."
}
TOP
DELETE Custom Data Field

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

Body Parameters
push_id
The key for the specific push message.
request_id
The key for the specific request.
customdata_id
The custom data field's unique ID number.
status
The result of the request.
error_message
A message notifying the member the reason for the error.
status_code
A code notifying the member of the reason for the error. Status Code List
This is the same as error_message, which will be removed.
Example (Success):
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "customdata_id" : 987987987980,
  "status" : "Delete Custom Data Field success."
}
Example (Failure):
{
  "push_id" : 7778889990000,
  "request_id" : "1234561234567asdf123",
  "status_code" : "MPFE2301",
  "error_message" : "ID was not found."
}
TOP
PUT Email Sender Address

A report indicating whether your email sender address was successfully registered or not will be pushed to your designated URL.

Body Parameters
push_id
The key for the specific push message.
request_id
The key for the specific request.
sender_id
The unique ID number of the sender address.
status_code
A code notifying the member of the reason for the error. Status Code List
Example (Success):
{ 
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123", 
  "sender_id" : 987987987980, 
  "status_code" : "MPCE0000"
}
Example (Failure):
{ 
  "push_id" : 7778889990000,   
  "request_id" : "1234561234567asdf123",   
  "status_code" : "MPDE1101" 
} 
TOP
Email Verification

This PUSH notification will be sent when the receiver clicks the verification link in the email. This is different from other PUSH notifications sent for API calls as it is triggered by a link click activity and not API activity.

Body Parameters
push_id
The key for the specific push message.
sender_id
The unique ID number of the sender address.
sender_status
Verification result.
Value Description
verified Verification success.
address
Verified email address.
verified_at
Verification time. (ISO8601 / UTC)
Example (Success):
{ 
  "push_id" : 7778889990000, 
  "sender_id" : 987987987980, 
  "sender_status" : "verified", 
  "address" : "johndoh@mail.com", 
  "verified_at" : "2015-11-04T12:00:01Z" 
}
TOP
POST Email Sender Address

A report indicating whether your email sender address was successfully updated or not will be pushed to your designated URL.

Body Parameters
push_id
The key for the specific push message.
request_id
The key for the specific request.
sender_id
The unique ID number of the sender address.
status_code
A code notifying the member of the reason for the error. Status Code List
Example (Success):
{ 
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123", 
  "sender_id" : 987987987980, 
  "status_code" : "MPCE0000"
}
Example (Failure):
{ 
  "push_id" : 7778889990000,   
  "request_id" : "1234561234567asdf123",   
  "status_code" : "MPDE1101" 
} 
TOP
DELETE Email Sender Address

A report indicating whether your email sender address was successfully deleted or not will be pushed to your designated URL

Body Parameters
push_id
The key for the specific push message.
request_id
The key for the specific request.
sender_id
The unique ID number of the sender address.
status_code
A code notifying the member of the reason for the error. Status Code List
Example (Success):
{ 
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123", 
  "sender_id" : 987987987980, 
  "status_code" : "MPCE0000" 
}
Example (Failure):
{ 
  "push_id" : 7778889990000,   
  "request_id" : "1234561234567asdf123",   
  "status_code" : "MPDE1101" 
} 
TOP
PUT Organization Name

A report indicating whether your organization name was successfully registered or not will be pushed to your designated URL.

Body Parameters
push_id
The key for the specific push message.
request_id
The key for the specific request.
org_name_id
The unique ID number of the organization name.
name
Registered organization name.
status
Organization name's status.
Value Description
pending Your request is pending. The audit team will update this organization name status.
verified You can use this organization name.
denied You cannot use this organization name because it was not approved.
requested_at
Date for the requested organization name.
status_changed_at
Updated date for the status of the organization name.
status_code
A code notifying the member of the reason for the error. Status Code List
Example (Success):
{ 
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123", 
  "org_name_id" : 987987987980, 
  "name" : "Organization Name 01", 
  "status" : "pending", 
  "requested_at" : "2016-03-23T12:34:56Z", 
  "status_changed_at" : "2016-03-23T12:34:56Z",
  "status_code" : "MPCE0000" 
}
Example (Failure):
{ 
  "push_id" : 7778889990000,   
  "request_id" : "1234561234567asdf123",   
  "status_code" : "MPGE1101" 
}
TOP
POST Organization Name

A report indicating whether your organization name was successfully updated or not will be pushed to your designated URL.

Body Parameters
push_id
The key for the specific push message.
request_id
The key for the specific request.
org_name_id
The unique ID number of the organization name.
name
Updated organization name.
status_code
A code notifying the member of the reason for the error. Status Code List
Example (Success):
{ 
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123", 
  "org_name_id" : 987987987980, 
  "name" : "Organization Name 01", 
  "status_code" : "MPCE0000" 
}
Example (Failure):
{ 
  "push_id" : 7778889990000,   
  "request_id" : "1234561234567asdf123",   
  "status_code" : "MPGE1203" 
}
TOP
DELETE Organization Name

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

Body Parameters
push_id
The key for the specific push message.
request_id
The key for the specific request.
org_name_id
The unique ID number of the organization name.
name
Deleted organization name.
status_code
A code notifying the member of the reason for the error. Status Code List
Example (Success):
{ 
  "push_id" : 7778889990000, 
  "request_id" : "1234561234567asdf123", 
  "org_name_id" : 987987987980, 
  "name" : "Organization Name 01", 
  "status_code" : "MPCE0000" 
}
Example (Failure):
{ 
  "push_id" : 7778889990000,   
  "request_id" : "1234561234567asdf123",   
  "status_code" : "MPGE1203" 
}
TOP
Technical Guidelines Inbound Message System Status Code