1. Avatars
NetSapiens API v2
  • Authentication
    • Access Token (Oauth - Username/Password)
      • Get Access Token From Refresh
      • Get Access Token From User/Pass
      • Get Access Token after MFA request
    • API Key (Machine 2 Machine)
      • Read API Keys under your account
      • Read API Keys under your account
      • Read API Key info on your API Key
      • Create API Key
      • Update API Key
      • Revoke API Key
      • Read Info on specific APIKey via Key ID
      • Read API Keys
    • JWT (JSON Web Token)
      • Create JWT token From User/Pass
      • Create JWT token from Refresh JWT
      • Create JWT token after MFA request
      • Create JWT token For Delegated Access
      • Revoke JWT(s) by UID (user@domain)
      • Revoke JWT by JTI (JWT ID)
      • Revoke current JWT
      • Read Current JWT
      • Generate Short-Lived Application JWT
      • Create JWT token from Refresh JWT
      • Create JWT token after MFA request
    • NetsapiensJs Auth
      • MFA
        • Generate MFA Authenticator
        • MFA Verify
        • MFA Enroll (without token)
        • MFA Enroll (with token)
        • MFA Delete
      • OIDC Authorize
    • Masquerade
  • Phone Numbers
    • destination-application mappings and parameter parsing
    • Use Cases
      • Send Phonenumber to Call Queue
      • Send Phonenumber to a User
      • Send Phonenumber to Offnet Number
      • Move phonenumber back to Available in Inventory
      • Send Phonenumber to a User
      • Send Phonenumber to Offnet Number
      • Move phonenumber back to Available in Inventory
    • Count Phone Numbers for Domain
      GET
    • Get All Phone Numbers for System or Reseller
      GET
    • Count All Phone Numbers for System or Reseller
      GET
    • Get All Phone Numbers for Domain
      GET
    • Add Phone Number in Domain
      POST
    • Remove Phone Number from Domain
      DELETE
    • Update Phone Number in Domain
      PUT
    • Get Specific Phone Number in Domain
      GET
  • Phones/Macs
    • Supported Models and Servers
      • Get list of Supported/Provisionable Models
      • Get list of Supported/Provisionable by Vendor
      • Get details of Specific Model
      • Get list of Provisionable Server Profiles
      • Read Provisionable Server Details
    • Phone Configurations
    • Read Mac Addresses
    • Count Mac Addresses
    • Read Mac Addresses in Domain
    • Read Specific Mac Address
    • Read Specific Mac Addresses in Domain
    • Add MAC address
    • Add MAC address for Domain
    • Update MAC address
    • Update MAC address in Domain
    • Remove MAC address
    • Remove MAC address in Domain
  • SnapBuilder
    • Phone Templates
      • Read Phone Templates available to a Domain
      • Read Specific Phone Templates by name
      • Count Phone Templates for a Domain
      • Create Phone Template in domain
      • Update Phone Template in domain
      • Delete Phone Template in domain
    • Read Device Profiles
    • Count Device Profiles
    • Get specific Device Profile for Model of Phone
    • Count Phone Configurations in a Domain
    • Get Phone Configuration for specific Mac
    • Create Phone Configuration for Specific Mac Address
    • Update Phone Configuration for Specific Mac Address
    • Delete Phone Configuration for Specific Mac Address
  • Version
    • Read API Version
    • Get Health Status of the API
  • Event Subscriptions
    • Read Event Subscriptions
    • Read Event Subscriptions for Domain
    • Read Event Subscription By Id
    • Create a Event Subscription
    • Update an Event Subscription
    • Update an Event Subscription for Domain
    • Delete a subscription
    • Delete a subscription For Domain
    • Create a Event Subscription for Domain
  • Resellers
    • Get Resellers
    • Count Resellers
    • Create Reseller
    • Update Reseller
    • Delete Reseller
    • Get Specific Reseller
  • Domains
    • Domain Templating
      • Create a Domain Template
      • Create a Domain From Template
    • Create a Domain
    • Get Domains
    • Count Domains
    • Get Specific Domain
    • Update a Domain
    • Delete a Domain
    • Get Specific Domain With Billing Summary
    • Get My Domain Info
    • Check if Domain Exists
  • Users
    • Get Users in Domain
    • Count users in Domain
    • Search for Users in Domain
    • Create User in Domain
    • Delete User in Domain
    • Update a User in Domain
    • Get Specific User in Domain
    • Get My User
    • List Basic Info on Users in Domain
    • Search for Users in Domain
  • Devices
    • Get Devices for User
    • Count Devices for Domain
    • Count Devices for Reseller
    • Count Devices for User
    • Count Devices by Device
    • Create Device for User
    • Update Device for User
    • Delete Device for User
    • Get Specifc Device
    • Get Devices in Domain
    • Get Devices for Reseller or System Wide
    • Get device profile image
    • Read a single device
    • List devices for a reseller
  • Sites
    • List Sites in Domain
    • Read Sites in Domain
    • Count Sites in Domain
    • Create Site in Domain
    • Update Site in Domain
    • Read Specific Site in Domain
  • Call Center
    • Callqueues
      • Read Call Queues in Domain
      • Create Call Queue in Domain
      • Update Call Queue in Domain
      • Delete Call Queue
      • Read Specific Call Queue
      • Read Basic info on Call Queues in Domain
    • Agents
      • Read Agents in Call Queue
      • Count Agents in Call Queue
      • Read Agents in Domain
      • Read Specific Agent in Call Queue
      • Add Agent to Call Queue
      • Update Agent in Call Queue
      • Remove Agent from Call Queue
    • Agent Actions
      • Agent Login
      • Agent Logout
      • Agent Single Call
      • Agent Set Offline Status
    • QueuedCalls
      • Read Queued Calls
      • Add a Queued Call
    • Statistics
      • Get Callqueue Statistics for a Specific Queue
      • Get Callqueue Statistics for all Queues Aggregated
      • Get Callqueue Statistics for all Queues by Queue
      • Get Agent Statistics for all Queues by Agent
      • Get Agent Statistics for Single Queues by Agent
      • Get Agent Statistics for Single Agent
      • Get DNIS Statistics for all Queues
      • Get DNIS Statistics for Single Queue
      • Get Agent Log
      • Send Call Center Email Report
      • Get Abandoned Calls for all Queues
      • Get Abandoned Calls for a Specific Queue
    • Call Dispositions
      • Read Call Dispostions
      • Create Call Disposition in Domain
  • Answer Rules
    • Read Answerrules for a User
    • Count Answerrules for a User
    • Read Answerrules for my User
    • Read Specifc Timeframe Answerrule for User
    • Add a Answerrule for a User
    • Delete a Answerrule for a User
    • Update a Answerrule for a User
    • Reorder Answerrules for my User
  • Call Blocking
    • Read blocked numbers for a Domain
    • Read blocked numbers for a User
    • Add blocked numbers for a Domain
    • Add blocked numbers for a User
    • Delete blocked numbers for a Domain
    • Delete blocked numbers for a User
  • Auto Attendant
    • Create Auto Attendant
    • Read Auto Attendants
    • Read Specific Auto Attendant
    • Update Specific Auto Attendant
    • Delete Specific Auto Attendant
  • Media
    • Voicemail
      • Read Voicemail for User by Folder
      • Count Voicemail for User by Folder
      • Read Specific Voicemail for User
      • Move Voicemail to save folder
      • Forward Voicemail to another user
      • Delete Voicemail
    • Greetings
      • Read Greetings for User
      • Count Greetings for User
      • Read Specific Greeting for User
      • Delete Specific Greeting for User
      • Create a new Greeting from TTS
      • Update Greeting with TTS script
      • Create a new Greeting from Upload (JSON + Base64 File)
      • Update Greeting from Upload (JSON + Base64 File)
      • Create a new Greeting from Upload (Multipart/Mixed Post)
      • Update Greeting from Upload (Multipart/Mixed Post)
      • Create a new Greeting from Upload (JSON + Base64 File)
      • Update Greeting from Upload (JSON + Base64 File)
      • Create a new Greeting from Upload (Multipart/Mixed Post)
      • Update Greeting from Upload (Multipart/Mixed Post)
    • Music on Hold
      • Domain
        • Read MOH for Domain
        • Count MOH for Domain
        • Create a new MOH for Domain from TTS
        • Update MOH for Domain from TTS
        • Create a new MOH for Domain from Upload (JSON + Base64 File)
        • Update MOH for Domain from Upload (JSON + Base64 File)
        • Create a new MOH for Domain from Upload (Multipart/Mixed Post)
        • Update MOH for Domain from Upload (Multipart/Mixed Post)
        • Reorder MOH for Domain
        • Delete MOH for Domain
        • Create a new MOH for Domain from Upload (JSON + Base64 File)
        • Update MOH for Domain from Upload (JSON + Base64 File)
        • Create a new MOH for Domain from Upload (Multipart/Mixed Post)
        • Update MOH for Domain from Upload (Multipart/Mixed Post)
      • User
        • Read MOH for User
        • Count MOH for User
        • Create a new MOH for Domain from TTS
        • Create a new MOH for User from Upload (JSON + Base64 File)
        • Update MOH for User from Upload (JSON + Base64 File)
        • Update MOH for Domain from TTS
        • Create a new MOH for User from Upload (Multipart/Mixed Post)
        • Update a MOH for User from Upload (Multipart/Mixed Post)
        • Reorder MOH for User
        • Delete MOH for User
        • Create a new MOH for User from Upload (JSON + Base64 File)
        • Update MOH for User from Upload (JSON + Base64 File)
        • Create a new MOH for User from Upload (Multipart/Mixed Post)
        • Update a MOH for User from Upload (Multipart/Mixed Post)
    • Hold Messages
      • Domain
        • Read Hold Messages for Domain
        • Count Hold Messages for Domain
        • Create a new Hold Messge for Domain from Upload (Multipart/Mixed Post)
        • Update Hold Messge for Domain from Upload (Multipart/Mixed Post)
        • Reorder Hold Messages for Domain
        • Delete Hold Messge for Domain
      • User
        • Read Hold Messages for User
        • Count Hold Messages for User
        • Create a new Hold Messge for User from Upload (Multipart/Mixed Post)
        • Update Hold Messge for User from Upload (Multipart/Mixed Post)
        • Reorder Hold Messages for User
        • Delete Hold Messge for User
    • Text to Speech
      • Get Available Voices
      • Synthesize Voice (Text to Speech)
      • Synthesize Voice (Text to Speech) via GET
  • CDR (Call History)
    • CDR (Call History)
    • Read CDRs
    • Read CDRs for Domain
    • Read CDRs for Specific User
    • Count CDRs and SUM minutes
    • Count CDRs and SUM minutes for Domain
    • Count CDRs and SUM minutes for Specifc User
    • Read a single CDR by call ID
    • Update a CDR record
    • Read a domain-scoped CDR by call ID
    • Update a domain-scoped CDR
    • Read a user-scoped CDR by call ID
    • Search CDRs for Domain
    • Update a user-scoped CDR
    • Read CDRs for Site in Domain
    • CDR call/minute time-series for a domain
    • CDR call/minute time-series (reseller / system-wide)
    • Top domains / resellers by call volume
  • CDR Schedule
    • Count CDR Schedules for Domain
    • List CDR Schedules for Domain
    • Create CDR Schedule
    • Update CDR Schedule
    • Delete CDR Schedule
    • Read CDR Schedule
    • Count CDR Schedules for Reseller
    • Count CDR Schedules by Name
    • List All CDR Schedules (Super User)
    • Create CDR Schedule (System-wide)
    • Read CDR Schedule (System-wide)
    • Update CDR Schedule (System-wide)
    • Delete CDR Schedule (System-wide)
    • Read CDR Schedule by Reseller
    • Update CDR Schedule by Reseller
    • Delete CDR Schedule by Reseller
    • List CDR Schedules for Reseller
    • Create CDR Schedule for Reseller
  • Call Traces & Cradle to Grave
    • Get Call Trace Data (SIPFlow) by Id
    • Get Call Trace Data (Craddle 2 Grave) by ID
    • Get Call Trace (SIPFlow) For Call
    • Get Cradle to Grave Info For Call
    • Get CSV of call trace For Call
    • Get Cradle to Grave Info For Call
    • Get CSV of call trace For Call
  • Transcriptions & Sentiment
    • Read Transcription for Specific Call
  • Calls (live/active calls)
    • Read Active Calls In Domain
    • Read Specific Active Call In Domain
    • Count Active Calls In Domain
    • Read Active Calls for User
    • Read Specific Active Call
    • Make a new Call
    • Make a new Call to Record File
    • Disconnect Call
    • Transfer Peer Call
    • Transfer Call
    • Answer Call
    • Hold Active Call
    • Un-Hold Active Call
    • Reject Call
    • Report Active Calls
    • Active call time-series for a domain
    • Active call time-series (reseller / system-wide)
  • Contacts
    • Shared Contacts
      • Get Domain Contacts
      • Create Shared Contact
      • Get Specific Domain Contact
      • Update Shared Contact
      • Delete Shared Contact
    • Get List of Contacts Groups for User
    • Get Contacts for User
    • Create Contact
    • Get Specific Contact for User
    • Update Contact
    • Delete Contact
    • Count Contacts for User
    • Get My Contacts
  • Addresses
    • Get Addresses for Domain
    • Create Address for Domain
    • Validate Address
    • Update Address for Domain
    • Delete Address For Domain
    • Update Address for User
    • Get Address Using Address ID
    • Update Address Endpoint
    • Delete Address Endpoint
    • Create Address for User
    • Get Addresses for User
    • Delete Address For User
    • Create Address Endpoint
    • Get Address Endpoints for a Domain
    • Get Addresses Count for Domain
  • Voicemail Reminders
    • Get Voicemail Reminders for Specific User
    • Count Voicemail Reminders for Specific User
    • Delete Voicemail Reminders for Specific User
    • Create Voicemail Reminder
    • Update Voicemail Reminders for Specific User
  • Dialrule
    • Read Dialrules in a Dialplan
    • Count Dialrules in a Dialplan
    • Read Specific Dialrule in a Dialplan
    • Add a new dial rule into a dial plan
    • Update a dial rule by ID in a dial plan
    • Delete a dial rule by ID in a dial plan
    • Read Dialplans
    • Create Dialplan Global
    • Create Dialplan for Domain
    • Update Dialplan for Domain
    • Delete Dialplan for Domain
    • Count Dialplans
  • Dial Permisions
    • Read Policies
    • Count Policies
    • Read Specific Policy
    • Read Policies in Domain
    • Read Specific Policy in Domain
    • Read Permissions in a DialPolicy
    • Read Permissions in a DialPolicy in Domain
    • Read Specific Permission in a Dialpolicy
    • Read Specific Permission in a Dialpolicy in Domain
    • Create Dialpolicy Table
    • Update Dialpolicy
    • Update Dialpolicy in Domain
    • Add a new permission to a dialpolicy table
    • Add a new permission to a dialpolicy table in Domain
    • Update a permission in a dialpolicy table
    • Update a permission in a dialpolicy table in Domain
    • Delete a permission by ID in a dialpolicy
    • Delete a permission by ID in a dialpolicy in Domain
    • Delete Dialpolicy
    • Delete Dialpolicy in Domain
  • Messages
    • SMS Block
      • Read SMS Blocks for Domain
      • Read SMS Blocks for all Domains
      • Update SMS Block for Domain
      • Delete/Deactivate SMS Block for Domain
      • Add SMS Blocks for Domain
    • Get Messagesessions for Domain
    • Start a new Message Session
    • Get Messagesessions for User
    • Get Messages for Messagesession
    • Send a message (Chat)
    • Send a message (Group Chat)
    • Send a message (Media Chat)
    • Send a message (SMS)
    • Send a message (Group SMS)
    • Send a message (MMS)
    • Update Messagesession (Participants)
    • Update Messagesession (Session Name)
    • Update Messagesession (Leave)
    • Delete Messagesession
    • Add Participant to Messagesession
    • Remove Participant from Messagesession
    • Create a message session
    • Send a message (Group Chat)
    • Send a message (Media Chat)
    • Send a message (SMS)
    • Send a message (Group SMS)
    • Send a message (MMS)
    • Update Messagesession (Session Name)
  • SMS Numbers
    • Get SMS Numbers for Domain
    • Get SMS Numbers for Domain Copy
    • Create SMS Number
    • Get All SMS Numbers for System
    • Update SMS Number
    • Delete an SMS Number
    • Get SMS Numbers for User
    • Count SMS Numbers for User
  • Recordings
    • Get Specific Recording by Callid for User
    • Get Specific Recording by Callid for Domain
  • Email
    • Send Email using Template
    • Validate SMTP creds and Send Test Email
    • Send Call Center Email Report
  • Connections
    • Get a specific Domain Connection
    • Get All Connections for a Domain
    • Delete a Domain Connection
    • Update a Domain Connection
    • Create a Domain Connection
    • Create a Connection (not domain-scoped)
    • Read All Connections (not domain-scoped)
    • Get a Specific Connection (not domain-scoped)
    • Update a Specific Connection (not domain-scoped)
    • Delete a Specific Connection (not domain-scoped)
    • Count All Conections
    • List route connections
  • Routes
    • Read Routes
    • Count All Routes
    • Read Route Connections for Route
    • Count All Route Connections
    • Create a Route
    • Create a Route Connection
    • Update A Specific Route
    • Update A Specific Route Connection
    • Delete A Specific Route
    • Delete A Specific Route connection
  • Route Profiles
    • List Route Profiles for a Domain
    • Create a Domain Route Profile
    • Get a Specific Domain Route Profile
    • Update a Domain Route Profile
    • Delete a Domain Route Profile
    • List All Route Profiles
    • Get a Specific Route Profile
    • Update a Specific Route Profile
    • Delete a Specific Route Profile
  • Meetings
    • Event Logs
      • Create a Meeting Log Event
      • Read Meeting Events
    • Iotum
      • Read Iotum Video Domain Resellers
      • Read Iotum Video Host
      • Read All Iotum Video Hosts in a Domain
      • Read Iotum Video Host Conferences
      • Read Iotum Video Host Contacts
      • Read Iotum Video Company
      • Read Iotum Video Company Products
      • Read Iotum Video Available Products
      • Create a Host
      • Create Host Contacts
      • Create Iotum Video Subscription
      • Update Domain's Iotum Company
      • Update Domain's Iotum Subscriptions
      • Update User's Iotum Host
      • Delete Iotum Video Subscription
      • Delete a Host
      • Create Iotum Video Company
      • Create a Ad-hoc Conference
      • Delete a Video Company
    • Create a Meeting with Id
    • Read Meeting
    • Create a Meeting
    • Read Meetings for User
    • Count Domains Meetings
    • Count Meeting
    • Register Meeting
    • Update a Meeting
    • Delete a Meeting
    • Request a Meeting ID
  • Backup & Restore
    • Manually Backup a Domain
    • Request a Full System backup
    • Read Available Restore Points
    • Restore a Specifc Domain Backup
  • Configs
    • Configurations
      • NS Configs
      • Read a Specific Configuration
      • Read all Configurations
      • Count Configurations
      • Create a Configuration
      • Update a Configuration
      • Delete a Configuration
    • Configuration Definitions
      • Read all Configuration Definitions
      • Create a Configuration Definition
      • Read a Specific Configuration Definition
      • Update a Configuration Definition
      • Delete Configuration Definition
  • Images
    • Read Image
    • Create Image from Upload (JSON + Base64 File)
    • Delete an Image
    • Update Image from Upload (Multipart/Mixed Post)
    • Create Image from Upload (Multipart/Mixed Post)
    • Update Image from Upload (JSON + Base64 File)
    • Create Image from Upload (Multipart/Mixed Post)
    • Update Image from Upload (JSON + Base64 File)
  • Templates
    • Read Template
    • Create Template from Upload (JSON + Base64 File)
    • Delete a Template
    • Create Template from Upload (JSON + Base64 File)
    • Update Template from Upload (JSON + Base64 File)
    • Update Template from Upload (JSON + Base64 File)
  • Timeframes
    • Domain (Shared)
      • Always
        • Create Always Timeframe
      • Specific Dates
        • Create Specific Dates Timeframe
        • Create Additional Date Ranges within Specific Dates Timeframe
        • Convert Timeframe to Another Type
        • Update Date Ranges within Specific Dates Timeframe
        • Delete Specific Timeframe for Domain (Shared)
        • Create Specific Dates Timeframe
        • Replace All Date Ranges in Specific Dates Timeframe
        • Delete Date Range within Specific Dates Timeframe
        • Update Date Ranges within Specific Dates Timeframe
      • Days of Week
        • Create Days of Week Timeframe
        • Update Days of Week Timeframe
        • Create Days of Week Timeframe
        • Update Days of Week Timeframe
      • Holiday
        • Create Holidays Timeframe
        • Create Additional Holidays within Holiday Timeframe
        • Replace All Holidays in Holiday Timeframe
        • Update Holidays within Holiday Timeframe
        • Delete Holiday within Holiday Timeframe
        • Create Additional Holidays within Holiday Timeframe
        • Delete Holiday within Holiday Timeframe
        • Create Holidays Timeframe
        • Replace All Holidays in Holiday Timeframe
        • Update Holidays within Holiday Timeframe
      • Custom
        • Create Custom Timeframe
        • Create Additional Entries within Custom Timeframe
        • Replace All Entries in Custom Timeframe
        • Update Entries within Custom Timeframe
        • Delete Entry within Custom Timeframe
        • Create Additional Entries within Custom Timeframe
        • Delete Entry within Custom Timeframe
        • Create Custom Timeframe
        • Replace All Entries in Custom Timeframe
        • Update Entries within Custom Timeframe
      • Count Timeframes for Domain (all users)
      • Read All Timeframes for Domain (Shared)
      • Read Specific Timeframe for Domain (Shared)
      • Delete Specific Timeframe for Domain (Shared)
      • Convert Timeframe to Another Type
    • User
      • Always
        • Create Always Timeframe
      • Specific Dates
        • Create Specific Dates Timeframe
        • Create Additional Date Ranges within Specific Dates Timeframe
        • Convert Timeframe to Another Type
        • Update Date Ranges within Specific Dates Timeframe
        • Delete Specific Timeframe for User
        • Create Specific Dates Timeframe
        • Replace All Date Ranges in Specific Dates Timeframe
        • Delete Date Range within Specific Dates Timeframe
        • Update Date Ranges within Specific Dates Timeframe
      • Days of Week
        • Create Days of Week Timeframe
        • Update Days of Week Timeframe
        • Create Days of Week Timeframe
        • Update Days of Week Timeframe
      • Holiday
        • Create Additional Holidays within Holiday Timeframe
        • Delete Holiday within Holiday Timeframe
        • Create Holidays Timeframe
        • Update Holidays within Holiday Timeframe
        • Replace All Holidays in Holiday Timeframe
        • Create Additional Holidays within Holiday Timeframe
        • Delete Holiday within Holiday Timeframe
        • Create Holidays Timeframe
        • Update Holidays within Holiday Timeframe
        • Replace All Holidays in Holiday Timeframe
      • Custom
        • Create Additional Entries within Custom Timeframe
        • Delete Entry within Custom Timeframe
        • Create Custom Timeframe
        • Update Entries within Custom Timeframe
        • Replace All Entries in Custom Timeframe
        • Create Additional Entries within Custom Timeframe
        • Delete Entry within Custom Timeframe
        • Create Custom Timeframe
        • Update Entries within Custom Timeframe
        • Replace All Entries in Custom Timeframe
      • Read All Timeframes for User
      • Read Specific Timeframe for User
      • Delete Specific Timeframe for User
      • Convert Timeframe to Another Type
    • Holiday Information
      • Read List of Supported Countries
      • Read List of Supported Regions
      • Read Holiday Information by Country
      • Read Holiday Information by Country and Region
  • Firebase
    • Read firebase service accounts
    • Add firebase service account
  • SSL Certificates
    • Read SSL certificates for CertManager
    • Read SSL certificate by Common Name
    • Create SSL certificate for CertManager
    • Update SSL certificate for CertManager
    • Delete SSL certificate for CertManager
  • Manage Code
    • View Servers Available to manage code on
    • Read all code packages for all servers in cluster
    • Read all package details for a specific server
    • Update/Refresh repository info on Server
    • View current repos info on Server
    • Add repository version to Server
    • Remove repository version from Server
    • Install/Update a netsapiens package or packages on a specific server
    • Prefrom a dist-upgrade on a server updating all existing packages (netsapiens and not) to latest version available
    • Cleanup unused packages on a specific server
  • iNSight
    • Query Healthcheck Data from iNSight
    • Query Data from iNSight for alerts
    • Query Healthcheck Data from iNSight
  • Conference
    • Conferences
      • Get Conferences in Domain
      • Get Conference in Domain
      • Count Conferences in Domain
      • Get Conference CDR from Domain
      • Create Conference for Domain
      • Update Conference in Domain
      • Delete Conference in Domain
    • Participants
      • Get Participants from Conference
      • Create Participant for Conference
      • Update Participant for Conference
      • Delete Participant from Conference
  • Charts
    • Count Charts
    • Get Chart List
  • Dashboards
    • Count Dashboards for a User
    • Get Dashboard List for a User
  • Quotas
    • Get Quota for Domain
    • Get Quota for Domains in Reseller
    • Count Quotas for Domain
    • Count Quotas for Reseller
  • Departments
    • List Departments in a Domain
  • Presence
    • List Presence in a Domain
    • List Presence in a Department
  • Audit Log
    • Read Audit Log
  • Access Log
    • Read Accesslog
  • Avatars
    • Generic
      • Read Available Generic Avatars
      • Add Avatar for Shared Generic Use
      • Add Avatar for Shared Generic Use
      • Get Avatar Image (default 48px)
      • Get Avatar Image by Size
    • Add/Update Avatar for User
      PUT
    • Read Avatar Metadata by Filename
      GET
    • Delete Avatar for User by Filename
      DELETE
    • Read Avatar Metadata for User
      GET
    • Count Avatars for User
      GET
    • Add/Update Avatar for User's Contact
      PUT
    • Add/Update Avatar for Domains's Shared Contact
      PUT
    • Add Avatar for User
      POST
    • Add Avatar for User's Contact
      POST
    • Add Avatar for Domain's Shared Contact
      POST
    • Delete Avatar for User
      DELETE
    • Read Avatar Metadata for User's Contact
      GET
    • Delete Avatar for User's Contact
      DELETE
    • Read Avatar Metadata for Domain's Shared Contact
      GET
    • Delete Avatar for Domain's Shared Contact
      DELETE
  • Translations
    • Get Available Locales
    • Get Available Namespaces
    • Get All Translations for Locale
    • Get Translations for Locale and Namespace
    • Get All Translations (Raw Database Data)
    • Create Translation(s)
    • Update Translation(s)
    • Delete Translation(s)
    • Sync Filesystem
  • License
    • List license entries
    • List license entries for a specific host
  • Reject Log
    • List rejected SIP requests
    • List rejected SIP requests for a specific host
  • Push Notifications
    • List push configurations for system
    • List push configurations for a domain
    • List push configurations for a user
    • Register a push configuration for a user
    • Update a push configuration for a user
    • Unregister a push configuration for a user
  • App Info
    • List element domain records
  • Brands
    • Global
      • List all brands (Super User)
    • Reseller
      • List brands for a reseller (minimal fields)
      • Get all brands for a reseller (full data)
      • List brands for reseller + hostname (minimal fields)
      • Get all brands for reseller + hostname (full data)
      • Get active brand for hostname (resolved)
      • Get a specific brand (full data)
      • Create a new brand
      • Update a brand
      • Delete a brand
      • Copy a brand
    • Domain
      • List brands for a domain (minimal fields)
      • Get all brands for a domain (full data)
      • Create a new brand (domain-scoped)
      • List brands for domain + hostname (minimal fields)
      • Get all brands for domain + hostname (full data)
      • Get active brand for domain + hostname (resolved)
      • Get a specific brand (domain-scoped)
      • Update a brand (domain-scoped)
      • Delete a brand (domain-scoped)
      • Copy a brand (domain-scoped)
  • Brand Assets
    • Reseller
      • List assets for a brand
      • Upload a new brand asset
      • Get a specific asset (metadata)
      • Replace a brand asset image
      • Delete a brand asset
      • Download brand asset (binary)
    • Domain
      • List assets (domain-scoped)
      • Upload asset (domain-scoped)
      • Get asset metadata (domain-scoped)
      • Replace asset image (domain-scoped)
      • Delete asset (domain-scoped)
      • Download asset binary (domain-scoped)
  • vCon
    • Read the vCon for a parent cdr_id (domain-scoped)
    • Read the vCon for a parent cdr_id, scoped to a specific user
  • Phones
    • Macs
      • Supported Models and Servers
        • Get list of Supported/Provisionable by Vendor
        • Get details of Specific Model
  • Horizon SDK
    • UIExtensions
      • Global
        • List UI Extensions
        • Register a UI Extension
        • Get a UI Extension
        • Update a UI Extension
        • Delete a UI Extension
  • Inboxes
    • Get Inboxes in Domain
    • Get Inboxes a User is a Member of
    • Create Inbox
    • Update Inbox
    • Delete Inbox
    • Get Members in an Inbox
    • Add Member to Inbox
    • Remove Member from Inbox
    • Get Single Inbox
  • Defaults
    • List defaults
    • Create a default
    • Update a default
    • Delete a default
    • List defaultable objects
    • List the v2 fields of an object
    • List defaults for a domain
    • Create a default for a domain
    • List defaults for a reseller
    • Create a default for a reseller
  • Speech Words
    • List system speech words
    • Read a system speech word
    • Update a system speech word
    • Download a system speech word audio file
    • Re-record a system speech word via TTS
    • Replace a system speech word audio file
    • List a domain's speech words
    • Read a domain's resolved speech word
    • Create or update a domain override
    • Delete a domain override
    • Download a domain's speech word audio file
    • Re-record a domain's speech word via TTS
    • Replace a domain's speech word audio file
    • Stream a system speech word via a timed-auth link
    • Bulk re-record system speech words via TTS
    • Stream a domain's speech word via a timed-auth link
    • Bulk re-record a domain's speech words via TTS
  • User Settings
    • List a user's settings
    • Upsert a setting for a user
    • Read a single setting
    • Upsert a setting (by key in path)
    • Upsert a setting (by key in path)
    • Delete a single setting
  • Network Tests
    • List network test reports
    • Create a network test report
    • Get a single network test report
    • Delete a network test report
    • List a user's network test reports
    • Create a network test report for a user
    • Get a single network test report under a user
    • Delete a network test report under a user
    • List network test reports system-wide
    • Get a single network test report (system-wide)
    • Delete a network test report (system-wide)
  • SMS Carriers
    • List SMS carriers
    • Create a custom SMS carrier
    • Read an SMS carrier
    • Update an SMS carrier
    • Delete a custom SMS carrier
  • ipaware
    • allowed-ips
      • List allowed IPs
      • Add or update an allowed IP/CIDR
      • Remove an allowed IP/CIDR
      • Remove an allowed IP/CIDR (POST alias)
    • config
      • Read the full configuration
      • Update configuration keys
      • Read one configuration key
      • Set one configuration key
      • Remove a key override (revert to default)
    • service
      • Restart the service
      • Health check (service → Tomcat AJP chain)
    • diagnostics
      • Full runtime status
      • Prometheus metrics
      • Core fraud-scanner status
    • firewall
      • Firewall status and active blocks
      • Per-IP kernel drop counters
      • Block an IP at the packet level
      • Remove a packet-level block
  • Service Codes
    • Read a Service Code
    • Update a Service Code
    • Delete a Service Code
    • Read a Service Code for a Domain
    • Update a Service Code for a Domain
    • Delete a Service Code for a Domain
    • List Service Codes
    • Create a Service Code
    • Count Service Codes
    • List Service Codes for a Domain
    • Create a Service Code for a Domain
    • Count Service Codes for a Domain
  • Schemas
    • Schemas
      • Authentication
      • Address
    • Enums
    • securitySchemes
    • Default Folder
      • Inbox
      • InboxMember
      • AuthenticationRequired
      • BadRequest
      • RecordNotFound
      • RouteProfile
      • Vcon
      • MfaDeleteRequest
      • MfaEnrollWithTokenRequest
      • MfaEnrollRequest
      • MfaVerifyResponse
      • MfaVerifyRequest
      • GenAuthenticatorRequest
      • BrandAsset
      • Brand
      • InsightAlertResponse
      • ApplicationTokenResponse
      • ApplicationTokenRequest
      • AppinfoR
      • PushR
      • RejectlogR
      • LicenseR
      • BulkTranslationResponse
      • Error
      • TranslationRawRecord
      • HealthResponse
      • TranslationCreateResponse
      • TranslationNamespacesResponse
      • TranslationLocalesResponse
      • CdrUpdatable
      • MasqueradePopNoTargetResponse
      • MasqueradeV2EndResponse
      • MasqueradeV2Response
      • RefreshCookieResponse
      • MeResponse
      • NetsapiensJsResponse
      • RepoDetails
      • RepoRequest
      • CodeApplicationServerDetails
      • CodeApplicationServer
      • CodeApplication
      • AuthenticationRequired1
      • BadRequest1
      • RecordNotFound1
      • EmailTestResponse
      • EmailValidate
      • Avatar
      • OIDCProvider
      • SmsBlock
      • SSOEnroll
      • AbandondedCallStat
      • Phoneconfiguration
      • PhoneConfigBtn
      • QueueStat
      • Auditlog
      • InsightValue
      • Holiday
      • DeviceModelButtonType
      • DeviceModel
      • DeviceImage
      • DeviceProfile
      • DeviceProfileButton
      • Dialpolicy
      • Permission
      • DispositionReason
      • PublicUserInfo
      • RouteConnection
      • Route
      • Presence
      • Dashboard
      • Chart
      • AnswerruleFeatureSimRing
      • ConferenceCDR
      • Conference
      • ConferenceParticipant
      • Dialplan
      • NumberEnabledMap
      • Certficate
      • Start
      • Limit
      • Transcription
      • CallBlocking
      • AnswerruleFeatureWithRemove
      • IotumContact
      • IotumHost
      • RecurringTimeframeHolidayObservance
      • RecurringTimeframeType
      • TimeframeDOW
      • TimeframeHoliday
      • TimeframeSpecificDate
      • RecurringTimeframe
      • RecordingOld
      • DatetimeEnd
      • DatetimeStart
      • StringInteger
      • ConfigDefinition
      • AuthRequestMFA
      • StringDefaultStar
      • MimeTypes
      • MessageType
      • RecordingConfiguration
      • MeetingStatus
      • Template
      • Image
      • JwtRequestSuccess
      • OneZeroDefaultZero
      • OneZeroDefaultOne
      • OneZeroBoolean
      • JwtResponse
      • DeletegateRequest
      • Connection
      • ConnectionExtra
      • DeleteType
      • Timestamp
      • Configuration
      • Meeting
      • SmsNumber
      • AddressCreateReturn
      • BackupResponse
      • Restore
      • MessageSend
      • AddressEndpoint
      • AddressValidate
      • AutoAttendantFailOptions
      • AutoAttendantTierOption
      • AutoAttendantTier
      • AutoAttendant
      • Timerange
      • TtsVoice
      • AgentPath
      • CallqueuePath
      • CallActions
      • DialruleApplication
      • UserNamePath
      • DeviceLegacy
      • Agentlog
      • EmailCreate
      • YesNoStringNoDefault
      • YesNoStringYesDefault
      • UserName
      • DomainNamePath
      • Synchronous
      • Recording
      • ApiKeyAuth
      • SubscriptionModel
      • Subscription
      • DomainName
      • Scopes
      • TimeZone
      • YesNoString
      • DomainBilling
      • User
      • Domain
      • Message
      • Vmailnag
      • Messagesession
      • NdpServer
      • NdpModel
      • NdpPhone
      • CdrR
      • CdrU
      • CdrD
      • MediaRequest
      • Audiofile
      • ApiKey
      • Reseller
      • Address
      • AccessToken
      • Timeframe
      • AnswerruleFeature
      • Answerrule
      • Contact
      • Phonenumber
      • DialRule
      • Count
      • CallRequest
      • AuthRequest
      • Site
      • AnswerruleLegacy
      • Agent
      • CallQueue
      • Device
      • UserLegacy
      • DomainLegacy
    • Address
      • UserAddressCreateRequest
      • UserAddressCreateReturn
    • Authentication
      • GenAuthenticatorResponse
    • ActiveCall
    • ErrorResponse
    • DefaultR
    • SpeechWordR
    • UsersettingValue
    • NetworktestR
    • IpawareError
    • SmscarrierFields
    • ServiceCode
    • DefaultC
    • SpeechWordU
    • UsersettingR
    • NetworktestReport
    • CdrSchedule
    • IpawareValidationError
    • SmscarrierR
    • ServiceCodeCreate
    • HorizonExtension
    • DefaultU
    • SpeechWordRender
    • UsersettingC
    • CdrScheduleInput
    • IpawareAllowedIpAdd
    • SmscarrierC
    • ServiceCodeKeyedUpdate
    • SuccessResponse
    • SpeechWordUpload
    • UsersettingU
    • SpeechWordBulkRender
    • IpawareAllowedIpRemove
    • SmscarrierPortalR
    • ServiceCodeKeyedDelete
    • SpeechWordBulkResult
    • IpawareAllowedIpMutationResult
    • SmscarrierBuiltinU
    • DomainServiceCodeCreate
    • IpawareAllowEntry
    • SmscarrierCustomU
    • DomainServiceCodeKeyedUpdate
    • IpawareAllowedIpsList
    • IpawarePendingChange
    • IpawareConfigState
    • IpawareConfigKeyState
    • IpawareConfigUpdateResult
    • IpawareStatusZ
    • IpawareBlockEntry
    • IpawareFirewallState
    • IpawareFirewallBlockRequest
    • IpawareFirewallUnblockRequest
    • IpawareFirewallOpResult
    • RecordNotFound
    • BadRequest
    • AuthenticationRequired
  1. Avatars

Delete Avatar for User's Contact

DELETE
/domains/{domain}/users/{user}/contacts/{id}/avatar
Last modified:2026-07-28 22:45:01
Deletes the contact's avatar and clears the reference on the contact record. Returns 404 with No avatar set when the contact has no avatar.

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Path Params

Responses

🟢200Success
Avatar deleted.
This response does not have a body.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request DELETE 'https://awqacore01.crexendocloud.com/ns-api/v2/domains/example.com/users/1000/contacts/0bb0154bda2a1a74eda3cba83cd83b80/avatar' \
--header 'Authorization: Bearer <token>'
Modified at 2026-07-28 22:45:01
Previous
Read Avatar Metadata for User's Contact
Next
Read Avatar Metadata for Domain's Shared Contact
Built with