1. REST API for Oracle Eloqua Marketing Cloud Service
  2. Tasks
  3. Application
  4. 1.0
  5. Users

Update a user

put

/api/REST/1.0/system/user/{id}

Updates the user specified by the id parameter.

Request

Supported Media Types
Path Parameters
Body ()
The request body defines the details of the user to be updated.
Root Schema : User
Type: object
Title: User
Show Source
  • The name of the user's company/instance. This is a read-only property.
  • Read Only: true
    The date and time the user was created, expressed in Unix time. This is a read-only property.
  • Read Only: true
    The login id of the user who created the user. This is a read-only property.
  • This property is not used.
  • The user's default account view identifier. This property is only included in a response if the user being retrieved is the same user submitting the request.
  • The user's default contact view identifier. This property is only included in a response if the user being retrieved is the same user submitting the request.
  • Read Only: true
    Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
  • The description of the user. This is a read-only property.
  • The user's email address. This is a read-only property.
  • Read Only: true
    Id of the user. This is a read-only property.
  • The user's name used to login. This is a read-only property.
  • The name of the user. This is a read-only property.
  • The permissions for the user granted to your current instance. This is a read-only property.
  • UserPreferences
    Title: UserPreferences
  • The asset's type in Eloqua. This is a read-only property.
  • Read Only: true
    Unix timestamp for the date and time the user was last updated. This is a read-only property.
  • Read Only: true
    The login id of the user that last updated the user. This is a read-only property.
Nested Schema : UserPreferences
Type: object
Title: UserPreferences
Show Source
  • The ID of the user's timezone in Eloqua. This is a read-only property.
  • The asset's type in Eloqua. This is a read-only property.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : User
Type: object
Title: User
Show Source
  • The name of the user's company/instance. This is a read-only property.
  • Read Only: true
    The date and time the user was created, expressed in Unix time. This is a read-only property.
  • Read Only: true
    The login id of the user who created the user. This is a read-only property.
  • This property is not used.
  • The user's default account view identifier. This property is only included in a response if the user being retrieved is the same user submitting the request.
  • The user's default contact view identifier. This property is only included in a response if the user being retrieved is the same user submitting the request.
  • Read Only: true
    Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
  • The description of the user. This is a read-only property.
  • The user's email address. This is a read-only property.
  • Read Only: true
    Id of the user. This is a read-only property.
  • The user's name used to login. This is a read-only property.
  • The name of the user. This is a read-only property.
  • The permissions for the user granted to your current instance. This is a read-only property.
  • UserPreferences
    Title: UserPreferences
  • The asset's type in Eloqua. This is a read-only property.
  • Read Only: true
    Unix timestamp for the date and time the user was last updated. This is a read-only property.
  • Read Only: true
    The login id of the user that last updated the user. This is a read-only property.
Nested Schema : UserPreferences
Type: object
Title: UserPreferences
Show Source
  • The ID of the user's timezone in Eloqua. This is a read-only property.
  • The asset's type in Eloqua. This is a read-only property.

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
Back to Top

Examples

Update the user with Id #2 when logged in as user #2:

Note:

The defaultAccountViewId and defaultContactViewId are the only parameters that can be updated using this request. 

PUT /api/REST/1.0/system/user/2
Content-Type: application/json

Request body:


{
     "id":"2",
     "name":"API User",
     "defaultAccountViewId": "100002"    
}

Response:


{
	"type": "User",
	"id": "2",
	"createdAt": "1432136984",
	"createdBy": "1",
	"depth": "complete",
	"description": "An API User",
	"name": "API User",
	"updatedAt": "1452207032",
	"updatedBy": "9",
	"betaAccess": [...],
	"capabilities": [],
	"company": "API.Testing",
	"defaultAccountViewId": "100002",
	"defaultContactViewId": "100001",
	"emailAddress": "api.user@oracle.com",
	"interfacePermissions": [...],
	"loggedInAt": "1528818275",
	"loginName": "API.User",
	"preferences": {
		"type": "UserPreferences",
		"timezoneId": "64"
	},
	"productPermissions": [...],
	"typePermissions": [...]
}

Note:

This response displays additional properties because the user being updated is the same user performing the request. Depth will also be set to complete.
Back to Top