CAcallr
End Users

Update end user

Update an end user. You may send a partial object.

patch/end-users/{sid}

Request

  • Base URL
    https://api.callr.com/v2.0
  • URL
    https://api.callr.com/v2.0/end-users/{sid}
  • Auth
    • API key in header x-api-key
    • or HTTP basic

Path parameters

sidstring required

Short ID

Example:callrsid

Resource SID (8 lowercase alphanumeric characters)

Request body

namestring
commentstring

Example request

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

Response

The updated end user

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
}

Changes

No recorded changes to this operation across all 2 revisions of this API.