Skip to main content

Update Subscriber

This request updates a subscriber, targeted by secure ID.

put/subscribers/{sid}

Sample Request

This is a sample PUT request to update a subscriber by secure ID, with the values in the request body:

curl -X PUT \
'https://api.carrierx.com/conference/v1/subscribers/rB0M9.EzXfaO4keb-opANwfb7CHx1Ph1' \
-H 'Content-Type: application/json' \
--data-binary '{"role":2,"lastName":"Company"}' \
-u '[your_user_name]:[your_password]'

Sample Response

200 status code with a serialized copy of the updated Subscriber object:

{
"authenticationToken": "MWMx0BU1YZE0MV==",
"created": 1586872518000,
"didGroupReferences": [],
"externalId": -1,
"firstName": "CarrierX",
"lastName": "Company",
"login": "test_carrierx_conference_135",
"parentSid": "zzpF93QCVvfYYJb2KdPSzGW6lqGLB3qm",
"role": 2,
"sid": "rB0M9.EzXfaO4keb-opANwfb7CHx1Ph1"
}

A PUT request is used to update one or more attribute values. When using a PUT request, only the attributes specified in the request payload will be updated, all other attributes and values will remain the same. The subscriber secure ID is passed in the query URL, and the values to be modified are passed in the request body.

Path Arguments

ParameterData TypeDescription
sid
required
stringThe subscriber secure ID.

Body Arguments

JSON representation of the fields and values to be updated.

Fields that can be modified are:

  • callback
  • details
  • didGroupReferences
  • email
  • eventCallbackUrl
  • ext
  • firstName
  • lastName
  • login
  • meetingRooms
  • password
  • phoneNumber
  • role

Refer to this table to view all fields that appear in the Subscriber object.