Contact fields are the fields associated with a specific contact asset. Learn more about contact fields.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/eloqua-application-1-0-contact-fields-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: REST API for Oracle Eloqua Marketing Cloud Service Application/1.0/Contact fields API
description: The Oracle Eloqua Marketing Cloud Service REST APIs enable you to extend the functionality of the product, build Apps, and perform high volume data transfers.
version: 2026.08.07
x-summary: The Oracle Eloqua Marketing Cloud Service REST APIs enable you to extend the functionality of the product, build Apps, and perform high volume data transfers.
tags:
- name: Application/1.0/Contact fields
description: 'Contact fields are the fields associated with a specific contact asset.
<a href=''https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAA/index.html#CSHID=ContactFields''>Learn more about contact fields</a>.'
paths:
/api/rest/1.0/assets/contact/field/{id}:
get:
operationId: ReadIndividualGETRest10
parameters:
- name: id
in: path
description: Id of the contact field to be retrieved.
required: true
schema:
type: integer
- name: depth
in: query
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>.'
required: false
schema:
type: string
summary: Retrieve a contact field
description: Retrieves the contact field specified by the <code>id</code> parameter.
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ContactFieldRest10'
'400':
description: Bad request. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'401':
description: Unauthorized. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'403':
description: Forbidden. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'404':
description: The requested resource was not found. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'500':
description: The service has encountered an error. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
tags:
- Application/1.0/Contact fields
x-internal-id: api-rest-1.0-assets-contact-field-{id}-get
x-filename-id: api-rest-1.0-assets-contact-field-id-get
put:
operationId: UpdateIndividualPUTRest10
parameters:
- name: id
in: path
description: Id of the contact field to be updated.
required: true
schema:
type: integer
summary: Update a contact field
description: Updates the contact field specified by the <code>id</code> parameter. All properties should be included in PUT requests, as some properties will be considered blank if not included.
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ContactFieldRest10'
'400':
description: Bad request. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'401':
description: Unauthorized. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'403':
description: Forbidden. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'404':
description: The requested resource was not found. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'500':
description: The service has encountered an error. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
tags:
- Application/1.0/Contact fields
x-internal-id: api-rest-1.0-assets-contact-field-{id}-put
x-filename-id: api-rest-1.0-assets-contact-field-id-put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ContactFieldRest10'
description: List of contact fields.
required: true
delete:
operationId: DeleteIndividualDELETERest10
parameters:
- name: id
in: path
description: Id of the contact field to delete.
required: true
schema:
type: integer
summary: Delete a contact field
description: Deletes the contact field specified by the <code>id</code> parameter.
responses:
'204':
description: No matching contact fields were found in the search.
'400':
description: Bad request. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'401':
description: Unauthorized. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'403':
description: Forbidden. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'404':
description: The requested resource was not found. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'409':
description: The contact field you are attempting to delete has dependencies, and cannot be deleted.
'500':
description: The service has encountered an error. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
tags:
- Application/1.0/Contact fields
x-internal-id: api-rest-1.0-assets-contact-field-{id}-delete
x-filename-id: api-rest-1.0-assets-contact-field-id-delete
/api/rest/1.0/assets/contact/field:
post:
operationId: CreateIndividualPOSTRest10
summary: Create a contact field
description: Creates a contact field that matches the criteria specified by the request body.
responses:
'201':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ContactFieldRest10'
'400':
description: Bad request. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'401':
description: Unauthorized. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'403':
description: Forbidden. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'404':
description: The requested resource was not found. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'500':
description: The service has encountered an error. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
tags:
- Application/1.0/Contact fields
x-internal-id: api-rest-1.0-assets-contact-field-post
x-filename-id: api-rest-1.0-assets-contact-field-post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ContactFieldRest10'
description: The request body defines the details of the contact field to be created.
required: true
/api/rest/1.0/assets/contact/fields:
get:
operationId: SearchGETRest10
parameters:
- name: depth
in: query
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>minimal</code> by default.'
required: false
schema:
type: string
- name: count
in: query
description: Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
required: false
schema:
type: integer
- name: page
in: query
description: Specifies which page of entities to return (the count parameter defines the number of entities per page). If the page parameter is not supplied, 1 will be used by default.
required: false
schema:
type: integer
- name: search
in: query
description: Specifies the search criteria used to retrieve entities. See the <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=SearchParam'>tutorial</a> for information about using this parameter.
required: false
schema:
type: string
- name: orderBy
in: query
description: Specifies the field by which list results are ordered.
required: false
schema:
type: string
- name: lastUpdatedAt
in: query
description: Unix timestamp for the date and time the contact field was last updated.
required: false
schema:
type: integer
summary: Retrieve a list of contact fields
description: Retrieves all contact field that match the criteria specified by the request parameters.
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/QueryResultContactFieldRest10'
'204':
description: No matching contact fields were found in the search
'400':
description: Bad request. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'401':
description: Unauthorized. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'403':
description: Forbidden. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'404':
description: The requested resource was not found. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
'500':
description: The service has encountered an error. See <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=HTTPStatusCodes'>Status Codes</a> for information about other possible HTTP status codes.
tags:
- Application/1.0/Contact fields
x-internal-id: api-rest-1.0-assets-contact-fields-get
x-filename-id: api-rest-1.0-assets-contact-fields-get
components:
schemas:
QueryResultContactFieldRest10:
title: QueryResultContactField
properties:
type:
type: string
description: The asset's type in Eloqua.
elements:
type: array
description: Array of contact fields.
items:
$ref: '#/components/schemas/ContactFieldRest10'
total:
type: integer
description: The total amount of results.
pageSize:
type: integer
description: The page size.
page:
type: integer
description: The specified page.
ContactFieldRest10:
title: ContactField
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 contact field. This is a read-only property.
currentStatus:
type: string
description: The email footer's current status.
name:
type: string
description: The name of the contact field.
description:
type: string
description: The description of the contact field.
permissions:
type: string
description: The permissions for the contact field 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 contact field. This is a read-only property.
createdAt:
type: string
readOnly: true
description: The date and time the contact field 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 contact field.
updatedAt:
type: string
readOnly: true
description: Unix timestamp for the date and time the contact field 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>.'
internalName:
type: string
description: The contact field's internal name.
optionListId:
type: string
description: The id of the associated option list.
checkedValue:
type: string
description: The checked value.
uncheckedValue:
type: string
description: The unchecked value of a checkbox custom object field.
displayType:
type: string
description: The contact field's display type.
dataType:
type: string
description: The contact field's data type. This is a read-only property.
defaultValue:
type: string
description: The contact field's default value.
isReadOnly:
type: string
description: Whether or not the contact field is read only.
isRequired:
type: string
description: Whether or not the contact field is required.
isStandard:
type: string
description: Whether or not the contact field is standard.
outputFormatId:
type: string
description: The id of the output format.
updateType:
type: string
description: Denotes under what circumstances the contact field is updated.
showTrustedVisitorsOnly:
type: string
description: Whether or not a contact field is displayed only to trusted visitors.
isPhoneValidationRequired:
type: string
description: ContactField_Field_IsPhoneValidationRequired_Description