Jump to

• Request
• Response
• Examples

Update an account

put

/api/REST/1.0/data/account/{id}

Updates the account specified by the id parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.

Request

Supported Media Types

• application/json

Path Parameters

• id: integer
  Id of the account.

Body ()

List of account fields.

Root Schema : Account

Type: object

Title: Account

Show Source

• address1(optional): string
  The account's first address.
• address2(optional): string
  The account's second address.
• address3(optional): string
  The account's third address.
• businessPhone(optional): string
  The account's business phone number.
• city(optional): string
  The account's city.
• country(optional): string
  The account's country.
• createdAt(optional): string
  Read Only: true

  The date and time the account was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login id of the user who created the account.
• crmSystemMappings(optional): array crmSystemMappings
  Lists CRM Users linked to the Account. Each crmSystemMappings contains a type, CRMUsername(s), and Eloqua loginName values for all of the Eloqua Users linked to the Account. This property is only returned if Eloqua Users are linked to the Account. For instructions on how to link Eloqua Users to Accounts, refer to the linkUsers parameter in this tutorial. This property is also only returned when the request depth is complete.
• currentStatus(optional): string
  The account's current status.
• 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 account.
• fieldValues(optional): array fieldValues
  Array containing type and id values for all of the accountFields associated with a given account.
• id(optional): string
  Read Only: true

  Id of the account. This is a read-only property.
• name(optional): string
  The name of the account.
• permissions(optional): string
  The permissions for the account granted to your current instance. This is a read-only property.
• postalCode(optional): string
  The account's postal code.
• province(optional): string
  The account's province.
• 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 account was last updated.
• updatedBy(optional): string
  Read Only: true

  The login id of the user that last updated the account.

{
    "title":"Account",
    "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 account. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The account's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the account."
        },
        "description":{
            "type":"string",
            "description":"The description of the account."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the account 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 account."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the account was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the account."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the account was last updated."
        },
        "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>."
        },
        "fieldValues":{
            "type":"array",
            "description":"Array containing <code>type</code> and <code>id</code> values for all of the accountFields associated with a given account.",
            "items":{
                "$ref":"#/definitions/FieldValueRest10"
            }
        },
        "address1":{
            "type":"string",
            "description":"The account's first address."
        },
        "address2":{
            "type":"string",
            "description":"The account's second address."
        },
        "address3":{
            "type":"string",
            "description":"The account's third address."
        },
        "city":{
            "type":"string",
            "description":"The account's city."
        },
        "province":{
            "type":"string",
            "description":"The account's province."
        },
        "postalCode":{
            "type":"string",
            "description":"The account's postal code."
        },
        "country":{
            "type":"string",
            "description":"The account's country."
        },
        "businessPhone":{
            "type":"string",
            "description":"The account's business phone number."
        },
        "crmSystemMappings":{
            "type":"array",
            "description":"Lists CRM Users linked to the Account. Each <code>crmSystemMappings</code> contains a <code>type</code>, <code>CRMUsername</code>(s), and Eloqua <code>loginName</code> values for all of the Eloqua Users linked to the Account.\r\n\r\nThis property is only returned if Eloqua Users are linked to the Account. For instructions on how to link Eloqua Users to Accounts, refer to the <code>linkUsers</code> parameter in this <a href='https://docs.oracle.com/en/cloud/saas/marketing/eloqua-develop/index.html#CSHID=ImportExportParams'>tutorial</a>.\r\n\r\nThis property is also only returned when the request depth is <code>complete</code>.",
            "items":{
                "$ref":"#/definitions/CrmSystemMappingRest10"
            }
        }
    }
}

Nested Schema : crmSystemMappings

Type: array

Lists CRM Users linked to the Account. Each crmSystemMappings contains a type, CRMUsername(s), and Eloqua loginName values for all of the Eloqua Users linked to the Account. This property is only returned if Eloqua Users are linked to the Account. For instructions on how to link Eloqua Users to Accounts, refer to the linkUsers parameter in this tutorial. This property is also only returned when the request depth is complete.

Show Source

• Array of: object CrmSystemMapping
  Title: CrmSystemMapping

{
    "type":"array",
    "description":"Lists CRM Users linked to the Account. Each <code>crmSystemMappings</code> contains a <code>type</code>, <code>CRMUsername</code>(s), and Eloqua <code>loginName</code> values for all of the Eloqua Users linked to the Account.\r\n\r\nThis property is only returned if Eloqua Users are linked to the Account. For instructions on how to link Eloqua Users to Accounts, refer to the <code>linkUsers</code> parameter in this <a href='https://docs.oracle.com/en/cloud/saas/marketing/eloqua-develop/index.html#CSHID=ImportExportParams'>tutorial</a>.\r\n\r\nThis property is also only returned when the request depth is <code>complete</code>.",
    "items":{
        "$ref":"#/definitions/CrmSystemMappingRest10"
    }
}

Nested Schema : fieldValues

Type: array

Array containing type and id values for all of the accountFields associated with a given account.

Show Source

• Array of: object FieldValue
  Title: FieldValue

{
    "type":"array",
    "description":"Array containing <code>type</code> and <code>id</code> values for all of the accountFields associated with a given account.",
    "items":{
        "$ref":"#/definitions/FieldValueRest10"
    }
}

Nested Schema : CrmSystemMapping

Type: object

Title: CrmSystemMapping

Show Source

• createdAt(optional): string
  Read Only: true
• createdBy(optional): string
  Read Only: true
• currentStatus(optional): string
• depth(optional): string
  Read Only: true
• description(optional): string
• id(optional): string
  Read Only: true
• loginName(optional): string
• MSDUserName(optional): string
• name(optional): string
• OSCUserName(optional): string
• permissions(optional): string
• SFDCUserName(optional): string
• SODUserName(optional): string
• type(optional): string
• updatedAt(optional): string
  Read Only: true
• updatedBy(optional): string
  Read Only: true

{
    "title":"CrmSystemMapping",
    "properties":{
        "type":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "readOnly":true
        },
        "currentStatus":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "permissions":{
            "type":"string"
        },
        "createdBy":{
            "type":"string",
            "readOnly":true
        },
        "createdAt":{
            "type":"string",
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true
        },
        "depth":{
            "type":"string",
            "readOnly":true
        },
        "loginName":{
            "type":"string"
        },
        "MSDUserName":{
            "type":"string"
        },
        "OSCUserName":{
            "type":"string"
        },
        "SFDCUserName":{
            "type":"string"
        },
        "SODUserName":{
            "type":"string"
        }
    }
}

Nested Schema : FieldValue

Type: object

Title: FieldValue

Show Source

• id(optional): string
  Read Only: true

  The id of the field to be set to the corresponding value.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• value(optional): string
  The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.

{
    "title":"FieldValue",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "value":{
            "type":"string",
            "description":"The value to set the corresponding field id to. Date values must be submitted as a unix timestamp."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"The id of the field to be set to the corresponding value."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : Account

Type: object

Title: Account

Show Source

• address1(optional): string
  The account's first address.
• address2(optional): string
  The account's second address.
• address3(optional): string
  The account's third address.
• businessPhone(optional): string
  The account's business phone number.
• city(optional): string
  The account's city.
• country(optional): string
  The account's country.
• createdAt(optional): string
  Read Only: true

  The date and time the account was created, expressed in Unix time.
• createdBy(optional): string
  Read Only: true

  The login id of the user who created the account.
• crmSystemMappings(optional): array crmSystemMappings
  Lists CRM Users linked to the Account. Each crmSystemMappings contains a type, CRMUsername(s), and Eloqua loginName values for all of the Eloqua Users linked to the Account. This property is only returned if Eloqua Users are linked to the Account. For instructions on how to link Eloqua Users to Accounts, refer to the linkUsers parameter in this tutorial. This property is also only returned when the request depth is complete.
• currentStatus(optional): string
  The account's current status.
• 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 account.
• fieldValues(optional): array fieldValues
  Array containing type and id values for all of the accountFields associated with a given account.
• id(optional): string
  Read Only: true

  Id of the account. This is a read-only property.
• name(optional): string
  The name of the account.
• permissions(optional): string
  The permissions for the account granted to your current instance. This is a read-only property.
• postalCode(optional): string
  The account's postal code.
• province(optional): string
  The account's province.
• 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 account was last updated.
• updatedBy(optional): string
  Read Only: true

  The login id of the user that last updated the account.

{
    "title":"Account",
    "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 account. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The account's current status."
        },
        "name":{
            "type":"string",
            "description":"The name of the account."
        },
        "description":{
            "type":"string",
            "description":"The description of the account."
        },
        "permissions":{
            "type":"string",
            "description":"The permissions for the account 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 account."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the account was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the account."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the account was last updated."
        },
        "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>."
        },
        "fieldValues":{
            "type":"array",
            "description":"Array containing <code>type</code> and <code>id</code> values for all of the accountFields associated with a given account.",
            "items":{
                "$ref":"#/definitions/FieldValueRest10"
            }
        },
        "address1":{
            "type":"string",
            "description":"The account's first address."
        },
        "address2":{
            "type":"string",
            "description":"The account's second address."
        },
        "address3":{
            "type":"string",
            "description":"The account's third address."
        },
        "city":{
            "type":"string",
            "description":"The account's city."
        },
        "province":{
            "type":"string",
            "description":"The account's province."
        },
        "postalCode":{
            "type":"string",
            "description":"The account's postal code."
        },
        "country":{
            "type":"string",
            "description":"The account's country."
        },
        "businessPhone":{
            "type":"string",
            "description":"The account's business phone number."
        },
        "crmSystemMappings":{
            "type":"array",
            "description":"Lists CRM Users linked to the Account. Each <code>crmSystemMappings</code> contains a <code>type</code>, <code>CRMUsername</code>(s), and Eloqua <code>loginName</code> values for all of the Eloqua Users linked to the Account.\r\n\r\nThis property is only returned if Eloqua Users are linked to the Account. For instructions on how to link Eloqua Users to Accounts, refer to the <code>linkUsers</code> parameter in this <a href='https://docs.oracle.com/en/cloud/saas/marketing/eloqua-develop/index.html#CSHID=ImportExportParams'>tutorial</a>.\r\n\r\nThis property is also only returned when the request depth is <code>complete</code>.",
            "items":{
                "$ref":"#/definitions/CrmSystemMappingRest10"
            }
        }
    }
}

Nested Schema : crmSystemMappings

Type: array

Lists CRM Users linked to the Account. Each crmSystemMappings contains a type, CRMUsername(s), and Eloqua loginName values for all of the Eloqua Users linked to the Account. This property is only returned if Eloqua Users are linked to the Account. For instructions on how to link Eloqua Users to Accounts, refer to the linkUsers parameter in this tutorial. This property is also only returned when the request depth is complete.

Show Source

• Array of: object CrmSystemMapping
  Title: CrmSystemMapping

{
    "type":"array",
    "description":"Lists CRM Users linked to the Account. Each <code>crmSystemMappings</code> contains a <code>type</code>, <code>CRMUsername</code>(s), and Eloqua <code>loginName</code> values for all of the Eloqua Users linked to the Account.\r\n\r\nThis property is only returned if Eloqua Users are linked to the Account. For instructions on how to link Eloqua Users to Accounts, refer to the <code>linkUsers</code> parameter in this <a href='https://docs.oracle.com/en/cloud/saas/marketing/eloqua-develop/index.html#CSHID=ImportExportParams'>tutorial</a>.\r\n\r\nThis property is also only returned when the request depth is <code>complete</code>.",
    "items":{
        "$ref":"#/definitions/CrmSystemMappingRest10"
    }
}

Nested Schema : fieldValues

Type: array

Array containing type and id values for all of the accountFields associated with a given account.

Show Source

• Array of: object FieldValue
  Title: FieldValue

{
    "type":"array",
    "description":"Array containing <code>type</code> and <code>id</code> values for all of the accountFields associated with a given account.",
    "items":{
        "$ref":"#/definitions/FieldValueRest10"
    }
}

Nested Schema : CrmSystemMapping

Type: object

Title: CrmSystemMapping

Show Source

• createdAt(optional): string
  Read Only: true
• createdBy(optional): string
  Read Only: true
• currentStatus(optional): string
• depth(optional): string
  Read Only: true
• description(optional): string
• id(optional): string
  Read Only: true
• loginName(optional): string
• MSDUserName(optional): string
• name(optional): string
• OSCUserName(optional): string
• permissions(optional): string
• SFDCUserName(optional): string
• SODUserName(optional): string
• type(optional): string
• updatedAt(optional): string
  Read Only: true
• updatedBy(optional): string
  Read Only: true

{
    "title":"CrmSystemMapping",
    "properties":{
        "type":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "readOnly":true
        },
        "currentStatus":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "permissions":{
            "type":"string"
        },
        "createdBy":{
            "type":"string",
            "readOnly":true
        },
        "createdAt":{
            "type":"string",
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true
        },
        "depth":{
            "type":"string",
            "readOnly":true
        },
        "loginName":{
            "type":"string"
        },
        "MSDUserName":{
            "type":"string"
        },
        "OSCUserName":{
            "type":"string"
        },
        "SFDCUserName":{
            "type":"string"
        },
        "SODUserName":{
            "type":"string"
        }
    }
}

Nested Schema : FieldValue

Type: object

Title: FieldValue

Show Source

• id(optional): string
  Read Only: true

  The id of the field to be set to the corresponding value.
• type(optional): string
  The asset's type in Eloqua. This is a read-only property.
• value(optional): string
  The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.

{
    "title":"FieldValue",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "value":{
            "type":"string",
            "description":"The value to set the corresponding field id to. Date values must be submitted as a unix timestamp."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"The id of the field to be set to the corresponding value."
        }
    }
}

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 account with Id #14:

PUT /api/REST/1.0/data/account/14
Content-Type: application/json 
			

Request body:

{
    "id":"14",
    "name":"Hudsucker Industries",
    "country":"Guatemala",
}
			

Response:

{
    "type":"Account",
    "id":"14",
    "initialId":"14",
    "createdAt":"1433527976",
    "depth":"complete",
    "description":"",
    "name":"Hudsucker Industries",
    "updatedAt":"1433528788",
    "address1":"",
    "address2":"",
    "address3":"",
    "businessPhone":"",
    "city":"",
    "country":"Guatemala",
    "fieldValues":[],
    "postalCode":"",
    "province":""
}
			

Back to Top