Sign in

v1

latestOpenAPI 3.1.1Proprietary2026-07-245895107.9 KB
End Users

Create end user

Create an end user.

post/end-users

Request body

namestring required
commentstring

Example request

{
  "name": "French Corp",
  "address": {
    "country": "FR",
    "city": "Paris"
  },
  "comment": "French Subsidiary"
}

Response

End user created

namestring required
commentstring
sidstring required

Short ID

type'self' | 'third-party' required

The type of end user. It can be either self (your company) or third-party. Any end user you create is considered as third-party.

createdstring date-time required

RFC 3339, section 5.6

updatedstring date-time required

RFC 3339, section 5.6

deletableboolean

Whether the end user can be deleted or not. Self end user cannot be deleted. Third party end users can be deleted if they are not associated with any phone number.

Example response

{
  "name": "French Corp",
  "address": {
    "country": "FR",
    "city": "Paris"
  },
  "comment": "French Subsidiary",
  "sid": "callrsid",
  "type": "third-party",
  "created": "2024-04-24T17:42:28Z",
  "updated": "2024-04-24T17:42:28Z",
  "deletable": true
}