Page Comparison

Self/PUT

Updates the requestor’s information (your profile). 

Any customer can edit their own password, first name, and last name regardless of network membership, but cannot edit someone else's name or password.

The login property, whose values are email addresses, is a key and not editable. To give another customer access to that property or handle an email address change, a user with sufficient privileges need to create a new person, add it to the same network, assign them to the same role, and copy the custom user permissions (if any) from an existing user. This can be done in the Users Endpoints (2022/06)#POST API call.

Required Scope

bsn.api.self.info.update

Request Body

The Person Entity

______________________________________________________________

Response

Success

204: The specified person has been updated

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: Either the request or request body is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

412: Precondition failed (the resource/person changed since the time specified in the “If-Unmodified-Since” header value)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

{login}/Password/GET

Initiate a password reset for a person

Required Scope

None

Segment

login string 

The person's login in the form of an email address

returnURL string optional

A callback URL that the authentication server will return to the user in case of a successful password reset

______________________________________________________________

Response

Success Response Body

202: On success, this method triggers an email to your login which contains a reference to a password reset page and a return URL as a callback

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Self/Tokens/{token}/GET

Gets the status of the specified OAuth2 person access or refresh token

Segment

token string 

 A person access or refresh token

______________________________________________________________

Response

Success Response Body

200: Returns the Token Info Entity

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The specified person or access refresh token is expired, revoked, or invalid.

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Self/Tokens/{token}/DELETE

Revokes a person access or refresh token

Segment

token string

 A person access or refresh token

______________________________________________________________

Response

Success

204: The person access or refresh token has been deleted

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The specified person or access refresh token is expired, revoked, or invalid.

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Self/Networks/GET

Returns the networks associated with a person

Required Scope

bsn.api.self.networks.retrieve

Response

Success Response Body

200: Returns an array of Network Entity instances in which the current person is a member.

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Self/Networks/POST

Creates a network for the person.

Required Scope

bsn.api.self.networks.create

Request Body

The Network Entity

______________________________________________________________

Response

Success Response Body

201: Returns the new resource created and referenced by the Uri (given by the Location header field) in the response. The response includes the network entity (see Network Entity).

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: Either the request or request body is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

Self/Networks/{id:int}/GET

Get a network associated with a specified id

Required Scope

bsn.api.self.networks.retrieve

Segment

id int

The unique identifier for a network

______________________________________________________________

Response

Success Response with Body

200: Returns the Network Entity

Success Response

304: The resource was not modified since the time specified in the “If-Modified-Since” header

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Self/Networks/{networkId:int}/PATCH

Applies changes to a network associated with a specified id

Segment

networkId int

The unique identifier for a network

______________________________________________________________

Request Body

These properties are entries in an array. Every entry must have all three of these properties:

op string:  The type of operation - in this case it is always "replace"

path string: A Uri path that references the location within the target document where the update will be performed

value:  The replacement value(s) for the id or serial of the group(s). This can be an array.

______________________________________________________________

Response

Success

204: The parameters have been successfully replaced

Failure

400: Either the request or request body is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method

404: The server cannot find the requested resource (the path does not exist)

412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

Self/Networks/{name}/GET

Returns a network associated with a specified name.

Required Scope

bsn.api.self.networks.retrieve

Segment

name string

The name of a network

______________________________________________________________

Response

Success Response Body

200: Returns the Network Entity

Success Response

304: The resource was not modified since the time specified in the “If-Modified-Since” header

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Self/Networks/{networkName}/PATCH

Applies changes to a network associated with a specified id

Segment

networkName string

The name of the network

______________________________________________________________

Request Body

These properties are entries in an array. Every entry must have all three of these properties:

op string:  The type of operation - in this case it is always "replace"

path string: A Uri path that references the location within the target document where the update will be performed

value:  The replacement value(s) for the id or serial of the group(s). This can be an array.

______________________________________________________________

Response

Success

204: The parameters have been successfully replaced

Failure

400: Either the request or request body is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method

404: The server cannot find the requested resource (the path does not exist)

412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

Self/Networks/{id:int}/Settings/GET

Returns the settings associated with a specified network.

Required Scope

bsn.api.self.networks.retrieve

Segment

id int 

The unique identifier for a network

______________________________________________________________

Response

Success Response with Body

200: Returns the Network Settings Entity

Success Response

304: The resource was not modified since the time specified in the “If-Modified-Since” header

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Self/Networks/{id:int}/Settings/PUT

Update the settings associated with a specified networkspecified network

Required Scope

bsn.api.self.networks.update

Segment

id int 

The unique identifier for a network

______________________________________________________________

Request Body

The Network Settings Entity

______________________________________________________________

Response

Success

204: The specified settings have been updated on the network

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: Either the request or request body is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

Self/Networks/{name}/Settings/GET

Get the settings associated with a specified network.

Required Scope

bsn.api.self.networks.retrieve

Segment

name string 

The network name

______________________________________________________________

Response

Success Response Body

200: Returns the Network Settings Entity

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Self/Networks/{name}/Settings/PUT

Update the settings associated with a specified network

Required Scope

bsn.api.self.networks.update

Segment

name string

The network name

______________________________________________________________

Request Body

The Network Settings Entity

______________________________________________________________

Response

Success

204: The network settings have been updated

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: Either the request or request body is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

Self/Networks/{id:int}/Subscription/GET

Returns the current subscription information associated with a specified network.

Required Scope

bsn.api.self.networks.retrieve

Segment

id int 

The unique identifier for a network

______________________________________________________________

Response

Success Response with Body

200: Returns the Network Subscription Entity

Success Response

304: The resource was not modified since the time specified in the “If-Modified-Since” header

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Self/Networks/{id:int}/Subscription/PUT

Updates the current subscription information associated with a specified network. A regular user can only use this to enable a trial period of the Content Cloud (if it was not previously enabled).

Segment

id int 

The unique identifier for a network

______________________________________________________________

Request Body

The Network Subscription Entity

______________________________________________________________

Response

Success

204: The subscription information was updated

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: Either the request or request body is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

412: Precondition failed (the resource changed since the time specified in the “If-Unmodified-Since” header value)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

Self/Networks/{name}/Subscription/GET

Returns the current subscription information associated with a specified network.

Required Scope

bsn.api.self.networks.retrieve

Segment

name string

The network name

______________________________________________________________

Response

Success Response Body

200: Returns the Network Subscription Entity

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Self/Networks/{name}/Subscription/PUT

Updates the current subscription information associated with a specified network. A regular user can only use this to enable a trial period of the Content Cloud (if it was not previously enabled).

Segment

name string 

The network name

______________________________________________________________

Request Body

The Network Subscription Entity

______________________________________________________________

Response

Success

204: Updated the subscription information associated with the network

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: Either the request or request body is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

415: The server cannot accept the data representation that you sent (as specified in the "Content-Type" header)

5XX: Any 500 code is an internal server error

Self/Networks/{id:int}/Subscriptions/GET

Returns the current subscription, and all previously expired subscriptions, associated with a specified network

Segment

id int 

The network identifier

______________________________________________________________

Response

Success Response Body

200: Returns an array of Network Subscription entities 

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Self/Networks/{name}/Subscriptions/GET

Returns the current subscription, and all previously expired subscriptions, associated with a specified network

Required Scope

bsn.api.self.networks.retrieve

Segment

name string

The network name

______________________________________________________________

Response

Success Response Body

200: Returns an array of Network Subscription entities 

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Self/Users/GET

Returns all user entities that the customer is associated with over all networks where the person has a user record

Required Scope

bsn.api.self.users.retrieve

Response

Success Response Body

200: Returns an array of user entities (see User Entity) if the user is a member of multiple networks, or to a single User Entity if the user is only a member of one network, or nothing if the user is not a member of any network.

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Self/Users/{id:int}/GET

Returns information about your membership in a network

Required Scope

bsn.api.self.users.retrieve

Segment

id int 

The unique identifier for a user

______________________________________________________________

Response

Success Response with Body

200: Returns the User Entity

Success Response

304: The resource was not modified since the time specified in the “If-Modified-Since” header

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Self/Users/{id:int}/Role/GET

Returns information about the role you have in a network

Required Scope

bsn.api.self.roles.retrieve

Segment

id int 

The unique identifier for a user

______________________________________________________________

Response

Success Response with Body

200: This returns the User Entity

Success Response

204: No content (the user is not assigned to a role)

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Self/Users/{id:int}/Profile/GET

Returns the user profile settingsthe user profile settings

Required Scope

bsn.api.self.users.profile.retrieve

Segment

id int

The unique identifier for a user

______________________________________________________________

Response

Success Response Body

200: The return type is object, where property names are profile keys and the profile values are those property values

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: The request is malformed and therefore invalid

401: The access token is invalid or not specified

403: The supplied access token, though valid, doesn't provide access to this method 

404: The server cannot find the requested resource (the path does not exist)

406: The server cannot return the data representation that you requested (as specified in the "Accept" header)

5XX: Any 500 code is an internal server error

Self/Users/{id:int}/Profile/POST

Creates a new user profile property (it does not replace an existing user profile property)

Required Scope

bsn.api.self.users.profile.update

Segment

id int 

The unique identifier for a user

______________________________________________________________

Request Body

pair <string, string>

 A key value pair. There should be not more than 100 properties per user, and each property value should be not more than 64KB. 

______________________________________________________________

Response

Success Response Body

201: Returns the key value pair and a link to the GET method to retrieve it. 

Failure

300: The requested representation could not be returned because it is ambiguous (there are multiple requested representations)

400: Either the request or request body is malformed and therefore invalid