Jump to

• Request
• Response
• Examples

Get Account Settings for a User

get

/rest/api/v1.3/settings/account

Retrieves account settings for the user sending the request.

Request

There are no request parameters for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Account Settings

Type: object

Title: Account Settings

Show Source

• endpoint: string
  The endpoint URL assciated with Auth Token.
• fileSystemLocation: string
  Path to the file system location associated with the account.
• includedImages: array includedImages
  List of URLs to included images.
• name: string
  Username
• unsubscribeHandler: string
  URL to Unsubscribe Handler

{
    "title":"Account Settings",
    "type":"object",
    "properties":{
        "name":{
            "description":"Username",
            "type":"string"
        },
        "endpoint":{
            "description":"The endpoint URL assciated with Auth Token.",
            "type":"string"
        },
        "fileSystemLocation":{
            "description":"Path to the file system location associated with the account.",
            "type":"string"
        },
        "includedImages":{
            "description":"List of URLs to included images.",
            "type":"array",
            "items":{
                "type":"string",
                "description":"URL path to included image."
            }
        },
        "unsubscribeHandler":{
            "description":"URL to Unsubscribe Handler",
            "type":"string"
        }
    },
    "required":[
        "name",
        "endpoint",
        "fileSystemLocation",
        "includedImages",
        "unsubscribeHandler"
    ]
}

Nested Schema : includedImages

Type: array

List of URLs to included images.

Show Source

• Array of: string
  URL path to included image.

{
    "description":"List of URLs to included images.",
    "type":"array",
    "items":{
        "type":"string",
        "description":"URL path to included image."
    }
}

Back to Top

Examples

The following example shows how to retrieve all key account settings related to the account.

FIELDS	DESCRIPTION
Authorization	<AUTH_TOKEN>
Accept	application/json

Sample Request URL:

/rest/api/v1.3/settings/account/endpoint
	

Sample Response: Success

{
  "name": "oracle-api",
  "endpoint": "https://XXXXXX-api.responsys.net",
  "fileSystemLocation": "/usr/responsys/site/accounts/oracleapi",
  "includedImages": [
    "https://assets-rsysqa1.qa.oraclersysdev.com/static/responsysimages/content",
    "https://assets-rsysqa1.qa.oraclersysdev.com/static/responsysimages"
  ],
  "unsubscribeHandler": "https://https://XXXXXX-api.responsys.net/pub/optout"
}
	

Back to Top