Skip to main content
  • Products
    • Overview
    • Features
    • Screen Capture
    • Agent evaluation / score cards
    • Speech Analytics
    • Recording Announcement
    • Videos
    • Online demo
    • Quote
    • Download
  • Solutions
    • Businesses
    • Contact centers
    • Financial institutions
    • Healthcare
    • MiFID II compliance
    • Telecom service providers
    • Traders
  • Compatibility
    • AudioCodes
    • Avaya
    • BroadSoft
    • Cisco
    • Genband
    • IPC
    • Metaswitch
    • Oracle AcmePacket
    • SIPREC recording
    • Sonus
  • Documentation
    • User Guide
    • Administration Guide
    • Developer Guide
    • MiaRec v.3 (old) documentation
    • Resource library
    • Videos
  • Support
    • Submit a request
    • Check your existing requests
    • TeamViewer QuickSupport
  • Blog
  • Company
    • About MiaRec
    • Contact us
    • Our clients
    • Become a partner
    • News
    • Careers
    • Events
    • Testimonials

MiaRec REST API

  • MiaRec REST API
    • Introduction
      • Architecture
      • Message encoding
      • Collections
      • Error responses
      • Security and Authentication
      • REST API clients for development
    • Resources
      • Calls
        • Call object fields
        • File object fields
        • Participant object fields
        • List and search calls
          • Basic search
          • Advanced search
        • View one call
        • Delete one call
        • Retrieve file for playback
        • Pause and resume recording
      • Clients
        • Client object fields
        • List and search clients
        • View a client
        • Create a client
        • Update a client
        • Delete a client
      • Groups
        • Group object fields
        • List and search groups
        • View one group
        • Create group
        • Update group
        • Delete group
      • Roles
        • Role object fields
        • List and search roles
        • View one role
        • Create role
        • Updated role
        • Delete role
      • Tenants
        • Tenant object fields
        • List and search tenants
        • View one tenant
        • Create tenant
        • Update tenant
        • Delete tenant
      • Users
        • User object fields
        • List and search users
        • View one user
        • Create user
        • Update user
        • Delete user
        • Pause and resume recording for user
      • Encryption keys
        • List and search encryption keys
        • View encrypt key
        • Create encrypt key (generate or import)
        • Update encrypt key
        • Delete encrypt key
        • Grant access to encrypt key
        • Revoke access to encrypt key
        • List authorized users
    • Examples
      • Create tenant with roles, groups and users
    • History of changes
Home › MiaRec REST API › Resources › Clients ›
 

Create a client

Request to create new client:

POST /api/v2/clients.json

HTTP body should contain JSON formatted profile of client to create.

For example:

{
    "client": {
        “tenant_id”:         “156340bf-8b47-21e4-95a4-e03f497dbd44”,
        “name”:              “Contoso”,
        "contacts": [{
            "phone_number": "1234567890",
            "name": null
        }]
    }
}

Response contains HTTP status code as shown in the following table.

Response Description
201 Created Client has been successfully created. HTTP header Location contains URL by which the newly created object should be know.

For example:

HTTP/1.1 201 Created
Location: /api/v2/clients/e011c408-f288-11e4-9b73-e03f497dbdff.json

403 Forbidden The request cannot be completed because API user has no permission to create clients
400 Bad Request The request cannot be completed because supplied JSON object has invalid data.

When response has content type application/json, then it contains more detailed description of error in JSON format like:

{
    "error": "InvalidRecord",
    "description": "Record Validation errors",
    "details": [
        "name": "Client with such name exists already"
   ]
}

‹ View a client up Update a client ›
  • Printer-friendly version
MiaRec, Inc. © 2020. All Rights Reserved. | Terms of Use | Privacy Statement | Cancellation Policy