{"openapi":"3.0.4","info":{"title":"Public Subscribers API","version":"1.0.0"},"paths":{"/api/public/v2/custom_fields":{"get":{"summary":"Find all custom fields","tags":["Custom Fields"],"responses":{"200":{"description":"Return all fields","content":{"application/json":{"examples":{"example":{"value":[{"id":1,"label":"Field 1 from table","value":"EXTRA1","datatype":"string"},{"id":2,"label":"Field 2","value":"EXTRA2","datatype":"dropdown","choices":["option 1","option 2"]}]}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}}}},"post":{"summary":"Create custom field","tags":["Custom Fields"],"parameters":[],"responses":{"200":{"description":"Field created","content":{"application/json":{"examples":{"example":{"value":{"id":7,"label":"Consent","value":"EXTRA3","datatype":"gdpr_optin","choices":["option 1","option 2"]}}}}}},"422":{"description":"Field params invalid","content":{"application/json":{"examples":{"example":{"value":{"status":"422 Unprocessable Entity"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_field_params"}}},"required":true,"description":"Field params"}}},"/api/public/v2/custom_fields/{id}":{"parameters":[{"name":"id","in":"path","description":"Field ID","required":true,"schema":{"type":"integer"}}],"get":{"summary":"Show custom field","tags":["Custom Fields"],"responses":{"200":{"description":"Field found","content":{"application/json":{"examples":{"example":{"value":{"id":1,"label":"Field 1 from table","value":"EXTRA1","datatype":"string"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}}}},"patch":{"summary":"Update custom field","tags":["Custom Fields"],"parameters":[],"responses":{"200":{"description":"Field updated","content":{"application/json":{"examples":{"example":{"value":{"id":1,"label":"New label","value":"EXTRA1","datatype":"string"}}}}}},"422":{"description":"Field params invalid","content":{"application/json":{"examples":{"example":{"value":{"status":"422 Unprocessable Entity"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/custom_field_params"}}},"required":true,"description":"Field params to update"}},"delete":{"summary":"Delete custom field","tags":["Custom Fields"],"responses":{"200":{"description":"Field deleted","content":{"application/json":{"examples":{"example":{"value":{"status":"200 Success"}}}}}},"422":{"description":"Field is used in Signup or Profile form","content":{"application/json":{"examples":{"example":{"value":{"status":"422 Unprocessable Entity"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}}}}},"/api/public/v2/events/bounces":{"get":{"summary":"Find bounce events","tags":["Events"],"parameters":[{"name":"sending_id","in":"query","required":false,"description":"Limit events to sending IDs. Can be a comma delimited list, i.e. \"101,102,103\"","schema":{"type":"string"}},{"name":"from_date","in":"query","required":false,"description":"First day of the period to get events for","schema":{"type":"string","format":"date"}},{"name":"to_date","in":"query","required":false,"description":"Last day of the period to get events for (inclusive)","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Return all not deleted bounce events","content":{"application/json":{"examples":{"example":{"value":[{"subscriber_email_id":95,"reason":null,"reasoncode":0,"bounce_message":null,"created_at":"2020-08-26T02:00:00.000+02:00","sending_id":43,"bounce_source":"make.4.0.","email":"test21@test.com","external_id":null}]}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}}}}},"/api/public/v2/events/clicks":{"get":{"summary":"Find click events","tags":["Events"],"parameters":[{"name":"sending_id","in":"query","required":false,"description":"Limit events to sending IDs. Can be a comma delimited list, i.e. \"101,102,103\"","schema":{"type":"string"}},{"name":"from_date","in":"query","required":false,"description":"First day of the period to get events for","schema":{"type":"string","format":"date"}},{"name":"to_date","in":"query","required":false,"description":"Last day of the period to get events for (inclusive)","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Return all not deleted click events","content":{"application/json":{"examples":{"example":{"value":[{"subscriber_email_id":109,"ua_browser":null,"ua_version":null,"ua_platform":null,"ua_device":null,"sending_id":43,"link_id":null,"original_link":"","created_at":"2020-08-26T02:00:00.000+02:00","email":"test35@test.com","external_id":null}]}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}}}}},"/api/public/v2/events/opens":{"get":{"summary":"Find open events","tags":["Events"],"parameters":[{"name":"sending_id","in":"query","required":false,"description":"Limit events to sending IDs. Can be a comma delimited list, i.e. \"101,102,103\"","schema":{"type":"string"}},{"name":"from_date","in":"query","required":false,"description":"First day of the period to get events for","schema":{"type":"string","format":"date"}},{"name":"to_date","in":"query","required":false,"description":"Last day of the period to get events for (inclusive)","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Return all not deleted open events","content":{"application/json":{"examples":{"example":{"value":[{"subscriber_email_id":123,"ua_browser":null,"ua_version":null,"ua_platform":null,"ua_device":null,"sending_id":43,"created_at":"2020-08-26T02:00:00.000+02:00","email":"test49@test.com","external_id":null}]}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}}}}},"/api/public/v2/events/sendings":{"get":{"summary":"Find sending events","tags":["Events"],"parameters":[{"name":"sending_id","in":"query","required":false,"description":"Limit events to sending IDs. Can be a comma delimited list, i.e. \"101,102,103\"","schema":{"type":"string"}},{"name":"from_date","in":"query","required":false,"description":"First day of the period to get events for","schema":{"type":"string","format":"date"}},{"name":"to_date","in":"query","required":false,"description":"Last day of the period to get events for (inclusive)","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Return all not deleted sending events","content":{"application/json":{"examples":{"example":{"value":[{"subscriber_email_id":137,"sending_id":43,"created_at":"2020-08-26T02:00:00.000+02:00","email":"test63@test.com","external_id":null}]}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}}}}},"/api/public/v2/events/unsubscribes":{"get":{"summary":"Find unsubscribe events","tags":["Events"],"parameters":[{"name":"sending_id","in":"query","required":false,"description":"Limit events to sending IDs. Can be a comma delimited list, i.e. \"101,102,103\"","schema":{"type":"string"}},{"name":"from_date","in":"query","required":false,"description":"First day of the period to get events for","schema":{"type":"string","format":"date"}},{"name":"to_date","in":"query","required":false,"description":"Last day of the period to get events for (inclusive)","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Return all not deleted unsubscribe events","content":{"application/json":{"examples":{"example":{"value":[{"unsubscribable_type":"SubscriberEmail","unsubscribable_id":181,"reason":null,"reasoncode":0,"ua_browser":null,"ua_version":null,"ua_platform":null,"ua_device":null,"created_at":"2020-08-26T02:00:00.000+02:00","sending_id":43,"email":"test107@test.com","external_id":null}]}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}}}}},"/api/public/v2/newsletters/by_subscribers_email":{"parameters":[{"name":"email","in":"query","required":true,"description":"Subscriber email","schema":{"type":"string"}},{"name":"include_deleted","in":"query","description":"Include deleted newsletters","schema":{"type":"boolean"}}],"get":{"summary":"List newsletters for the subscriber","tags":["Newsletters"],"responses":{"200":{"description":"Newsletters listed successfully","content":{"application/json":{"examples":{"example":{"value":[{"id":29,"openrate":100.0,"subscriber_list_ids":["14"],"subscriber_segment_ids":[],"send_at":"2024-01-16T12:19:00.000+01:00","sent_at":"2024-01-16T12:31:41.227+01:00","unique_clicks":20,"clicks":24,"complaints":0,"opens":20,"bounce":0,"unsubscribes":0,"scheduled":1,"sent":20,"created_at":"2024-01-16T12:14:50.402+01:00","updated_at":"2024-01-16T12:33:59.398+01:00","tracking_mode":"standard","external_guid":9,"webversion_url":"http://test.host/","preheader":"Newsletter preheader","subject":"Newsletter subject","from_email":"sender@email.com","newsletter_screenshot_url":"http://newsletter.screenshot/","opened_at":"2026-01-01T12:00:00+01:00","clicked_at":null,"opened":true,"clicked":false,"subscriber_id":216,"external_id":"a5e6f3ec-1942-49d6-8d6b-2f1248985f56"},{"id":30,"openrate":100.0,"subscriber_list_ids":["15"],"subscriber_segment_ids":[],"send_at":"2024-01-16T12:19:00.000+01:00","sent_at":"2024-01-16T12:31:41.227+01:00","unique_clicks":20,"clicks":24,"complaints":0,"opens":20,"bounce":0,"unsubscribes":0,"scheduled":1,"sent":20,"created_at":"2024-01-16T12:14:50.402+01:00","updated_at":"2024-01-16T12:33:59.398+01:00","tracking_mode":"standard","external_guid":10,"webversion_url":"http://test.host/","preheader":"Newsletter preheader","subject":"Newsletter subject","from_email":"sender@email.com","newsletter_screenshot_url":"http://newsletter.screenshot/","opened_at":null,"clicked_at":"2026-01-01T12:00:00+01:00","opened":false,"clicked":true,"subscriber_id":216,"external_id":"a5e6f3ec-1942-49d6-8d6b-2f1248985f56"}]}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}}}}},"/api/public/v2/newsletters/by_subscribers_external_id":{"parameters":[{"name":"external_id","in":"query","required":true,"description":"Subscriber external ID","schema":{"type":"string"}},{"name":"include_deleted","in":"query","description":"Include deleted newsletters","schema":{"type":"boolean"}}],"get":{"summary":"List newsletters for the subscriber","tags":["Newsletters"],"responses":{"200":{"description":"Newsletters listed successfully","content":{"application/json":{"examples":{"example":{"value":[{"id":37,"openrate":100.0,"subscriber_list_ids":["22"],"subscriber_segment_ids":[],"send_at":"2024-01-16T12:19:00.000+01:00","sent_at":"2024-01-16T12:31:41.227+01:00","unique_clicks":20,"clicks":24,"complaints":0,"opens":20,"bounce":0,"unsubscribes":0,"scheduled":1,"sent":20,"created_at":"2024-01-16T12:14:50.402+01:00","updated_at":"2024-01-16T12:33:59.398+01:00","tracking_mode":"standard","external_guid":17,"webversion_url":"http://test.host/","preheader":"Newsletter preheader","subject":"Newsletter subject","from_email":"sender@email.com","newsletter_screenshot_url":"http://newsletter.screenshot/","opened_at":"2026-01-01T12:00:00+01:00","clicked_at":null,"opened":true,"clicked":false,"subscriber_id":220,"external_id":"a5e6f3ec-1942-49d6-8d6b-2f1248985f56"},{"id":38,"openrate":100.0,"subscriber_list_ids":["23"],"subscriber_segment_ids":[],"send_at":"2024-01-16T12:19:00.000+01:00","sent_at":"2024-01-16T12:31:41.227+01:00","unique_clicks":20,"clicks":24,"complaints":0,"opens":20,"bounce":0,"unsubscribes":0,"scheduled":1,"sent":20,"created_at":"2024-01-16T12:14:50.402+01:00","updated_at":"2024-01-16T12:33:59.398+01:00","tracking_mode":"standard","external_guid":18,"webversion_url":"http://test.host/","preheader":"Newsletter preheader","subject":"Newsletter subject","from_email":"sender@email.com","newsletter_screenshot_url":"http://newsletter.screenshot/","opened_at":null,"clicked_at":"2026-01-01T12:00:00+01:00","opened":false,"clicked":true,"subscriber_id":220,"external_id":"a5e6f3ec-1942-49d6-8d6b-2f1248985f56"}]}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}}}}},"/api/public/v2/signup_forms/{id}/signup":{"post":{"summary":"Sign up subscriber","tags":["Signup forms"],"parameters":[{"name":"id","in":"path","required":true,"description":"Signup form ID or token","schema":{"type":"string"}}],"responses":{"200":{"description":"Uses form-level country code prefix for local phone numbers","content":{"application/json":{"examples":{"example":{"value":{"status":"200 Success","id":225}}}}}},"422":{"description":"Subscriber params invalid","content":{"application/json":{"examples":{"example":{"value":{"status":"422 Unprocessable Entity"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriber_params"}}},"required":true,"description":"Subscriber params"}}},"/api/public/v2/subscriber_tags":{"get":{"summary":"Find all subscriber tags","tags":["Subscriber Tags"],"responses":{"200":{"description":"Return all subscriber tags","content":{"application/json":{"examples":{"example":{"value":[{"id":18,"title":"tag1","created_at":"2026-01-01T12:00:00.000+01:00","updated_at":"2026-01-01T12:00:00.000+01:00","subscribers_with_tag":0},{"id":19,"title":"tag2","created_at":"2026-01-01T12:00:00.000+01:00","updated_at":"2026-01-01T12:00:00.000+01:00","subscribers_with_tag":0}]}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}}}},"post":{"summary":"Create subscriber tag","tags":["Subscriber Tags"],"parameters":[],"responses":{"200":{"description":"Tag created","content":{"application/json":{"examples":{"example":{"value":{"id":24,"title":"new tag","created_at":"2026-01-01T12:00:00.000+01:00","updated_at":"2026-01-01T12:00:00.000+01:00","subscribers_with_tag":0}}}}}},"422":{"description":"Tag params invalid","content":{"application/json":{"examples":{"example":{"value":{"status":"422 Unprocessable Entity"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriber_tag_params"}}},"required":true,"description":"subscriber_tag"}}},"/api/public/v2/subscriber_tags/{id}":{"parameters":[{"name":"id","in":"path","description":"Tag ID","required":true,"schema":{"type":"integer"}}],"get":{"summary":"Show subscriber tag","tags":["Subscriber Tags"],"responses":{"200":{"description":"Tag found","content":{"application/json":{"examples":{"example":{"value":{"id":29,"title":"tag1","created_at":"2026-01-01T12:00:00.000+01:00","updated_at":"2026-01-01T12:00:00.000+01:00","subscribers_with_tag":0}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}}}},"patch":{"summary":"Update subscriber tag","tags":["Subscriber Tags"],"parameters":[],"responses":{"200":{"description":"Tag updated","content":{"application/json":{"examples":{"example":{"value":{"id":35,"title":"mollitia","created_at":"2026-01-01T12:00:00.000+01:00","updated_at":"2026-01-01T12:00:00.000+01:00","subscribers_with_tag":0}}}}}},"422":{"description":"Tag params invalid","content":{"application/json":{"examples":{"example":{"value":{"status":"422 Unprocessable Entity"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriber_tag_params"}}},"required":true,"description":"Tag params to update"}},"delete":{"summary":"Delete subscriber tag","tags":["Subscriber Tags"],"responses":{"200":{"description":"Tag deleted","content":{"application/json":{"examples":{"example":{"value":{"status":"200 Success"}}}}}}}}},"/api/public/v2/subscriberlists":{"get":{"summary":"Find all lists","tags":["Subscriberlists"],"responses":{"200":{"description":"Return all lists","content":{"application/json":{"examples":{"example":{"value":[{"id":548,"title":"My contacts (test list)","date_created":"2026-01-01T11:00:00.000Z","date_updated":"2026-01-01T11:00:00.000Z","subscriber_emails":0,"subscriber_sms":0}]}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}}}},"post":{"summary":"Create list","tags":["Subscriberlists"],"parameters":[],"responses":{"200":{"description":"List created","content":{"application/json":{"examples":{"example":{"value":{"id":550,"title":"New list","date_created":"2026-01-01T11:00:00.000Z","date_updated":"2026-01-01T11:00:00.000Z","subscriber_emails":0,"subscriber_sms":0}}}}}},"422":{"description":"List params invalid","content":{"application/json":{"examples":{"example":{"value":{"status":"422 Unprocessable Entity"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list_params"}}},"required":true,"description":"List params"}}},"/api/public/v2/subscriberlists/{id}":{"parameters":[{"name":"id","in":"path","description":"List ID","required":true,"schema":{"type":"integer"}}],"get":{"summary":"Show list","tags":["Subscriberlists"],"responses":{"200":{"description":"List found","content":{"application/json":{"examples":{"example":{"value":{"id":552,"title":"My contacts (test list)","date_created":"2026-01-01T11:00:00.000Z","date_updated":"2026-01-01T11:00:00.000Z","subscriber_emails":0,"subscriber_sms":0}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}}}},"patch":{"summary":"Update list","tags":["Subscriberlists"],"parameters":[],"responses":{"200":{"description":"List updated","content":{"application/json":{"examples":{"example":{"value":{"id":555,"title":"New title","date_created":"2026-01-01T11:00:00.000Z","date_updated":"2026-01-01T11:00:00.000Z","subscriber_emails":0,"subscriber_sms":0}}}}}},"422":{"description":"List params invalid","content":{"application/json":{"examples":{"example":{"value":{"status":"422 Unprocessable Entity"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/list_params"}}},"required":true,"description":"List params to update"}},"delete":{"summary":"Delete list","tags":["Subscriberlists"],"responses":{"200":{"description":"List deleted","content":{"application/json":{"examples":{"example":{"value":{"status":"200 Success"}}}}}},"422":{"description":"List has Signup Form linked","content":{"application/json":{"examples":{"example":{"value":{"status":"422 Unprocessable Entity","message":"This list is used in a form and can not be deleted"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}}}}},"/api/public/v2/subscribers/{subscriber_id}/subscriberlists":{"parameters":[{"name":"subscriber_id","in":"path","required":true,"description":"Subscriber ID","schema":{"type":"integer"}}],"get":{"summary":"Find all lists with subscriber","tags":["Subscribers"],"responses":{"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}}}},"post":{"summary":"Add subscriber to the list","tags":["Subscribers"],"parameters":[],"responses":{"200":{"description":"Subscriber added to the list","content":{"application/json":{"examples":{"example":{"value":{"list_id":569}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"list_id":{"type":"integer"}},"required":["list_id"]}}},"required":true,"description":"List params"}}},"/api/public/v2/subscribers/{subscriber_id}/subscriberlists/{id}":{"parameters":[{"name":"subscriber_id","in":"path","required":true,"description":"Subscriber ID","schema":{"type":"integer"}},{"name":"id","in":"path","required":true,"description":"List ID","schema":{"type":"integer"}}],"delete":{"summary":"Remove subscriber from the list","tags":["Subscribers"],"responses":{"200":{"description":"Subscriber removed from the list","content":{"application/json":{"examples":{"example":{"value":{"status":"200 Success"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}}}}},"/api/public/v2/subscribers/subscriptions/products/bulkinsert":{"post":{"summary":"Bulk insert products for user","tags":["Subscriptions"],"parameters":[],"responses":{"201":{"description":"Products inserted successfully","content":{"application/json":{"examples":{"example":{"value":{"message":"products inserted successfully"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscription_products_params"}}},"required":true,"description":"Array of products to insert"}}},"/api/public/v2/subscribers/subscriptions/bulkinsert":{"post":{"summary":"Bulk insert subscriptions for subscribers","tags":["Subscriptions"],"parameters":[],"responses":{"201":{"description":"subscriptions inserted with auto-created products","content":{"application/json":{"examples":{"example":{"value":{"message":"subscriptions inserted successfully"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriber_subscriptions_params"}}},"required":true,"description":"Subscriber subscriptions params"}}},"/api/public/v2/subscribers/subscriptions/bulkinsert_by_external_id":{"post":{"summary":"Bulk insert subscriptions for subscribers","tags":["Subscriptions"],"parameters":[],"responses":{"201":{"description":"subscriptions inserted with auto-created products","content":{"application/json":{"examples":{"example":{"value":{"message":"subscriptions inserted successfully"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriber_by_ext_id_subscriptions_params"}}},"required":true,"description":"Subscriber subscriptions params"}}},"/api/public/v2/subscribers/tickets/events/bulkinsert":{"post":{"summary":"Bulk insert events for subscribers","tags":["Tickets"],"parameters":[],"responses":{"201":{"description":"Events inserted successfully","content":{"application/json":{"examples":{"example":{"value":{"message":"Events inserted successfully"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriber_ticket_events_params"}}},"required":true,"description":"Ticket events params"}}},"/api/public/v2/subscribers/tickets/bulkinsert":{"post":{"summary":"Bulk insert tickets for subscribers","tags":["Tickets"],"parameters":[],"responses":{"201":{"description":"Tickets inserted successfully","content":{"application/json":{"examples":{"example":{"value":{"message":"Tickets inserted successfully"}}}}}},"422":{"description":"Invalid ticket payload","content":{"application/json":{"examples":{"example":{"value":{"status":"422 Unprocessable Entity","message":"Ticket external_id is required"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriber_tickets_params"}}},"required":true,"description":"Subscriber tickets params"}}},"/api/public/v2/subscribers/tickets/bulkinsert_by_external_id":{"post":{"summary":"Bulk insert tickets for subscribers by external id","tags":["Tickets"],"parameters":[],"responses":{"201":{"description":"Tickets inserted successfully","content":{"application/json":{"examples":{"example":{"value":{"message":"Tickets inserted successfully"}}}}}},"422":{"description":"Invalid ticket payload","content":{"application/json":{"examples":{"example":{"value":{"status":"422 Unprocessable Entity","message":"Invalid ticket status 'Cancelled'. Allowed values: active, cancelled"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriber_external_id_tickets_params"}}},"required":true,"description":"Subscriber tickets params"}}},"/api/public/v2/subscribers":{"parameters":[{"name":"subscriber_list_id[]","in":"query","required":true,"description":"Subscriberlist ID","schema":{"type":"array","items":{"type":"integer"}}}],"post":{"summary":"Create or update subscriber","tags":["Subscribers"],"description":"NOTE: Please use captcha to prevent false signups from bots.","parameters":[{"name":"status","in":"query","required":false,"description":"Status of email. Possible value: active|unsubscribed|bounce","schema":{"type":"string"}},{"name":"status_mobile","in":"query","required":false,"description":"Status of mobile. Possible value: active|unsubscribed|bounce","schema":{"type":"string"}},{"name":"tag","in":"query","required":false,"description":"Tags handling mode. Possible values: replace | merge. Default: replace","schema":{"type":"string"}}],"responses":{"200":{"description":"Automation triggered","content":{"application/json":{"examples":{"example":{"value":{"status":"200 Success","id":313}}}}}},"404":{"description":"List(s) not found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}},"422":{"description":"Subscriber params invalid","content":{"application/json":{"examples":{"example":{"value":{"status":"422 Unprocessable Entity"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriber_params"}}},"required":true,"description":"Subscriber params"}}},"/api/public/v2/subscribers/stats":{"parameters":[{"name":"email","in":"query","description":"Subscriber email","schema":{"type":"string"}}],"get":{"summary":"Show subscriber email stats","tags":["Subscribers"],"responses":{"200":{"description":"Subscriber email found","content":{"application/json":{"examples":{"example":{"value":{"clicks":4,"opens":2,"newsletters_clicked":[2,3],"newsletters_opened":[2,3],"received":3,"newsletters_received":[2,3,4]}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}}}}},"/api/public/v2/subscribers/{id}":{"parameters":[{"name":"id","in":"path","description":"Subscriber ID","required":true,"schema":{"type":"integer"}},{"name":"external_id","in":"query","required":false,"description":"External Subscriber ID","schema":{"type":"string"}}],"get":{"summary":"Show subscriber by external id","tags":["Subscribers"],"responses":{"200":{"description":"Subscriber found","content":{"application/json":{"examples":{"example":{"value":{"id":341,"email":"test239@test.com","firstname":"Firstname","lastname":"Lastname","address":null,"zip":null,"city":null,"phone":"4710000048","company":null,"birthday":null,"gender":null,"tags":["tagname","tagname2"],"external_id":"10","date_created":"2026-01-01T11:00:00.000Z","date_updated":"2026-01-01T11:00:00.000Z","email_status":"active","phone_status":"active","EXTRA1":"value1","EXTRA2":null,"EXTRA3":null,"EXTRA4":null,"OPTINEMAIL":null,"OPTINSMS":null,"OPTINEMAILSMS":null,"PRIVACYPOLICY":null,"lists":[]}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}}}},"patch":{"summary":"Update subscriber","tags":["Subscribers"],"parameters":[{"name":"status","in":"query","required":false,"description":"Status of email. Possible value: active | unsubscribed | bounce","schema":{"type":"string"}},{"name":"status_mobile","in":"query","required":false,"description":"Status of mobile. Possible value: active | unsubscribed | bounce","schema":{"type":"string"}},{"name":"tag","in":"query","required":false,"description":"Tags handling mode. Possible values: replace | merge. Default: replace","schema":{"type":"string"}},{"name":"subscriber_list_id[]","in":"query","required":false,"description":"Subscriberlist ID","schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"Subscriber is updated","content":{"application/json":{"examples":{"example":{"value":{"status":"200 Success","id":333}}}}}},"422":{"description":"Subscriber params invalid","content":{"application/json":{"examples":{"example":{"value":{"status":"422 Unprocessable Entity"}}}}}},"404":{"description":"List(s) not found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriber_params"}}},"required":true,"description":"Subscriber params"}},"delete":{"summary":"Delete subscriber","tags":["Subscribers"],"responses":{"200":{"description":"Subscribers deleted","content":{"application/json":{"examples":{"example":{"value":{"status":"200 Success"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}}},"parameters":[{"name":"email","in":"query","required":false,"description":"Subscriber email","schema":{"type":"string"}}]}},"/api/public/v2/subscribers/{id}/unsubscribe_email":{"parameters":[{"name":"id","in":"path","required":true,"description":"Subscriber ID","schema":{"type":"integer"}}],"post":{"summary":"Unsubscribe email","tags":["Subscribers"],"responses":{"200":{"description":"Unsubscribed successfully","content":{"application/json":{"examples":{"example":{"value":{"status":"200 Success"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}}}}},"/api/public/v2/subscribers/unsubscribe_email":{"parameters":[{"name":"external_id","in":"query","required":true,"description":"External Subscriber ID","schema":{"type":"string"}}],"post":{"summary":"Unsubscribe email by external id","tags":["Subscribers"],"responses":{"200":{"description":"Unsubscribed successfully","content":{"application/json":{"examples":{"example":{"value":{"status":"200 Success"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}}}}},"/api/public/v2/subscribers/{id}/unsubscribe_phone":{"parameters":[{"name":"id","in":"path","required":true,"description":"Subscriber ID","schema":{"type":"integer"}}],"post":{"summary":"Unsubscribe phone","tags":["Subscribers"],"responses":{"200":{"description":"Unsubscribed successfully","content":{"application/json":{"examples":{"example":{"value":{"status":"200 Success"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}}}}},"/api/public/v2/subscribers/unsubscribe_phone":{"parameters":[{"name":"external_id","in":"query","required":true,"description":"External Subscriber ID","schema":{"type":"string"}}],"post":{"summary":"Unsubscribe phone by external_id","tags":["Subscribers"],"responses":{"200":{"description":"Unsubscribed successfully","content":{"application/json":{"examples":{"example":{"value":{"status":"200 Success"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}}}}},"/api/public/v2/subscribers/bulkinsert":{"post":{"summary":"Create and/or update batch of subscribers. 1000 subscribers max.","tags":["Subscribers"],"parameters":[{"name":"subscriber_list_id[]","in":"query","required":true,"description":"Subscriberlist ID","schema":{"type":"array","items":{"type":"integer"}}},{"name":"status","in":"query","required":false,"description":"Status of email. Possible value: active | unsubscribed | bounce | reactivate","schema":{"type":"string"}},{"name":"status_mobile","in":"query","required":false,"description":"Status of mobile. Possible value: active | unsubscribed | bounce | reactivate","schema":{"type":"string"}},{"name":"tag","in":"query","required":false,"description":"Tags handling mode. Possible values: replace | merge. Default: replace","schema":{"type":"string"}}],"responses":{"200":{"description":"Custom field absent from first record is saved for subsequent records","content":{"application/json":{"examples":{"example":{"value":{"status":"200 Success"}}}}}},"422":{"description":"Subscriber params invalid","content":{"application/json":{"examples":{"example":{"value":{"status":"422 Unprocessable Entity"}}}}}},"404":{"description":"List(s) not found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriber_bulkinsert_params"}}},"required":true,"description":"Subscriber params. 1000 subscribers max."}}},"/api/public/v2/subscribers/bulkupdate":{"put":{"summary":"Update batch of subscribers. 1000 subscribers max.","tags":["Subscribers"],"parameters":[{"name":"subscriber_list_id[]","in":"query","required":true,"description":"Subscriberlist ID","schema":{"type":"array","items":{"type":"integer"}}},{"name":"status","in":"query","required":false,"description":"Status of email. Possible value: active | unsubscribed | bounce | reactivate","schema":{"type":"string"}},{"name":"status_mobile","in":"query","required":false,"description":"Status of mobile. Possible value: active | unsubscribed | bounce | reactivate","schema":{"type":"string"}},{"name":"tag","in":"query","required":false,"description":"Tags handling mode. Possible values: replace | merge. Default: replace","schema":{"type":"string"}}],"responses":{"200":{"description":"Custom field absent from first record is saved for subsequent records","content":{"application/json":{"examples":{"example":{"value":{"status":"200 Success"}}}}}},"404":{"description":"List(s) not found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriber_bulkinsert_params"}}},"required":true,"description":"Subscriber params. 1000 subscribers max."}}},"/api/public/v2/subscribers/bulkupdate_by_external_id":{"put":{"summary":"Update batch of subscribers. 1000 subscribers max.","tags":["Subscribers"],"parameters":[{"name":"subscriber_list_id[]","in":"query","required":false,"description":"Subscriberlist ID","schema":{"type":"array","items":{"type":"integer"}}},{"name":"tag","in":"query","required":false,"description":"Tags handling mode. Possible values: replace | merge. Default: replace","schema":{"type":"string"}}],"responses":{"200":{"description":"Subscriber birthday cleared","content":{"application/json":{"examples":{"example":{"value":{"status":"200 Success"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriber_bulkupdate_params"}}},"required":true,"description":"Subscriber params. 1000 subscribers max."}}},"/api/public/v2/subscribers/bulkinsert_by_external_id":{"post":{"summary":"Create batch of subscribers by external_id (insert-only). 1000 subscribers max.","tags":["Subscribers"],"parameters":[{"name":"subscriber_list_id[]","in":"query","required":true,"description":"Subscriberlist ID","schema":{"type":"array","items":{"type":"integer"}}},{"name":"status","in":"query","required":false,"description":"Status of email. Possible value: active | unsubscribed | bounce","schema":{"type":"string"}},{"name":"status_mobile","in":"query","required":false,"description":"Status of mobile. Possible value: active | unsubscribed | bounce","schema":{"type":"string"}},{"name":"tag","in":"query","required":false,"description":"Tags handling mode. Possible values: replace | merge. Default: replace","schema":{"type":"string"}}],"responses":{"200":{"description":"Unsubscribed contacts added","content":{"application/json":{"examples":{"example":{"value":{"status":"200 Success"}}}}}},"404":{"description":"List(s) not found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}},"422":{"description":"Email conflict - email belongs to subscriber with different external_id (Case 4/5)","content":{"application/json":{"examples":{"example":{"value":{"status":"422 Unprocessable Entity"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriber_bulkinsert_by_external_id_params"}}},"required":true,"description":"Subscriber params. 1000 subscribers max."}}},"/api/public/v2/subscribers/bulkremove":{"post":{"summary":"Remove batch of subscribers from list. 1000 subscribers max.","tags":["Subscribers"],"parameters":[{"name":"subscriber_list_id[]","in":"query","required":true,"description":"Subscriberlist ID","schema":{"type":"array","items":{"type":"integer"}}}],"responses":{"200":{"description":"Contacts removed from list","content":{"application/json":{"examples":{"example":{"value":{"status":"200 Success"}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriber_bulkremove_params"}}},"required":true,"description":"Subscriber email or phone. 1000 entries max."}}},"/api/public/v2/subscribers/by_email":{"post":{"summary":"Show subscriber based on email","tags":["Subscribers"],"parameters":[],"responses":{"200":{"description":"Subscriber found","content":{"application/json":{"examples":{"example":{"value":{"id":419,"email":"test284@test.com","firstname":"Firstname","lastname":"Lastname","address":null,"zip":null,"city":null,"phone":"4710000077","company":null,"birthday":null,"gender":null,"tags":["tagname","tagname2"],"external_id":"10","date_created":"2026-01-01T11:00:00.000Z","date_updated":"2026-01-01T11:00:00.000Z","status":"active","EXTRA1":"value1","EXTRA2":null,"EXTRA3":null,"EXTRA4":null,"OPTINEMAIL":null,"OPTINSMS":null,"OPTINEMAILSMS":null,"PRIVACYPOLICY":null,"lists":[{"id":741,"title":"List"}]}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"}}}}},"required":true,"description":"Subscriber email param"}}},"/api/public/v2/subscribers/by_phone":{"post":{"summary":"Show subscriber based on phone","tags":["Subscribers"],"parameters":[],"responses":{"200":{"description":"Subscriber found","content":{"application/json":{"examples":{"example":{"value":{"id":422,"email":"test287@test.com","firstname":"Firstname","lastname":"Lastname","address":null,"zip":null,"city":null,"phone":"4710000080","company":null,"birthday":null,"gender":null,"tags":["tagname","tagname2"],"external_id":"10","date_created":"2026-01-01T11:00:00.000Z","date_updated":"2026-01-01T11:00:00.000Z","status":"active","EXTRA1":"value1","EXTRA2":null,"EXTRA3":null,"EXTRA4":null,"OPTINEMAIL":null,"OPTINSMS":null,"OPTINEMAILSMS":null,"PRIVACYPOLICY":null,"lists":[{"id":747,"title":"List"}]}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"phone":{"type":"string"}}}}},"required":true,"description":"Subscriber phone param"}}},"/api/public/v2/subscribers/by_trackingtoken":{"post":{"summary":"Show subscriber based on trackingtoken","tags":["Subscribers"],"parameters":[],"responses":{"200":{"description":"Subscriber found","content":{"application/json":{"examples":{"example":{"value":{"id":425,"email":"test290@test.com","firstname":"Firstname","lastname":"Lastname","address":null,"zip":null,"city":null,"phone":"4710000083","company":null,"birthday":null,"gender":null,"tags":["tagname","tagname2"],"external_id":"10","date_created":"2026-01-01T11:00:00.000Z","date_updated":"2026-01-01T11:00:00.000Z","make_id":1452,"EXTRA1":"value1","EXTRA2":null,"EXTRA3":null,"EXTRA4":null,"OPTINEMAIL":null,"OPTINSMS":null,"OPTINEMAILSMS":null,"PRIVACYPOLICY":null,"lists":[{"id":753,"title":"List"}]}}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"examples":{"example":{"value":{"status":"404 Not Found"}}}}}}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"trackingtoken":{"type":"string"}}}}},"required":true,"description":"Trackingtoken param"}}},"/api/public/v2/subscribers/by_list":{"parameters":[{"name":"list_id","in":"query","required":true,"description":"Subscriberlist ID","schema":{"type":"integer"}},{"name":"status","in":"query","required":false,"description":"Status of email. Possible value: active|unsubscribed|bounce. Default: active","schema":{"type":"string"}},{"name":"status_mobile","in":"query","required":false,"description":"Status of mobile. Possible value: active|unsubscribed|bounce. Default: active","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"Page number","schema":{"type":"integer"}},{"name":"per_page","in":"query","required":false,"description":"Number of entries per page (MAX 1000)","schema":{"type":"integer"}},{"name":"updated_after","in":"query","required":false,"description":"Filter by updated date. Format: YYYY-MM-DDTHH:MM:SSZ (iso8601)","schema":{"type":"string"}}],"get":{"summary":"Show subscribers based on list id","tags":["Subscribers"],"responses":{"200":{"description":"Unsubscribed email and subscribed phone subscribers found","content":{"application/json":{"examples":{"example":{"value":[{"id":436,"email":"test301@test.com","firstname":"Firstname","lastname":"Lastname","address":null,"zip":null,"city":null,"phone":"4710000094","company":null,"birthday":null,"gender":null,"tags":[],"external_id":"11","date_created":"2026-01-01T11:00:00.000Z","date_updated":"2026-01-01T11:00:00.000Z","email_status":"unsubscribed","phone_status":"unsubscribed","EXTRA1":"value1","EXTRA2":null,"EXTRA3":null,"EXTRA4":null,"OPTINEMAIL":null,"OPTINSMS":null,"OPTINEMAILSMS":null,"PRIVACYPOLICY":null,"lists":[{"id":763,"title":"List"}]}]}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}}}}},"/api/public/v2/subscriberstatus":{"get":{"summary":"Get latest updated subscribers","tags":["Subscriberstatus"],"parameters":[{"name":"from_date","in":"query","required":false,"description":"Date to get subscribers updated after this date. Format: YYYY-MM-DD","schema":{"type":"string","format":"date"}},{"name":"to_date","in":"query","required":false,"description":"Date to get subscribers updated before this date. Format: YYYY-MM-DD","schema":{"type":"string","format":"date"}}],"responses":{"200":{"description":"Return all lists","content":{"application/json":{"examples":{"example":{"value":[{"id":440,"email":"test305@test.com","firstname":"Firstname","lastname":"Lastname","address":null,"zip":null,"city":null,"phone":"4710000098","company":null,"birthday":null,"gender":null,"date_created":"2026-01-01T11:00:00.000Z","date_updated":"2026-01-01T11:00:00.000Z","inactive_emails":[{"email":"unsubscribed@test.com","status":"unsubscribed","reason":"The content is not relevant for me"}],"inactive_phones":[],"date_updated_by_user":"2026-01-01T11:00:00.000Z","OPTINEMAIL":null,"OPTINSMS":null,"OPTINEMAILSMS":null,"PRIVACYPOLICY":null}]}}}}},"401":{"description":"Unathorized","content":{"application/json":{"examples":{"example":{"value":{"status":"401 Unauthorized"}}}}}}}}}},"servers":[{"url":"https://subscribers.dialogapi.no"}],"security":[{"basic":[]}],"components":{"securitySchemes":{"basic":{"type":"http","scheme":"basic"}},"schemas":{"errors_object":{"type":"object","required":["status"],"properties":{"status":{"type":"string"},"message":{"type":"string"}}},"subscriber_bulkinsert_params":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string"},"phone":{"type":"string"},"firstname":{"type":"string"},"lastname":{"type":"string"},"address":{"type":"string"},"zip":{"type":"string"},"city":{"type":"string"},"company":{"type":"string"},"birthday":{"type":"string","format":"date"},"gender":{"type":"string"},"external_id":{"type":"string"},"bounce_source":{"type":"string"},"bounce_reason":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}},"subscriber_bulkremove_params":{"type":"array","items":{"type":"object","properties":{"email":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"external_id":{"type":"string","nullable":true}}}},"subscriber_bulkupdate_params":{"type":"array","items":{"type":"object","required":["external_id"],"properties":{"external_id":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"firstname":{"type":"string"},"lastname":{"type":"string"},"address":{"type":"string"},"zip":{"type":"string"},"city":{"type":"string"},"company":{"type":"string"},"birthday":{"type":"string","format":"date"},"gender":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}}}}},"subscriber_bulkinsert_by_external_id_params":{"type":"array","items":{"type":"object","required":["external_id"],"properties":{"external_id":{"type":"string"},"email":{"type":"string"},"phone":{"type":"string"},"firstname":{"type":"string"},"lastname":{"type":"string"},"address":{"type":"string"},"zip":{"type":"string"},"city":{"type":"string"},"company":{"type":"string"},"birthday":{"type":"string","format":"date"},"gender":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"custom_fields":{"type":"object"}}}},"subscriber_email_stats":{"type":"object","properties":{"clicks":{"type":"integer"},"opens":{"type":"integer"},"newsletters_clicked":{"type":"array","items":{"type":"integer"}},"newsletters_opened":{"type":"array","items":{"type":"integer"}},"received":{"type":"integer"},"newsletters_received":{"type":"array","items":{"type":"integer"}}}},"list_params":{"type":"object","required":["title"],"properties":{"title":{"type":"string"}}},"list":{"type":"object","required":["id","title","date_created","date_updated","subscriber_emails","subscriber_sms"],"properties":{"id":{"type":"integer"},"title":{"type":"string"},"date_created":{"type":"string","format":"date"},"date_updated":{"type":"string","format":"date"},"subscriber_emails":{"type":"integer"},"subscriber_sms":{"type":"integer"}}},"subscriber_params":{"type":"object","required":["email","status"],"properties":{"email":{"type":"string"},"firstname":{"type":"string"},"lastname":{"type":"string"},"address":{"type":"string"},"zip":{"type":"string"},"city":{"type":"string"},"phone":{"type":"string"},"company":{"type":"string"},"birthday":{"type":"string","format":"date"},"tags":{"type":"array","items":{"type":"string"}},"external_id":{"type":"string"},"gender":{"type":"string"}}},"subscriber":{"type":"object","required":["id","email","firstname","lastname","address","zip","city","phone","company","birthday","gender","date_created","date_updated"],"properties":{"id":{"type":"integer"},"email":{"type":"string","nullable":true},"firstname":{"type":"string","nullable":true},"lastname":{"type":"string","nullable":true},"address":{"type":"string","nullable":true},"zip":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"birthday":{"type":"string","format":"date","nullable":true},"gender":{"type":"string","nullable":true},"tags":{"type":"array","items":{"type":"string"}},"lists":{"type":"array","items":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"}}}},"external_id":{"type":"string","nullable":true},"date_created":{"type":"string","format":"date"},"date_updated":{"type":"string","format":"date"},"email_status":{"type":"string","nullable":true},"phone_status":{"type":"string","nullable":true}}},"subscriberstatus":{"type":"object","required":["id","email","firstname","lastname","address","zip","city","phone","company","birthday","gender","date_created","date_updated","inactive_emails","inactive_phones","date_updated_by_user"],"properties":{"id":{"type":"integer"},"email":{"type":"string","nullable":true},"firstname":{"type":"string","nullable":true},"lastname":{"type":"string","nullable":true},"address":{"type":"string","nullable":true},"zip":{"type":"string","nullable":true},"city":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"company":{"type":"string","nullable":true},"birthday":{"type":"string","format":"date","nullable":true},"gender":{"type":"string","nullable":true},"date_created":{"type":"string","format":"date"},"date_updated":{"type":"string","format":"date"},"inactive_emails":{"type":"array","items":{"type":"object","required":["email","status"],"properties":{"email":{"type":"string"},"status":{"type":"string"},"reason":{"type":"string"}}}},"inactive_phones":{"type":"array","items":{"type":"object","required":["phone","status"],"properties":{"phone":{"type":"string"},"status":{"type":"string"},"reason":{"type":"string"}}}},"date_updated_by_user":{"type":"string","format":"date"}}},"subscribers":{"type":"array","items":{"$ref":"#/components/schemas/subscriber"}},"custom_field":{"type":"object","required":["id","label","value","datatype"],"properties":{"id":{"type":"integer"},"label":{"type":"string"},"value":{"type":"string"},"choices":{"type":"array","items":{"type":"string"}},"datatype":{"type":"string"}}},"custom_field_params":{"type":"object","required":["label","datatype"],"properties":{"label":{"type":"string"},"datatype":{"type":"string"},"choices":{"type":"array","items":{"type":"string"}}}},"event_bounce":{"type":"object","required":["subscriber_email_id","reasoncode","created_at","sending_id","bounce_source","email"],"properties":{"subscriber_email_id":{"type":"integer"},"reason":{"type":"string","nullable":true},"reasoncode":{"type":"integer"},"bounce_message":{"type":"string","nullable":true},"created_at":{"type":"string"},"sending_id":{"type":"integer"},"bounce_source":{"type":"string"},"email":{"type":"string"},"external_id":{"type":"string","nullable":true}}},"event_click":{"type":"object","required":["subscriber_email_id","sending_id","original_link","email"],"properties":{"subscriber_email_id":{"type":"integer"},"ua_browser":{"type":"string","nullable":true},"ua_version":{"type":"string","nullable":true},"ua_platform":{"type":"string","nullable":true},"ua_device":{"type":"string","nullable":true},"sending_id":{"type":"integer"},"link_id":{"type":"integer","nullable":true},"original_link":{"type":"string"},"created_at":{"type":"string"},"email":{"type":"string"},"external_id":{"type":"string","nullable":true}}},"event_open":{"type":"object","required":["subscriber_email_id","sending_id","email"],"properties":{"subscriber_email_id":{"type":"integer"},"ua_browser":{"type":"string","nullable":true},"ua_version":{"type":"string","nullable":true},"ua_platform":{"type":"string","nullable":true},"ua_device":{"type":"string","nullable":true},"sending_id":{"type":"integer"},"created_at":{"type":"string"},"email":{"type":"string"},"external_id":{"type":"string","nullable":true}}},"event_sending":{"type":"object","required":["subscriber_email_id","sending_id","email"],"properties":{"subscriber_email_id":{"type":"integer"},"sending_id":{"type":"integer"},"created_at":{"type":"string"},"email":{"type":"string"},"external_id":{"type":"string","nullable":true}}},"event_unsubscribe":{"type":"object","required":["unsubscribable_type","unsubscribable_id","sending_id","email"],"properties":{"unsubscribable_type":{"type":"string"},"unsubscribable_id":{"type":"integer"},"reason":{"type":"string","nullable":true},"reasoncode":{"type":"integer","nullable":true},"ua_browser":{"type":"string","nullable":true},"ua_version":{"type":"string","nullable":true},"ua_platform":{"type":"string","nullable":true},"ua_device":{"type":"string","nullable":true},"created_at":{"type":"string"},"sending_id":{"type":"integer"},"email":{"type":"string"},"external_id":{"type":"string","nullable":true}}},"subscriber_tag":{"type":"object","properties":{"id":{"type":"integer"},"title":{"type":"string"},"total":{"type":"integer"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"subscribers_with_tag":{"type":"integer"}}},"subscriber_tag_params":{"type":"object","required":["title"],"properties":{"title":{"type":"string"}}},"subscriber_tickets_params":{"type":"object","required":["subscriber_tickets"],"properties":{"subscriber_tickets":{"type":"array","items":{"type":"object","required":["email","tickets"],"properties":{"email":{"type":"string"},"tickets":{"type":"array","items":{"type":"object","required":["external_id","event_external_id"],"properties":{"external_id":{"type":"string"},"event_external_id":{"type":"string"},"count":{"type":"integer"},"price_cents":{"type":"integer"},"purchased_at":{"type":"string","format":"date"},"status":{"type":"string","enum":["active","cancelled"]}}}}}}}}},"subscriber_external_id_tickets_params":{"type":"object","required":["subscriber_tickets"],"properties":{"subscriber_tickets":{"type":"array","items":{"type":"object","required":["external_id","tickets"],"properties":{"external_id":{"type":"string"},"tickets":{"type":"array","items":{"type":"object","required":["external_id","event_external_id"],"properties":{"external_id":{"type":"string"},"event_external_id":{"type":"string"},"count":{"type":"integer"},"price_cents":{"type":"integer"},"status":{"type":"string","enum":["active","cancelled"]},"purchased_at":{"type":"string","format":"date"}}}}}}}}},"subscriber_ticket_param":{"type":"object","required":["ticket"],"properties":{"ticket":{"type":"object","required":["ticket_external_id","event_external_id","event_start_date","event_end_date"],"properties":{"ticket_external_id":{"type":"string"},"event_external_id":{"type":"string"},"event_title":{"type":"string"},"event_category":{"type":"string"},"event_start_date":{"type":"string","format":"date"},"event_end_date":{"type":"string","format":"date"},"status":{"type":"string","enum":["active","cancelled"]},"purchased_at":{"type":"string","format":"date"},"event_venue":{"type":"string"}}}}},"subscriber_ticket_events_params":{"type":"object","required":["events"],"properties":{"events":{"type":"array","items":{"type":"object","required":["external_id","start_date"],"properties":{"external_id":{"type":"string"},"title":{"type":"string"},"category":{"type":"string"},"start_date":{"type":"string","format":"date"},"end_date":{"type":"string","format":"date"},"venue":{"type":"string"},"url":{"type":"string"},"status":{"type":"string","enum":["active","cancelled"]}}}}}},"newsletter":{"type":"object","properties":{"id":{"type":"integer"},"openrate":{"type":"number","format":"float"},"subscriber_list_ids":{"type":"array","items":{"type":"string"}},"subscriber_segment_ids":{"type":"array","items":{"type":"string"}},"send_at":{"type":"string","format":"date"},"sent_at":{"type":"string","format":"date"},"unique_clicks":{"type":"integer"},"clicks":{"type":"integer"},"complaints":{"type":"integer"},"opens":{"type":"integer"},"bounce":{"type":"integer"},"unsubscribes":{"type":"integer"},"scheduled":{"type":"integer"},"sent":{"type":"integer"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"tracking_mode":{"type":"string"},"external_guid":{"type":"integer"},"webversion_url":{"type":"string"},"preheader":{"type":"string"},"opened_at":{"type":"string","format":"date","nullable":true},"clicked_at":{"type":"string","format":"date","nullable":true}}},"subscriber_subscriptions_params":{"type":"object","required":["subscriber_subscriptions"],"properties":{"subscriber_subscriptions":{"type":"array","items":{"type":"object","required":["email","subscriptions"],"properties":{"email":{"type":"string"},"subscriptions":{"type":"array","items":{"required":["external_id","product_external_id","start_date"],"properties":{"external_id":{"type":"string"},"product_external_id":{"type":"string"},"start_date":{"type":"string","format":"date"},"end_date":{"type":"string","format":"date"},"name":{"type":"string"},"deliveries":{"type":"integer"},"interval_days":{"type":"integer"},"status":{"type":"string","enum":["active","cancelled"]},"payment_method_name":{"type":"string"},"cancellation_reason":{"type":"string"},"cancel_date":{"type":"string","format":"date"}}}}}}}}},"subscriber_by_ext_id_subscriptions_params":{"type":"object","required":["subscriber_subscriptions"],"properties":{"subscriber_subscriptions":{"type":"array","items":{"type":"object","required":["external_id","subscriptions"],"properties":{"external_id":{"type":"string"},"subscriptions":{"type":"array","items":{"required":["external_id","product_external_id","start_date"],"properties":{"external_id":{"type":"string"},"product_external_id":{"type":"string"},"start_date":{"type":"string","format":"date"},"end_date":{"type":"string","format":"date"},"name":{"type":"string"},"deliveries":{"type":"integer"},"interval_days":{"type":"integer"},"status":{"type":"string","enum":["active","cancelled"]},"payment_method_name":{"type":"string"},"cancellation_reason":{"type":"string"},"cancel_date":{"type":"string","format":"date"}}}}}}}}},"subscriber_subscription_params":{"type":"object","required":["subscription"],"properties":{"subscription":{"type":"object","required":["external_id","product_external_id","start_date"],"properties":{"external_id":{"type":"string"},"product_external_id":{"type":"string"},"start_date":{"type":"string","format":"date"},"end_date":{"type":"string","format":"date"},"interval_days":{"type":"integer"},"name":{"type":"string"},"deliveries":{"type":"integer"},"status":{"type":"string","enum":["active","cancelled"]},"payment_method_name":{"type":"string"},"cancellation_reason":{"type":"string"},"cancel_date":{"type":"string","format":"date"}}}}},"subscriber_subscription":{"type":"object","properties":{"id":{"type":"integer"},"external_id":{"type":"string"},"product_external_id":{"type":"string"},"start_date":{"type":"string","format":"date"},"end_date":{"type":"string","format":"date","nullable":true},"interval_days":{"type":"integer","nullable":true},"name":{"type":"string"},"deliveries":{"type":"integer","nullable":true},"status":{"type":"string","enum":["active","cancelled"]},"payment_method_name":{"type":"string","nullable":true},"cancellation_reason":{"type":"string","nullable":true},"cancel_date":{"type":"string","format":"date","nullable":true}}},"subscription_products_params":{"type":"object","required":["products"],"properties":{"products":{"type":"array","items":{"type":"object","required":["external_id"],"properties":{"external_id":{"type":"string"},"name":{"type":"string"},"price_cents":{"type":"integer"}}}}}}}}}