Jump to

• Request
• Response
• Examples

Create a contact field

post

/api/REST/1.0/assets/contact/field

Creates a contact field that matches the criteria specified by the request body.

Request

Supported Media Types

• application/json

Body ()

The request body defines the details of the contact field to be created.

Root Schema : ContactField

Type: object

Title: ContactField

Show Source

• checkedValue: string
  The checked value.
• createdAt: string
  Read Only: true

  The date and time the contact field was created, expressed in Unix time. This is a read-only property.
• createdBy: string
  Read Only: true

  The login id of the user who created the contact field. This is a read-only property.
• currentStatus: string
  The email footer's current status.
• dataType: string
  The contact field's data type. This is a read-only property.
• defaultValue: string
  The contact field's default value.
• depth: 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: string
  The description of the contact field.
• displayType: string
  The contact field's display type.
• id: string
  Read Only: true

  Id of the contact field. This is a read-only property.
• internalName: string
  The contact field's internal name.
• isPhoneValidationRequired: string
  ContactField_Field_IsPhoneValidationRequired_Description
• isReadOnly: string
  Whether or not the contact field is read only.
• isRequired: string
  Whether or not the contact field is required.
• isStandard: string
  Whether or not the contact field is standard.
• name: string
  The name of the contact field.
• optionListId: string
  The id of the associated option list.
• outputFormatId: string
  The id of the output format.
• permissions: string
  The permissions for the contact field granted to your current instance. This is a read-only property.
• showTrustedVisitorsOnly: string
  Whether or not a contact field is displayed only to trusted visitors.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• uncheckedValue: string
  The unchecked value of a checkbox custom object field.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the contact field was last updated.
• updatedBy: string
  Read Only: true

  The login id of the user that last updated the contact field.
• updateType: string
  Denotes under what circumstances the contact field is updated.

{
    "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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Success

Body ()

Root Schema : ContactField

Type: object

Title: ContactField

Show Source

• checkedValue: string
  The checked value.
• createdAt: string
  Read Only: true

  The date and time the contact field was created, expressed in Unix time. This is a read-only property.
• createdBy: string
  Read Only: true

  The login id of the user who created the contact field. This is a read-only property.
• currentStatus: string
  The email footer's current status.
• dataType: string
  The contact field's data type. This is a read-only property.
• defaultValue: string
  The contact field's default value.
• depth: 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: string
  The description of the contact field.
• displayType: string
  The contact field's display type.
• id: string
  Read Only: true

  Id of the contact field. This is a read-only property.
• internalName: string
  The contact field's internal name.
• isPhoneValidationRequired: string
  ContactField_Field_IsPhoneValidationRequired_Description
• isReadOnly: string
  Whether or not the contact field is read only.
• isRequired: string
  Whether or not the contact field is required.
• isStandard: string
  Whether or not the contact field is standard.
• name: string
  The name of the contact field.
• optionListId: string
  The id of the associated option list.
• outputFormatId: string
  The id of the output format.
• permissions: string
  The permissions for the contact field granted to your current instance. This is a read-only property.
• showTrustedVisitorsOnly: string
  Whether or not a contact field is displayed only to trusted visitors.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• uncheckedValue: string
  The unchecked value of a checkbox custom object field.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the contact field was last updated.
• updatedBy: string
  Read Only: true

  The login id of the user that last updated the contact field.
• updateType: string
  Denotes under what circumstances the contact field is updated.

{
    "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"
        }
    }
}

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

Create a new contact field:

POST /api/REST/1.0/assets/contact/field
Content-Type: application/json 
			

Request body:

{
    "name":"Shoe Size",
    "dataType":"text",
    "displayType":"text",
    "updateType":"always",
}
			

Response:

{
  "type": "ContactField",
  "id": "100213",
  "depth": "complete",
  "name": "Shoe Size",
  "dataType": "text",
  "displayType": "text",
  "internalName": "C_Shoe_Size1",
  "isReadOnly": "false",
  "isRequired": "false",
  "isStandard": "false",
  "isPopulatedInOutlookPlugin": "true",
  "showTrustedVisitorsOnly": "true",
  "updateType": "always"
}
			

Back to Top