{ "info": { "_postman_id": "apeiron-cellular", "name": "Apeiron API - Cellular", "description": "Cellular mobile subscriber management \u2014 voice+data MDN lifecycle, service plans, porting/validation, activation/suspension/reconnect, subscriber info, device tracking, and top-ups. Resources are identified by MDN.\n\nCollection Version: 1.0.0\nBase URL: https://api.apeiron.io/v2\nAuth: HTTP Basic (email + API token) or JWT Bearer token\nAPI Reference: https://api.apeiron.io/v2/", "version": "1.0.0", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "auth": { "type": "basic", "basic": [ { "key": "username", "value": "{{username}}", "type": "string" }, { "key": "password", "value": "{{api_token}}", "type": "string" } ] }, "variable": [ { "key": "base_url", "value": "https://api.apeiron.io", "type": "string" }, { "key": "username", "value": "", "type": "string" }, { "key": "api_token", "value": "", "type": "string" } ], "item": [ { "name": "Cellular", "description": "Cellular endpoints", "item": [ { "name": "Validate cellular port in", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/cellular/validate", "host": [ "{{base_url}}" ], "path": [ "cellular", "validate" ] }, "description": "Validate cellular number(s) for porting", "body": { "mode": "formdata", "formdata": [ { "key": "number", "description": "MDN number", "type": "text", "value": "" }, { "key": "iccid", "description": "", "type": "text", "value": "" }, { "key": "provider", "description": "Check if MDN is portable on a specific provider", "type": "text", "value": "" } ] } } }, { "name": "Create cellular port in order", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/cellular/port", "host": [ "{{base_url}}" ], "path": [ "cellular", "port" ] }, "description": "Create cellular port in order for a single MDN", "body": { "mode": "formdata", "formdata": [ { "key": "mdn", "description": "MDN phone number to be ported", "type": "text", "value": "" }, { "key": "iccid", "description": "", "type": "text", "value": "" }, { "key": "authorization_name", "description": "", "type": "text", "value": "" }, { "key": "first_name", "description": "", "type": "text", "value": "" }, { "key": "last_name", "description": "", "type": "text", "value": "" }, { "key": "address1", "description": "", "type": "text", "value": "" }, { "key": "address2", "description": "", "type": "text", "value": "" }, { "key": "city", "description": "", "type": "text", "value": "" }, { "key": "state", "description": "", "type": "text", "value": "" }, { "key": "postal_code", "description": "", "type": "text", "value": "" }, { "key": "account_number", "description": "", "type": "text", "value": "" }, { "key": "pin", "description": "", "type": "text", "value": "" }, { "key": "ticket_id", "description": "", "type": "text", "value": "" }, { "key": "reference", "description": "", "type": "text", "value": "" }, { "key": "service_plan", "description": "Desired service plan to apply to the line. Please see **[GET /cellular/service_plans/list](#tag/Cellular/operation/listCellularPlans)** for valid values.", "type": "text", "value": "" }, { "key": "subscriber_service_plan_id", "description": "Desired subscriber service plan to apply. Please see **[GET /cellular/subscriber_service_plans/list](#tag/Cellular/operation/listCellularSubscriberPlans)** for valid values.", "type": "text", "value": "" }, { "key": "business_name", "description": "Business name for subscriber", "type": "text", "value": "" }, { "key": "e911_address1", "description": "Line 1 of street address for subscriber e911 information", "type": "text", "value": "" }, { "key": "e911_address2", "description": "Line 2 of street address for subscriber e911 information", "type": "text", "value": "" }, { "key": "e911_city", "description": "City for subscriber e911 information", "type": "text", "value": "" }, { "key": "e911_state", "description": "State for subscriber e911 information", "type": "text", "value": "" }, { "key": "e911_postal_code", "description": "Postal code for subscriber e911 information", "type": "text", "value": "" }, { "key": "create_subscriber", "description": "Create a Subscriber entry using the address information sent in the port request.", "type": "text", "value": "" }, { "key": "use_subscriber_address_for_e911", "description": "Create a Subscriber entry using the address information sent in the port request if it doesnt exist. Additionally use the new or existing subscribers address as the e911 address. This option is incompatible with the other e911 fields on this API.", "type": "text", "value": "" } ] } } }, { "name": "Reset cellular voicemail password", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/cellular/reset_voicemail_password/{mdn}", "host": [ "{{base_url}}" ], "path": [ "cellular", "reset_voicemail_password", "{mdn}" ] }, "description": "Reset cellular voicemail password by MDN" } }, { "name": "List Cellular SIM service plans", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/cellular/service_plans/list?page=", "host": [ "{{base_url}}" ], "path": [ "cellular", "service_plans", "list" ], "query": [ { "key": "page", "value": "", "description": "Page number for the paginated version of the response, with 20 items per page", "disabled": true } ] }, "description": "Return list of available cellular plans to activate SIMs with or to change the service plan to for the customer. This endpoint returns all entries unless the page GET parameter is sent, and in that case the list of sim card plans is present in data along with pagination related properties." } }, { "name": "Get cellular service plan details", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/cellular/service_plans/{plan_id}", "host": [ "{{base_url}}" ], "path": [ "cellular", "service_plans", "{plan_id}" ] }, "description": "Get cellular service plan details by ID. See listCellularPlans for a list of available service plan IDs." } }, { "name": "List cellular subscriber service plans", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/cellular/subscriber_service_plans/list?provider=", "host": [ "{{base_url}}" ], "path": [ "cellular", "subscriber_service_plans", "list" ], "query": [ { "key": "provider", "value": "", "description": "Provider to filter on", "disabled": true } ] }, "description": "List cellular subscriber service plans" } }, { "name": "Get cellular subscriber service plan details", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/cellular/subscriber_service_plans/{plan_id}", "host": [ "{{base_url}}" ], "path": [ "cellular", "subscriber_service_plans", "{plan_id}" ] }, "description": "Get cellular subscriber service plan details by ID. See listCellularSubscriberPlans for a list of available service plan IDs." } }, { "name": "Validate cellular device", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/cellular/validate_devices", "host": [ "{{base_url}}" ], "path": [ "cellular", "validate_devices" ] }, "description": "Validate cellular device for network support", "body": { "mode": "formdata", "formdata": [ { "key": "imei", "description": "", "type": "text", "value": "" }, { "key": "carrier", "description": "References the carrier to validate the device IMEI against. Valid values are `TMO`.", "type": "text", "value": "" } ] } } }, { "name": "Restore cellular device", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/cellular/suspend/activate/{mdn}/", "host": [ "{{base_url}}" ], "path": [ "cellular", "suspend", "activate", "{mdn}" ] }, "description": "Restore cellular device" } }, { "name": "Suspend cellular device", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/cellular/suspend/deactivate/{mdn}/", "host": [ "{{base_url}}" ], "path": [ "cellular", "suspend", "deactivate", "{mdn}" ] }, "description": "Suspend cellular device", "body": { "mode": "formdata", "formdata": [ { "key": "hotline_number", "description": "Number to hotline to", "type": "text", "value": "" } ] } } }, { "name": "Reconnect cellular device", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/cellular/reconnect/{mdn}/", "host": [ "{{base_url}}" ], "path": [ "cellular", "reconnect", "{mdn}" ] }, "description": "Reconnect cellular device", "body": { "mode": "formdata", "formdata": [ { "key": "iccid", "description": "ICCID", "type": "text", "value": "" } ] } } }, { "name": "Get subscriber line info", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/cellular/subscriber/lineinfo/{mdn}", "host": [ "{{base_url}}" ], "path": [ "cellular", "subscriber", "lineinfo", "{mdn}" ] }, "description": "Get subscriber line info" } }, { "name": "Top up cellular device", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/cellular/subscriber/topup/{mdn}", "host": [ "{{base_url}}" ], "path": [ "cellular", "subscriber", "topup", "{mdn}" ] }, "description": "Top up cellular device", "body": { "mode": "formdata", "formdata": [ { "key": "subscriber_serviceplan_id", "description": "Service plan ID to use for the top up", "type": "text", "value": "" } ] } } }, { "name": "Get Cellular SIM Card Info", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/cellular/simcards/{mdn}", "host": [ "{{base_url}}" ], "path": [ "cellular", "simcards", "{mdn}" ] }, "description": "Return the basic information about a Cellular SIM card" } }, { "name": "Get Cellular SIM Card Info by MDN or ICCID", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/cellular/simcards/info?mdn=3333333333&iccid=89148000005689140000", "host": [ "{{base_url}}" ], "path": [ "cellular", "simcards", "info" ], "query": [ { "key": "mdn", "value": "3333333333", "description": "MDN", "disabled": false }, { "key": "iccid", "value": "89148000005689140000", "description": "ICCID", "disabled": false } ] }, "description": "Return the basic information about a Cellular SIM card. Either `mdn` or `iccid` must be provided in the query parameter." } }, { "name": "Swap Cellular SIM Card", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/cellular/simcards/{mdn}/swap", "host": [ "{{base_url}}" ], "path": [ "cellular", "simcards", "{mdn}", "swap" ] }, "description": "Swap the SIM card for a Cellular device with another one.", "body": { "mode": "formdata", "formdata": [ { "key": "new_iccid", "description": "ICCID of the SIM Card being swapped to.", "type": "text", "value": "" } ] } } }, { "name": "Swap Cellular MDN", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/cellular/{mdn}/swap", "host": [ "{{base_url}}" ], "path": [ "cellular", "{mdn}", "swap" ] }, "description": "Request a new MDN for a cellular device.", "body": { "mode": "formdata", "formdata": [ { "key": "zip_code", "description": "Zip code to request new number for.", "type": "text", "value": "" } ] } } }, { "name": "Get list of Cellular SIM cards of user", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/cellular/simcards/?page=&activated=&available=&suspended=&skus=&provider=&product_type=", "host": [ "{{base_url}}" ], "path": [ "cellular", "simcards" ], "query": [ { "key": "page", "value": "", "description": "Page number for the paginated version of the response, with 20 items per page", "disabled": true }, { "key": "activated", "value": "", "description": "Filter by SIM cards by activated status, true or false", "disabled": true }, { "key": "available", "value": "", "description": "Filter by SIM cards by available status, true or false", "disabled": true }, { "key": "suspended", "value": "", "description": "Filter by SIM cards by suspended status, true or false", "disabled": true }, { "key": "skus", "value": "", "description": "Only show SIM cards of the specified SKUs", "disabled": true }, { "key": "provider", "value": "", "description": "Only show SIM cards of the specified provider", "disabled": true }, { "key": "product_type", "value": "", "description": "Only show SIM cards of the specified product type", "disabled": true } ] }, "description": "Return list of Cellular SIM cards belonging to the authenticated user, returns all entries unless page GET parameter is sent, and in that case the list of sim cards is present in data along with pagination related properties." } }, { "name": "Get list of Cellular MDNs of user", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/cellular/mdns/?page=&activated=&suspended=&skus=&provider=&product_type=", "host": [ "{{base_url}}" ], "path": [ "cellular", "mdns" ], "query": [ { "key": "page", "value": "", "description": "Page number for the paginated version of the response, with 20 items per page", "disabled": true }, { "key": "activated", "value": "", "description": "Filter by MDNs by activated status, true or false", "disabled": true }, { "key": "suspended", "value": "", "description": "Filter by MDNs by suspended status, true or false", "disabled": true }, { "key": "skus", "value": "", "description": "Only show MDNs of the specified SKUs", "disabled": true }, { "key": "provider", "value": "", "description": "Only show MDNs of the specified provider", "disabled": true }, { "key": "product_type", "value": "", "description": "Only show MDNs of the specified product type", "disabled": true } ] }, "description": "Return list of Cellular MDNs belonging to the authenticated user, returns all entries unless page GET parameter is sent, and in that case the list of mdns is present in data along with pagination related properties." } }, { "name": "Update SIM Card label, cost center or service plan", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/cellular/update/{mdn}/", "host": [ "{{base_url}}" ], "path": [ "cellular", "update", "{mdn}" ] }, "description": "Update a SIM card's label or cost center fields, if provided, at least one of the two must be provided while making the request", "body": { "mode": "formdata", "formdata": [ { "key": "label", "description": "Label of the SIM card, optional, will only be updated if provided", "type": "text", "value": "" }, { "key": "cost_center_id", "description": "ID of the cost center, optional, will only be updated if provided", "type": "text", "value": "" }, { "key": "service_plan", "description": "Service plan for activation, optional, will only be updated if provided, change will be scheduled for the next billing cycle", "type": "text", "value": "" }, { "key": "override_pending", "description": "If an existing service plan change was already requested, setting this to true allows to cancel the existing request and process a new service plan change, this will only allow for overriding till 7 hours before the end of current billing cycle. defaults to false", "type": "text", "value": "" }, { "key": "change_type", "description": "Type of service plan change to be made, one of 'next_billing_cycle', 'backdate' or 'immediate', defaults to 'next_billing_cycle'", "type": "text", "value": "" } ] } } }, { "name": "Order new physical cellular SIM Cards", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/cellular/order_physicalsim/", "host": [ "{{base_url}}" ], "path": [ "cellular", "order_physicalsim" ] }, "description": "Order new physical cellular SIM Cards", "body": { "mode": "formdata", "formdata": [ { "key": "shipping_contact", "description": "Contact name for shipping", "type": "text", "value": "" }, { "key": "shipping_company_name", "description": "Company name for shipping", "type": "text", "value": "" }, { "key": "shipping_address1", "description": "Address line 1 for shipping", "type": "text", "value": "" }, { "key": "shipping_address2", "description": "Address line 2 for shipping", "type": "text", "value": "" }, { "key": "shipping_city", "description": "City for shipping", "type": "text", "value": "" }, { "key": "shipping_state", "description": "State for shipping", "type": "text", "value": "" }, { "key": "shipping_postal_code", "description": "Postal code for shipping", "type": "text", "value": "" }, { "key": "contact_phone_number", "description": "Phone number for contact", "type": "text", "value": "" }, { "key": "shipping_type", "description": "Shipping type, one of ground, 2-day and overnight", "type": "text", "value": "" }, { "key": "shipping_dropship", "description": "Whether to dropship the order, defaults to false", "type": "text", "value": "" }, { "key": "shipping_dropship_company_contact", "description": "Contact name for dropship company if shipping_dropship is true", "type": "text", "value": "" }, { "key": "shipping_dropship_company_name", "description": "Company name for dropship company if shipping_dropship is true", "type": "text", "value": "" }, { "key": "shipping_dropship_company_address", "description": "Address for dropship company if shipping_dropship is true", "type": "text", "value": "" }, { "key": "shipping_dropship_company_state", "description": "State for dropship company if shipping_dropship is true", "type": "text", "value": "" }, { "key": "shipping_dropship_company_zip_code", "description": "Zip code for dropship company if shipping_dropship is true", "type": "text", "value": "" }, { "key": "quantity_verizon_simcards", "description": "Quantity of Verizon SIM cards to order", "type": "text", "value": "" }, { "key": "quantity_tmobile_simcards", "description": "Quantity of T-Mobile SIM cards to order", "type": "text", "value": "" } ] } } }, { "name": "Update Subscriber Service Plan", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/cellular/update/subscriber_service_plan/{mdn}", "host": [ "{{base_url}}" ], "path": [ "cellular", "update", "subscriber_service_plan", "{mdn}" ] }, "description": "Updates the subscriber service plan for a given MDN", "body": { "mode": "formdata", "formdata": [ { "key": "subscriber_service_plan_id", "description": "Subscriber service plan ID to change to", "type": "text", "value": "" }, { "key": "subscriber_id", "description": "Subscriber ID to associate with the MDN, required if the MDN does not have a subscriber associated with it already", "type": "text", "value": "" }, { "key": "effective", "description": "Whether to make the change effective immediately or at a scheduled time, one of 'immediate' or 'scheduled'", "type": "text", "value": "" }, { "key": "scheduled_datetime", "description": "Scheduled date and time for the change to take effect, required if effective is 'scheduled', must be in ISO 8601 format, ex. 2022-11-20T14:30:00-07:00 or 2024-05-10T08:00:00Z", "type": "text", "value": "" }, { "key": "override_pending", "description": "If an existing subscriber service plan change was already requested, setting this to true allows to cancel the existing request and process a new plan change, defaults to false", "type": "text", "value": "" } ] } } }, { "name": "Activate Cellular SIM Card", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/cellular/activate/{iccid}/", "host": [ "{{base_url}}" ], "path": [ "cellular", "activate", "{iccid}" ] }, "description": "Activate a Cellular SIM card in inventory", "body": { "mode": "formdata", "formdata": [ { "key": "imei", "description": "IMEI of device to activate", "type": "text", "value": "356526070520000" }, { "key": "service_plan", "description": "Service plan for activation", "type": "text", "value": "" }, { "key": "zip_code", "description": "Zip code to use when activating the Cellular SIM card", "type": "text", "value": "" }, { "key": "subscriber_id", "description": "Subscriber ID to associate with the MDN", "type": "text", "value": "" }, { "key": "subscriber_first_name", "description": "First name of the subscriber, only needed if subscriber_id is not provided and a new subscriber needs to be created and associated with the MDN", "type": "text", "value": "" }, { "key": "subscriber_last_name", "description": "Last name of the subscriber, only needed if subscriber_id is not provided and a new subscriber needs to be created and associated with the MDN", "type": "text", "value": "" }, { "key": "subscriber_phone_number", "description": "Phone number of the subscriber, only needed if subscriber_id is not provided and a new subscriber needs to be created and associated with the MDN", "type": "text", "value": "" }, { "key": "subscriber_email", "description": "Email of the subscriber, only needed if subscriber_id is not provided and a new subscriber needs to be created and associated with the MDN", "type": "text", "value": "" }, { "key": "subscriber_pin", "description": "PIN of the subscriber, only needed if subscriber_id is not provided and a new subscriber needs to be created and associated with the MDN", "type": "text", "value": "" }, { "key": "subscriber_business_name", "description": "Business name of the subscriber, only needed optionally if subscriber_id is not provided and a new subscriber needs to be created and associated with the MDN", "type": "text", "value": "" }, { "key": "subscriber_address1", "description": "Line 1 of the subscriber's address, only needed if subscriber_id is not provided and a new subscriber needs to be created and associated with the MDN", "type": "text", "value": "" }, { "key": "subscriber_address2", "description": "Line 2 of the subscriber's address, only needed optionally if subscriber_id is not provided and a new subscriber needs to be created and associated with the MDN", "type": "text", "value": "" }, { "key": "subscriber_city", "description": "City of the subscriber's address, only needed if subscriber_id is not provided and a new subscriber needs to be created and associated with the MDN", "type": "text", "value": "" }, { "key": "subscriber_state", "description": "State of the subscriber's address, only needed if subscriber_id is not provided and a new subscriber needs to be created and associated with the MDN", "type": "text", "value": "CA" }, { "key": "subscriber_postal_code", "description": "Postal code of the subscriber's address, only needed if subscriber_id is not provided and a new subscriber needs to be created and associated with the MDN", "type": "text", "value": "" }, { "key": "subscriber_service_plan_id", "description": "Service plan ID to use to activate the SIM", "type": "text", "value": "" }, { "key": "e911_use_subscriber_address", "description": "Whether to use the subscriber's address for E911, defaults to false", "type": "text", "value": "" }, { "key": "e911_address1", "description": "Line 1 of the E911 address, only needed if e911_use_subscriber_address is false and new e911 address has to be specified", "type": "text", "value": "" }, { "key": "e911_address2", "description": "Line 2 of the E911 address, only needed if e911_use_subscriber_address is false and new e911 address has to be specified", "type": "text", "value": "" }, { "key": "e911_city", "description": "City of the E911 address, only needed if e911_use_subscriber_address is false and new e911 address has to be specified", "type": "text", "value": "" }, { "key": "e911_state", "description": "State of the E911 address, only needed if e911_use_subscriber_address is false and new e911 address has to be specified", "type": "text", "value": "CA" }, { "key": "e911_postal_code", "description": "Postal code of the E911 address, only needed if e911_use_subscriber_address is false and new e911 address has to be specified", "type": "text", "value": "" } ] } } }, { "name": "Cellular Activation Check", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/cellular/activation_check/", "host": [ "{{base_url}}" ], "path": [ "cellular", "activation_check" ] }, "description": "Validate cellular coverage based on a given ZIP code", "body": { "mode": "formdata", "formdata": [ { "key": "network", "description": "Network", "type": "text", "value": "" }, { "key": "zip_code", "description": "ZIP Code to check", "type": "text", "value": "" } ] } } } ] }, { "name": "Customer Device", "description": "Customer Device endpoints", "item": [ { "name": "Get list of devices of user", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/devices/?page=", "host": [ "{{base_url}}" ], "path": [ "devices" ], "query": [ { "key": "page", "value": "", "description": "Page number for the paginated version of the response, with 20 items per page", "disabled": true } ] }, "description": "Return list of devices belonging to the authenticated user, returns all entries unless page GET parameter is sent, and in that case the list of devices is present in data along with pagination related properties." } }, { "name": "List device note types", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/devices/note_types", "host": [ "{{base_url}}" ], "path": [ "devices", "note_types" ] }, "description": "List the available note types that can be used when entering a device note." } }, { "name": "List device note subtypes", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/devices/note_subtypes", "host": [ "{{base_url}}" ], "path": [ "devices", "note_subtypes" ] }, "description": "List the available note subtypes that can be used when entering a device note." } }, { "name": "List device notes", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/devices/{serial_number}/notes", "host": [ "{{base_url}}" ], "path": [ "devices", "{serial_number}", "notes" ] }, "description": "List the notes that have been entered for a given device." } }, { "name": "Add a new note for a device", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/devices/{serial_number}/add_note", "host": [ "{{base_url}}" ], "path": [ "devices", "{serial_number}", "add_note" ] }, "description": "Add a new note for a device.", "body": { "mode": "formdata", "formdata": [ { "key": "note", "description": "Content of the note", "type": "text", "value": "" }, { "key": "note_type", "description": "Key of the type of note being entered", "type": "text", "value": "" }, { "key": "note_subtype", "description": "Key of the subtype of note being entered. If provided, must be a subtype of the provide note type.", "type": "text", "value": "" } ] } } } ] }, { "name": "Subscriber", "description": "Subscriber endpoints", "item": [ { "name": "List subscribers", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/subscribers/list?first_name=&middle_name=&last_name=&phone_number=&email=&date_of_birth=1990-04-23&account_number=&business_name=&address_id=&e911_address_id=", "host": [ "{{base_url}}" ], "path": [ "subscribers", "list" ], "query": [ { "key": "first_name", "value": "", "description": "Filter by first name", "disabled": true }, { "key": "middle_name", "value": "", "description": "Filter by middle name", "disabled": true }, { "key": "last_name", "value": "", "description": "Filter by last name", "disabled": true }, { "key": "phone_number", "value": "", "description": "Filter by subscriber's phone number", "disabled": true }, { "key": "email", "value": "", "description": "Filter by e\u2011mail address", "disabled": true }, { "key": "date_of_birth", "value": "1990-04-23", "description": "Filter by date of birth", "disabled": true }, { "key": "account_number", "value": "", "description": "Filter by account number associated with the subscriber", "disabled": true }, { "key": "business_name", "value": "", "description": "Filter by business name", "disabled": true }, { "key": "address_id", "value": "", "description": "Filter by address ID", "disabled": true }, { "key": "e911_address_id", "value": "", "description": "Filter by E\u2011911 address ID", "disabled": true } ] }, "description": "List all subscribers related to the requesting user." } }, { "name": "Add subscriber", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/subscribers/add", "host": [ "{{base_url}}" ], "path": [ "subscribers", "add" ] }, "description": "Add new subscriber", "body": { "mode": "formdata", "formdata": [ { "key": "first_name", "description": "First name", "type": "text", "value": "" }, { "key": "middle_name", "description": "Middle name", "type": "text", "value": "" }, { "key": "last_name", "description": "Last name", "type": "text", "value": "" }, { "key": "phone_number", "description": "Phone number", "type": "text", "value": "" }, { "key": "email", "description": "Email address", "type": "text", "value": "" }, { "key": "date_of_birth", "description": "Date of birth in the format YYYY-MM-DD.", "type": "text", "value": "" }, { "key": "pin", "description": "PIN, up to 9 digits.", "type": "text", "value": "" }, { "key": "business_name", "description": "Business name", "type": "text", "value": "" }, { "key": "account_number", "description": "Optional account number to aid in identifying the subscriber.", "type": "text", "value": "" }, { "key": "address1", "description": "Street address line 1. Comprises core address data along with `city`, `state`, and `postal_code`.\nAn address as a whole is optional, but if any address parameters are provided,\nthen all four of these core parameters must be provided for it to be considered valid.\n", "type": "text", "value": "" }, { "key": "address2", "description": "Street address line 2. Optional address parameter.", "type": "text", "value": "" }, { "key": "city", "description": "City. **Required to provide an address**.", "type": "text", "value": "" }, { "key": "state", "description": "State. **Required to provide an address**.", "type": "text", "value": "" }, { "key": "postal_code", "description": "5-digit postal code. **Required to provide an address**.", "type": "text", "value": "" }, { "key": "plus_four", "description": "Additional 4 digits found in a ZIP+4. Optional address parameter.", "type": "text", "value": "" }, { "key": "e911_address1", "description": "E911 street address line 1. Comprises core address data along with `e911_city`, `e911_state`, and `e911_postal_code`.\nAn E911 address as a whole is optional, but if any E911 address parameters are provided,\nthen all four of these core parameters must be provided for it to be considered valid.\n", "type": "text", "value": "" }, { "key": "e911_address2", "description": "Street address line 2. Optional E911 address parameter.", "type": "text", "value": "" }, { "key": "e911_city", "description": "City. **Required to provide an E911 address**.", "type": "text", "value": "" }, { "key": "e911_state", "description": "State. **Required to provide an E911 address**.", "type": "text", "value": "" }, { "key": "e911_postal_code", "description": "5-digit postal code. **Required to provide an E911 address**.", "type": "text", "value": "" } ] } } }, { "name": "Get subscriber information", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/subscribers/{subscriber_id}", "host": [ "{{base_url}}" ], "path": [ "subscribers", "{subscriber_id}" ] }, "description": "Get subscriber information" } }, { "name": "Update subscriber", "request": { "method": "PUT", "header": [], "url": { "raw": "{{base_url}}/subscribers/{subscriber_id}/update", "host": [ "{{base_url}}" ], "path": [ "subscribers", "{subscriber_id}", "update" ] }, "description": "Update subscriber information", "body": { "mode": "formdata", "formdata": [ { "key": "first_name", "description": "First name", "type": "text", "value": "" }, { "key": "middle_name", "description": "Middle name", "type": "text", "value": "" }, { "key": "last_name", "description": "Last name", "type": "text", "value": "" }, { "key": "phone_number", "description": "Phone number", "type": "text", "value": "" }, { "key": "email", "description": "Email address", "type": "text", "value": "" }, { "key": "date_of_birth", "description": "Date of birth", "type": "text", "value": "" }, { "key": "pin", "description": "PIN, up to 9 digits.", "type": "text", "value": "" }, { "key": "business_name", "description": "Business name", "type": "text", "value": "" }, { "key": "account_number", "description": "Account number associated with the subscriber", "type": "text", "value": "" }, { "key": "address1", "description": "Street address line 1. Comprises core address data along with `city`, `state`, and `postal_code`.\nAn address as a whole is optional, but if the subscriber does not already have an address,\nand a new one is being provided, then all four of these core parameters must be provided for it to\nbe considered valid. Any number of optional address parameters can be provided in addition to the core\nparameters as extra details. If the subscriber *does* already have an address, all address parameters\nare optional, and any that are provided will be used to update their existing address.\n", "type": "text", "value": "" }, { "key": "address2", "description": "Street address line 2. Optional address parameter.", "type": "text", "value": "" }, { "key": "city", "description": "City. **Required** when providing a new address, optional when updating address.", "type": "text", "value": "" }, { "key": "state", "description": "State. **Required** when providing a new address, optional when updating address.", "type": "text", "value": "" }, { "key": "postal_code", "description": "5-digit postal code. **Required** when providing a new address, optional when updating address.", "type": "text", "value": "" }, { "key": "plus_four", "description": "Additional 4 digits found in a ZIP+4. Optional address parameter.", "type": "text", "value": "" }, { "key": "e911_address1", "description": "E911 Street address line 1. Comprises core address data along with `e911_city`, `e911_state`, and `e911_postal_code`.\nAn E911 address as a whole is optional, but if the subscriber does not already have an E911 address,\nand a new one is being provided, then all four of these core parameters must be provided for it to\nbe considered valid. Any number of optional address parameters can be provided in addition to the core\nparameters as extra details. If the subscriber *does* already have an E911 address, all address parameters\nare optional, and any that are provided will be used to update their existing E911 address.\n", "type": "text", "value": "" }, { "key": "e911_address2", "description": "E911 street address line 2. Optional E911 address parameter.", "type": "text", "value": "" }, { "key": "e911_city", "description": "City. **Required** when providing a new E911 address, optional when updating E911 address.", "type": "text", "value": "" }, { "key": "e911_state", "description": "State. **Required** when providing a new E911 address, optional when updating E911 address.", "type": "text", "value": "" }, { "key": "e911_postal_code", "description": "5-digit postal code. **Required** when providing a new E911 address, optional when updating E911 address.", "type": "text", "value": "" }, { "key": "reuse_address_for_e911", "description": "Whether to reuse the regular address for E911 address. Defaults to false.", "type": "text", "value": "False" } ] } } }, { "name": "Delete subscriber", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/subscribers/{subscriber_id}/delete", "host": [ "{{base_url}}" ], "path": [ "subscribers", "{subscriber_id}", "delete" ] }, "description": "Delete subscriber information" } }, { "name": "List subscriber note types", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/subscribers/note_types", "host": [ "{{base_url}}" ], "path": [ "subscribers", "note_types" ] }, "description": "List the available note types that can be used when entering a subscriber note." } }, { "name": "List subscriber note subtypes", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/subscribers/note_subtypes", "host": [ "{{base_url}}" ], "path": [ "subscribers", "note_subtypes" ] }, "description": "List the available note subtypes that can be used when entering a subscriber note." } }, { "name": "List subscriber notes", "request": { "method": "GET", "header": [], "url": { "raw": "{{base_url}}/subscribers/{subscriber_id}/notes", "host": [ "{{base_url}}" ], "path": [ "subscribers", "{subscriber_id}", "notes" ] }, "description": "List the notes that have been entered for a given subscriber." } }, { "name": "Add a new note for a subscriber", "request": { "method": "POST", "header": [], "url": { "raw": "{{base_url}}/subscribers/{subscriber_id}/add_note", "host": [ "{{base_url}}" ], "path": [ "subscribers", "{subscriber_id}", "add_note" ] }, "description": "Add a new note for a subscriber.", "body": { "mode": "formdata", "formdata": [ { "key": "note", "description": "Content of the note", "type": "text", "value": "" }, { "key": "note_type", "description": "Key of the type of note being entered", "type": "text", "value": "" }, { "key": "note_subtype", "description": "Key of the subtype of note being entered. If provided, must be a subtype of the provide note type.", "type": "text", "value": "" } ] } } } ] } ] }