Jump to Content
Home
Tutorials
API Reference
Home
Tutorials
API Reference
Discussions
Home
Tutorials
API Reference
Log In
API Reference
Log In
API Reference
Retrieve Users
All
Pages
Start typing to search…
JUMP TO
OptiPub Endpoints
Overview
Creating an API Token
Accessing the API
BILLING
Pricing Plans
Retrieve Pricing Plans
get
Create Pricing Plan
post
Retrieve Pricing Plan
get
Update Pricing Plan
put
Retrieve Discord Roles
get
Discount Pricing Plan
post
CORE
Permissions
Retrieve Access Rules
get
Update Group Permission
put
Update User Permission
put
Assets
Retrieve Assets
get
Upload Asset
post
Update Asset
put
Delete Asset
del
Business Infomation
Retrieve Business Info details
get
Calendar Event
Retrieve Calendar Events
get
Created Calendar Event
post
Retrieve a Calendar Event
get
Update Calendar Event
put
Deleted Calendar Event
del
Calendar Event Categories
Retrieved Calendar Event Categories
get
Create Calendar Event Category
post
Retrieved Calendar Event Category
get
Update Calendar Event Category
put
Delete Calendar Event Category
del
Changes
Retrieve Changes
get
Retrieve Change
get
Retrieve Related Changes
get
Custom Content Categories
Retrieve Custom Content Categories
get
Create Custom Content Category
post
Retrieve Custom Content Category
get
Update Custom Content Category
put
Custom Content
Retrieve Custom Content
get
Create Custom Content
post
Update Custom Content
put
Delete Custom Content
del
Domains
Retrieve Domains
get
Create Domain
post
Retrieve Domain
get
Update Domain
put
Delete Domain
del
Refresh Domain
get
Groups
Retrieve Groups
get
Create Group
post
Retrieve Group
get
Update Group
put
Delete Group
del
Ip Addresses
Retrieve IP addresses
get
Create IP Address
post
Retrieve IP Address
get
Update IP Address
put
Delete IP Address
del
Macros
Retrieve Macros
get
Retrieve Macro
get
Publications
Retrieve Publication
get
Update Publication
put
Delete Publication
del
Retrieve Publications
get
Create Publication
post
Setting Presets
Retrieve Setting Preset
get
Create Setting Preset
post
Retrieve a Setting Preset
get
Delete Setting Preset
del
Subscribers
Retrieve Subscriber History
get
Retrieve Subscriber
get
Authenticate Subscriber
post
Update Subscriber
put
Subscription Addons
Create Subscription Addon
post
Update Subscription Addon
put
Stop Subscription Addon
del
Subscriptions
Retrieve Subscriptions
get
Create Subscription
post
Retrieve Subscription
get
Update Subscription
put
Stop Subscription
del
Tags
Retrieve Tags
get
Create a Tag
post
Retrieve Tag
get
Update a Tag
put
Merge Tags
post
Tasks
Retrieve Tasks
get
Retrieve Task
get
Template Categories
Retrieve Template Categories
get
Create Template Category
post
Retrieve Template Category
get
Update Template Category
put
Retrieve Template Category Types
get
Retrieve Template Category Type
get
Templates
Retrieve Templates
get
Create Template
post
Retrieve Template
get
Update Template
put
Two-factor Authentication
Generate Two-factor code
post
Validate Two-factor code
post
Users
Retrieve Users
get
Create User
post
Retrieve User
get
Update User
put
Webhooks
Retrieve Webhooks
get
Create Webhook
post
Retrieve Webhook
get
Delete Webhook
del
Assets
Import Asset from URL
post
Postmaster+
Start Blocklist Scan
post
Get Blocklist Scan Status
get
Check Postmaster+ Configuration
get
Webhook History
Retrieve Webhook History
get
CONTENTS
Author Categories
Retrieve Author Categories
get
Create Author Category
post
Retrieve Author Categories
get
Update Author Category
put
Authors
Retrieve Authors
get
Update Author
put
Create Author
post
Retrieve Author
get
Delete Author
del
Retrieve Authors - Frontend
get
Retrieve Authors - Frontend
get
Frequently Asked Questions
Retrieve FAQs
get
Create FAQ's
post
Retrieve FAQ
get
Update FAQ's
put
Delete FAQ
del
Retrieve FAQs - Frontend
get
Forms
Retrieve Form Responses
get
Retrieve Forms
get
Create Form
post
Retrieve Form
get
Delete Form
del
Retrieve Form - Frontend
get
Page Categories
Retrieve Page Categories
get
Retrieve Page Category
get
Update Page Category
put
Create Page Category
post
Pages
Create Page Preview
post
Retrieve Page Preview
get
Retrieve Page Types
get
Retrieve Page Type
get
Retrieve Pages
get
Create Page
post
Retrieve Page
get
Update Page
put
Delete Page
del
Redirects
Retrieve Redirects
get
Create Redirect
post
Retrieve Redirect
get
Update Redirect
put
Delete Redirect
del
Resource Categories
Retrieve Resource Categories
get
Create Resource Category
post
Retrieve Resource Category
get
Update Resource Category
put
Resources
Retrieve Resources
get
Retrieve Resource
get
Update Resource
put
Create Resource
post
Delete Resource
del
Retrieve Resources - Frontend
get
Retrieve Resource - Frontend
get
Videos
Retrieve Videos
get
Create Video
post
Retrieve Video
get
Update Video
put
Delete Video
del
Retrieve Video Wistia
get
Retrieve Wistia API Token
get
Retrieve Videos - Frontend
get
Retrieve Video - Frontend
get
Videos
Upload Video to Wistia
post
MESSAGING
Auto Responder Categories
Retrieve Auto Responder Categories
get
Create Auto Responder Category
post
Retrieve Auto Responder Category
get
Retrieve Auto Responder Category Types
get
Retrieve Auto Responder Category Type
get
Auto Responders
Retrieve Auto Responders
get
Create Auto Responder
post
Retrieve Auto Responder
get
Update Auto Responder
put
Auto Responder Variant
Update Auto Responder Variant
put
Create Auto Responder Variant
post
Retrieve Auto Responder Variant
get
Auto Select Segments
Retrieve Auto Select Segments
get
Create Auto Select Segment
post
Retrieve Auto Select Segment
get
Delete Auto Select Segment
del
Message Bindings
Retrieve Message Bindings
get
Retrieve Message Binding
get
Update Message Binding
put
Message Contents
Retrieve Message Contents
get
Retrieve Message Content
get
Message Types
Retrieve Message Types
get
Retrieve Message Types
get
Messages
Retrieve Messages
get
Create Message
post
Retrieve message
get
Sales
Retrieve Sales
get
Segments
Retrieve Segment Counts
get
Retrieve Segment Count
get
Export Segments
post
Export Segment
post
Retrieve Segments History
get
Import Segment
post
Retrieve Segment Selects
get
Create Segment Split
post
Add Subscriber To Segment
post
Remove Subscriber From Segment
del
Retrieve Segments
get
Create Segment
post
Delete Segment
del
Senders
Retrieve Senders
get
Create Sender
post
Retrieve Sender
get
Update Sender
put
Message Statistics
Retrieve Statistics
get
Transactional
Auto Responder Transactional
post
HTML Transactional
post
Variables
Retrieve Variables
get
Create Variable
post
Retrieve Variable
get
Update Variable
put
MARKETING
Ad Categories
Retrieve Ad Categories
get
Create Ad Category
post
Retrieve Ad Categories
get
Update Ad Category
put
Delete marketing ad category
del
Ads
Retrieve Marketing Text Ads
get
Create Marketing Text Ad
post
Retrieve Marketing Text Ad
get
Update Marketing text Ad
put
Delete Marketing Text Ad
del
Funnel Actions History
Retrieve Funnel Actions History
get
Funnels
Retrieve Funnels
get
Create Funnel
post
Retrieve Funnel
get
Update Funnel
put
Delete Funnel
del
GoogleTagManagerContainers
Retrieve Google Tag Manager Containers
get
Create Google Tag Manager Container
post
Retrieve Google Tag Manager Container
get
Update Google Tag Manager Container
put
Delete Google Tag Manager Container
del
Landing Page Categories
Retrieved Landing Page Categories
get
Create Landing Page Category
post
Retrieved Landing Pages Category
get
Update Landing Page Category
put
Delete Landing Page Category
del
Landing Page Categories Types
Retrieved Landing Page Categories Types
get
Retrieved Landing Pages Category Type
get
Landing Pages
Retrieve Landing Pages
get
Create Landing Page
post
Retrieve Landing Page
get
Updated Landing Page
put
Deleted Landing Page
del
Partner Categories
Retrieve Partner Categories
get
Create Partner Category
post
Retrieve Partner Category
get
Update Partner Category
put
Delete Partner Category
del
Partners
Retrieve Partners
get
Create Partners
post
Retrieve Partner
get
Update Partner
put
Delete Partner
del
Testimonials
Retrieve Testimonials
get
Create Testimonal
post
Retrieve Testimonial
get
Update Testimonial
put
Delete Testimonial
del
Landing Page by Effort
Retrieve Landing Page by Effort
get
Campaigns
Retrieve Campaigns
get
Create Campaign
post
Retrieve Campaign
get
Update Campaign
put
Delete Campaign
del
Effort Types
Retrieved Effort Types
get
Retrieved Effort Type
get
Powered by
Retrieve Users
Ask AI
get
https://{APP_DOMAIN}/api/3.2/users
Language
Shell
Node
Ruby
PHP
Python
Credentials
Bearer
JWT
Bearer
URL
Base URL
https://
www.optipub.com
/api/3.2
/users
