REST API for Oracle Eloqua Marketing Cloud Service

Update a user

put

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

Updates the user specified by the id parameter.

Request

Supported Media Types

application/json

Path Parameters

id: integer

Id of the user to update.

The request body defines the details of the user to be updated.

Root Schema : User

Type: object

Title: User

Show Source

company(optional): string

The name of the user's company/instance. This is a read-only property.
createdAt(optional): string

Read Only: true

The date and time the user was created, expressed in Unix time. This is a read-only property.
createdBy(optional): string

Read Only: true

The login id of the user who created the user. This is a read-only property.
currentStatus(optional): string

This property is not used.
defaultAccountViewId(optional): string

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.
defaultContactViewId(optional): string

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.
depth(optional): string

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.
description(optional): string

The description of the user. This is a read-only property.
emailAddress(optional): string

The user's email address. This is a read-only property.
id(optional): string

Read Only: true

Id of the user. This is a read-only property.
loginName(optional): string

The user's name used to login. This is a read-only property.
name(optional): string

The name of the user. This is a read-only property.
permissions(optional): string

The permissions for the user granted to your current instance. This is a read-only property.
preferences(optional): object UserPreferences

Title: UserPreferences
type(optional): string

The asset's type in Eloqua. This is a read-only property.
updatedAt(optional): string

Read Only: true

Unix timestamp for the date and time the user was last updated. This is a read-only property.
updatedBy(optional): string

Read Only: true

The login id of the user that last updated the user. This is a read-only property.

{
    "title":"User",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property. "
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the user. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"This property is not used."
        },
        "name":{
            "type":"string",
            "description":"The name of the user. This is a read-only property."
        },
        "description":{
            "type":"string",
            "description":"The description of the user. This is a read-only property."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the user granted to your current instance. This is a read-only property."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the user. This is a read-only property."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the user was created, expressed in Unix time. This is a read-only property."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the user. This is a read-only property."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the user was last updated. This is a read-only property."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "loginName":{
            "type":"string",
            "description":"The user's name used to login. This is a read-only property."
        },
        "company":{
            "type":"string",
            "description":"The name of the user's company/instance. This is a read-only property."
        },
        "emailAddress":{
            "type":"string",
            "description":"The user's email address. This is a read-only property."
        },
        "preferences":{
            "$ref":"#/definitions/UserPreferencesRest10",
            "description":"A list of user preferences. \"timezoneID\" is identifies the user's timezone preference."
        },
        "defaultContactViewId":{
            "type":"string",
            "description":"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."
        },
        "defaultAccountViewId":{
            "type":"string",
            "description":"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."
        }
    }
}

Nested Schema : UserPreferences

Type: object

Title: UserPreferences

Show Source

timezoneId(optional): string

The ID of the user's timezone in Eloqua. This is a read-only property.
type(optional): string

The asset's type in Eloqua. This is a read-only property.

{
    "title":"UserPreferences",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "timezoneId":{
            "type":"string",
            "description":"The ID of the user's timezone in Eloqua. This is a read-only property."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

OK.

Root Schema : User

Type: object

Title: User

Show Source

company(optional): string

The name of the user's company/instance. This is a read-only property.
createdAt(optional): string

Read Only: true

The date and time the user was created, expressed in Unix time. This is a read-only property.
createdBy(optional): string

Read Only: true

The login id of the user who created the user. This is a read-only property.
currentStatus(optional): string

This property is not used.
defaultAccountViewId(optional): string

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.
defaultContactViewId(optional): string

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.
depth(optional): string

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.
description(optional): string

The description of the user. This is a read-only property.
emailAddress(optional): string

The user's email address. This is a read-only property.
id(optional): string

Read Only: true

Id of the user. This is a read-only property.
loginName(optional): string

The user's name used to login. This is a read-only property.
name(optional): string

The name of the user. This is a read-only property.
permissions(optional): string

The permissions for the user granted to your current instance. This is a read-only property.
preferences(optional): object UserPreferences

Title: UserPreferences
type(optional): string

The asset's type in Eloqua. This is a read-only property.
updatedAt(optional): string

Read Only: true

Unix timestamp for the date and time the user was last updated. This is a read-only property.
updatedBy(optional): string

Read Only: true

The login id of the user that last updated the user. This is a read-only property.

{
    "title":"User",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property. "
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the user. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"This property is not used."
        },
        "name":{
            "type":"string",
            "description":"The name of the user. This is a read-only property."
        },
        "description":{
            "type":"string",
            "description":"The description of the user. This is a read-only property."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the user granted to your current instance. This is a read-only property."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the user. This is a read-only property."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the user was created, expressed in Unix time. This is a read-only property."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the user. This is a read-only property."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the user was last updated. This is a read-only property."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: <code>minimal</code>, <code>partial</code>, and <code>complete</code>. Any other values passed are reset to <code>complete</code> by default. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "loginName":{
            "type":"string",
            "description":"The user's name used to login. This is a read-only property."
        },
        "company":{
            "type":"string",
            "description":"The name of the user's company/instance. This is a read-only property."
        },
        "emailAddress":{
            "type":"string",
            "description":"The user's email address. This is a read-only property."
        },
        "preferences":{
            "$ref":"#/definitions/UserPreferencesRest10",
            "description":"A list of user preferences. \"timezoneID\" is identifies the user's timezone preference."
        },
        "defaultContactViewId":{
            "type":"string",
            "description":"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."
        },
        "defaultAccountViewId":{
            "type":"string",
            "description":"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."
        }
    }
}

Nested Schema : UserPreferences

Type: object

Title: UserPreferences

Show Source

timezoneId(optional): string

The ID of the user's timezone in Eloqua. This is a read-only property.
type(optional): string

The asset's type in Eloqua. This is a read-only property.

{
    "title":"UserPreferences",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "timezoneId":{
            "type":"string",
            "description":"The ID of the user's timezone 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.

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.