{"id":3540,"date":"2023-08-25T12:07:05","date_gmt":"2023-08-25T11:07:05","guid":{"rendered":"https:\/\/help.expertsender.com\/?post_type=es&p=3540"},"modified":"2024-03-19T13:21:45","modified_gmt":"2024-03-19T12:21:45","slug":"data-format","status":"publish","type":"es","link":"https:\/\/help.expertsender.com\/pl\/emp\/api\/data-format\/","title":{"rendered":"Data format"},"content":{"rendered":"\n

GET requests are simple. All required data should be provided inside URL using standard GET syntax.<\/p>\n\n\n\n

For most other methods, all request data should be provided in XML format. Responses are also generated as XML data.<\/p>\n\n\n\n

For example, POST requests with XML data should be constructed so POST request body contains XML. Content type for such request should be set to text\/xml.<\/p>\n\n\n\n

<\/a><\/a>Authentication<\/strong><\/h3>\n\n\n\n

To access ExpertSender API, you must provide your API key with every request. API key is a random string of numbers and letters and is generated for every account in ExpertSender system.<\/p>\n\n\n\n

You can get your API key from “Service Settings > API” page in ExpertSender system. API key is unique to you and providing it automatically identifies you in the system.<\/p>\n\n\n\n

API key should be provided as URL parameter (for GET requests) or in request XML body (for other methods: see Request for details).<\/p>\n\n\n\n

IMPORTANT: all examples in the API doc need to be modified to include your correct API server and API key.<\/p>\n\n\n\n

<\/a><\/a>Request<\/strong><\/h3>\n\n\n\n

Request body should be XML, UTF-8 encoded, without XML header (<?xml…), for example:<\/p>\n\n\n\n

XML<\/span><\/path><\/path><\/svg><\/span>
<<\/span>ApiRequest<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span> <\/span>xmlns<\/span>:<\/span>xs<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span>><\/span><\/span>\n  <\/span><<\/span>ApiKey<\/span>><\/span>YOUR_API_KEY_HERE<\/span><\/<\/span>ApiKey<\/span>><\/span><\/span>\n  <\/span><<\/span>Data<\/span> <\/span>xsi<\/span>:<\/span>type<\/span>=<\/span>"<\/span>Subscriber<\/span>"<\/span>><\/span><\/span>\n    <\/span><<\/span>Mode<\/span>><\/span>AddAndUpdate<\/span><\/<\/span>Mode<\/span>><\/span><\/span>\n    <\/span><<\/span>Force<\/span>><\/span>true<\/span><\/<\/span>Force<\/span>><\/span><\/span>\n    <\/span><<\/span>ListId<\/span>><\/span>1<\/span><\/<\/span>ListId<\/span>><\/span><\/span>\n    <\/span><<\/span>Email<\/span>><\/span>john.smith@domain.com<\/span><\/<\/span>Email<\/span>><\/span><\/span>\n    <\/span><<\/span>Firstname<\/span>><\/span>John<\/span><\/<\/span>Firstname<\/span>><\/span><\/span>\n    <\/span><<\/span>Lastname<\/span>><\/span>Smith<\/span><\/<\/span>Lastname<\/span>><\/span><\/span>\n    <\/span><<\/span>TrackingCode<\/span>><\/span>123<\/span><\/<\/span>TrackingCode<\/span>><\/span><\/span>\n    <\/span><<\/span>Vendor<\/span>><\/span>xyz<\/span><\/<\/span>Vendor<\/span>><\/span><\/span>\n    <\/span><<\/span>Ip<\/span>><\/span>11.22.33.44<\/span><\/<\/span>Ip<\/span>><\/span><\/span>\n    <\/span><<\/span>Properties<\/span>><\/span><\/span>\n      <\/span><<\/span>Property<\/span>><\/span><\/span>\n         <\/span><<\/span>Id<\/span>><\/span>2<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n        <\/span><<\/span>Value<\/span> <\/span>xsi<\/span>:<\/span>type<\/span>=<\/span>"<\/span>xs:string<\/span>"<\/span>><\/span>student<\/span><\/<\/span>Value<\/span>><\/span><\/span>\n      <\/span><\/<\/span>Property<\/span>><\/span><\/span>\n      <\/span><<\/span>Property<\/span>><\/span><\/span>\n        <\/span><<\/span>Id<\/span>><\/span>3<\/span><\/<\/span>Id<\/span>><\/span><\/span>\n        <\/span><<\/span>Value<\/span> <\/span>xsi<\/span>:<\/span>type<\/span>=<\/span>"<\/span>xs:dateTime<\/span>"<\/span>><\/span>1985-03-12<\/span><\/<\/span>Value<\/span>><\/span><\/span>\n      <\/span><\/<\/span>Property<\/span>><\/span><\/span>\n    <\/span><\/<\/span>Properties<\/span>><\/span><\/span>\n  <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiRequest<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
Request is composed of two parts:<\/p>\n\n\n\n
    \n
  1. ApiKey \u2013 this is your API key, required for authentication<\/li>\n\n\n\n
  2. Data \u2013 this is the request data. Its contents may vary, depending on resource that is manipulated. Data type should always be specified using xsi:type attribute.<\/li>\n<\/ol>\n\n\n\n
    <\/a><\/a>Re<\/strong>sponse<\/strong><\/h3>\n\n\n\n
    Response XML data is provided if any data is to be returned (mostly for GET methods) or in case of error. The response content-type is set to text\/xml and response body contains XML. The format is as below:<\/p>\n\n\n\n
    Correct response:#<\/a><\/h4>\n\n\n\n
    XML<\/span><\/path><\/path><\/svg><\/span>
    <<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span>xmlns:xsd=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span>><\/span><\/span>\n  <\/span><<\/span>Data<\/span> <\/span>xsi<\/span>:<\/span>type<\/span>=<\/span>"<\/span>...<\/span>"<\/span>><\/span><\/span>\n    ...<\/span><\/span>\n  <\/span><\/<\/span>Data<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
    Data element type and content depends on type of resource accessed (see below for details for different resources).<\/p>\n\n\n\n
    Error response:#<\/a><\/h4>\n\n\n\n
    XML<\/span><\/path><\/path><\/svg><\/span>
    <<\/span>ApiResponse<\/span> <\/span>xmlns<\/span>:<\/span>xsi<\/span>=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema-instance<\/span>"<\/span>xmlns:xsd=<\/span>"<\/span>http:\/\/www.w3.org\/2001\/XMLSchema<\/span>"<\/span>><\/span><\/span>\n  <\/span><<\/span>ErrorMessage<\/span>><\/span><\/span>\n    <\/span><<\/span>Code<\/span>><\/span>400<\/span><\/<\/span>Code<\/span>><\/span><\/span>\n    <\/span><<\/span>Message<\/span>><\/span>Email is invalid; <\/span><\/<\/span>Message<\/span>><\/span><\/span>\n  <\/span><\/<\/span>ErrorMessage<\/span>><\/span><\/span>\n<\/<\/span>ApiResponse<\/span>><\/span><\/span><\/code><\/pre><\/div>\n\n\n\n
    Error code (consisting with returned HTTP response code) is returned as well as human-readable error message.<\/p>\n","protected":false},"author":5,"featured_media":0,"parent":3551,"menu_order":237,"template":"","format":"standard","emp-category":[],"class_list":["post-3540","es","type-es","status-publish","format-standard","hentry"],"acf":[],"_links":{"self":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3540","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es"}],"about":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/types\/es"}],"author":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/users\/5"}],"version-history":[{"count":2,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3540\/revisions"}],"predecessor-version":[{"id":8778,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3540\/revisions\/8778"}],"up":[{"embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/es\/3551"}],"wp:attachment":[{"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/media?parent=3540"}],"wp:term":[{"taxonomy":"emp-category","embeddable":true,"href":"https:\/\/help.expertsender.com\/pl\/wp-json\/wp\/v2\/emp-category?post=3540"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}