Update subscriber
Added by IBM contributorIBM | Edited by Vidyashri Hegde on November 15, 2016
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

The API caller must have one of the following roles to run the API:
  • CustomerAdministrator
  • User
  • VSR
     
Table 1. API details
Method
Resource address
Input representation
PUT
/resource/subscriber/<id>
A JavaScript™ Object Notation (JSON) entry that represents the subscriber.


URL parameters


Provide the following parameter.

Table 2. Parameters
Parameter
Required
Description
id
Yes
The ID of the subscriber to be updated. To obtain the ID, see the Get subscriber list by email address and Get subscriber list by customer ID topics.



Mutable attributes

Important: Mutable attributes that are not in the payload that you submit are deleted from the database. To avoid inadvertently deleting information, retrieve the most current subscriber profile for the subscriber that you intend to update. For more information about creating the payload, see the Creating the payload section later in this document.

Required attributes must be in the payload that you submit, even if you are not updating the values for those attributes.

For examples of valid field values, see Common attribute values.

Table 3. Mutable attributes

Attribute
Required
Description
Attribute Type
Maximum Length
FamilyName
Yes
Surname of the primary contact person.
String
128 characters
GivenName
Yes
Given name of the primary contact person.
String
128 characters
EmailAddress
Yes
Email address of the primary contact person.
String
255 characters
NamePrefix
No
Name prefix, if one exists.
String
10 characters
NameSuffix
No
Name suffix, if one exists.
String
10 characters
EmployeeNumber
No
Employee number of the person.
String
10 characters
LanguagePreference
No
Language preference of the person.
String
15 characters
WorkPhone
No
Workplace phone number.
String
30 characters
HomePhone
No
Residential phone number.
String
30 characters
MobilePhone
No
Mobile phone number.
String
30 characters
Fax
No
Fax number.
String
30 characters
JobTitle
No
Job title of the person.
String
50 characters
WebSiteAddress
No
Website address of the person, if available.
String
255 characters
TimeZone
No
Time zone information.
String
255 characters
DisplayName No Display Name of the user String 255 characters
Photo
No
Reference to the location where the photo is stored.
String
255 characters



Creating the payload

To create the payload, you must first retrieve the most current subscriber profile for the subscriber that you intend to update. To retrieve the most current subscriber profile, use the GET method Get subscriber by ID, which returns a JSON payload. Update the payload that you retrieve and use it as the new payload. You can update one or more of the mutable attributes that are described in the table Mutable attributes.

Note: Attributes that do not have values might not be in the payload that you retrieve. If the attribute that you want to modify is not in the payload that you retrieve, add the attribute and its value to the payload that you submit. Mutable attributes that are not in the payload that you submit are deleted from the database.

 

Note : Mutable attributes listed in table 3 are BSS fields which will be updated in BSS DB.

This API will update DisplayName and JobTitle fields in subscriber profiles

Sample payload



For a list of common HTTP status codes that are returned for API calls, see HTTP status codes.

Parent topic: Subscriber management services

Input
Method URI Description
PUT /api/bss/resource/subscriber/{id} Update the profile of a registered subscriber. Update details such as name, location, and contact information. The API caller must have one of the following roles to run the API:
CustomerAdministrator
User
VSR
Important: Mutable attributes that are not in the payload that you submit are deleted from the database. To avoid inadvertently deleting information, retrieve the most current subscriber profile for the subscriber that you intend to update.
Content Type: application/json
Use the table below that represents the expected fields:
Name Type Optional Description
FamilyName
string No Last name of the primary contact person.
GivenName
string No First name of the primary contact person.
EmailAdress
string No Email address of the primary contact person.
NamePrefix
string Yes Name prefix, if one exists.
NameSuffix
string Yes Name suffix, if one exists.
EmployeeNumber
string Yes Employee number of the person.
LanguagePreference
string Yes Language preference of the person. Default value is en_US
WorkPhone
string Yes Workplace phone number.
HomePhone
string Yes Residential phone number.
MobilePhone
string Yes Mobile phone number.
Fax
string Yes Fax number.
JobTitle
string Yes Job title of the person.
WebSiteAddress
string Yes Website address of the person, if available.
TimeZone
string Yes Time zone information.
Photo
string Yes Reference to the location where the photo is stored.
DisplayName
string No Display name of the user
Name Type Optional Description
id
string No The ID of the subscriber to be updated. To obtain the ID, see the "Get subscriber list by email address" and "Get subscriber list by customer ID" topics.