Jump to

• Request
• Response

Create an SMS

post

/api/rest/2.0/assets/sms

Creates an SMS that matches the criteria specified by the request body.

Request

Supported Media Types

• application/json

Body ()

The request body defines the details of an sms to be created.

Root Schema : Sms

Type: object

Title: Sms

Show Source

• archived: string
  Whether or not the sms is archived
• content: string
  Sms Content
• createdAt: string
  Read Only: true

  The date and time the sms was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the sms
• currentStatus: string
  The sms's current status. This is a read-only property
• 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. For more information, see Request depth.
• description: string
  Description of the sms
• fieldMerges: array fieldMerges
  Field Merges associated with the sms
• folderId: string
  Read Only: true

  The folder id of the folder which contains the sms
• hyperLinks: array hyperLinks
  Hyperlinks associated with the sms
• id: string
  Read Only: true

  Id of the sms. This is a read-only property.
• initiationType: string
  Type of initiation
• keywordResponses: array keywordResponses
  Keyword responses associated with the sms
• name: string
  Name of the sms
• permissions: array permissions
  The permissions for the sms granted to your current instance. This is a read-only property.
• scheduledFor: string
  Read Only: true

  This property is not used
• senderCodes: array senderCodes
  Sender codes associated with the sms
• smsType: string
  Purpose of sms.
• sourceTemplateId: string
  Id of the template used to create the asset.
• templateId: string
  Id of the template associated with the sms
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the sms was last updated. This is a read-only property.
• updatedBy: string
  Read Only: true

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

{
    "title":"Sms",
    "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 sms. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The sms's current status. This is a read-only property"
        },
        "description":{
            "type":"string",
            "description":"Description of the sms"
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the sms granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the sms"
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the template used to create the asset."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the sms"
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the sms was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the sms."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the sms was last updated. This is a read-only property."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used"
        },
        "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>. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "name":{
            "type":"string",
            "description":"Name of the sms"
        },
        "content":{
            "type":"string",
            "description":"Sms Content"
        },
        "archived":{
            "type":"string",
            "description":"Whether or not the sms is archived"
        },
        "smsType":{
            "type":"string",
            "description":"Purpose of sms."
        },
        "initiationType":{
            "type":"string",
            "description":"Type of initiation"
        },
        "templateId":{
            "type":"string",
            "description":"Id of the template associated with the sms"
        },
        "senderCodes":{
            "type":"array",
            "description":"Sender codes associated with the sms",
            "items":{
                "$ref":"#/definitions/SmsSenderCodeRest20"
            }
        },
        "fieldMerges":{
            "type":"array",
            "description":"Field Merges associated with the sms",
            "items":{
                "$ref":"#/definitions/FieldMergeRest20"
            }
        },
        "hyperLinks":{
            "type":"array",
            "description":"Hyperlinks associated with the sms",
            "items":{
                "$ref":"#/definitions/SmsLinkRest20"
            }
        },
        "keywordResponses":{
            "type":"array",
            "description":"Keyword responses associated with the sms",
            "items":{
                "$ref":"#/definitions/KeywordResponseRest20"
            }
        }
    }
}

Nested Schema : fieldMerges

Type: array

Field Merges associated with the sms

Show Source

• Array of: object FieldMerge
  Title: FieldMerge

{
    "type":"array",
    "description":"Field Merges associated with the sms",
    "items":{
        "$ref":"#/definitions/FieldMergeRest20"
    }
}

Nested Schema : hyperLinks

Type: array

Hyperlinks associated with the sms

Show Source

• Array of: object SmsLink
  Title: SmsLink

{
    "type":"array",
    "description":"Hyperlinks associated with the sms",
    "items":{
        "$ref":"#/definitions/SmsLinkRest20"
    }
}

Nested Schema : keywordResponses

Type: array

Keyword responses associated with the sms

Show Source

• Array of: object KeywordResponse
  Title: KeywordResponse

{
    "type":"array",
    "description":"Keyword responses associated with the sms",
    "items":{
        "$ref":"#/definitions/KeywordResponseRest20"
    }
}

Nested Schema : permissions

Type: array

The permissions for the sms granted to your current instance. This is a read-only property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the sms granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

Nested Schema : senderCodes

Type: array

Sender codes associated with the sms

Show Source

• Array of: object SmsSenderCode
  Title: SmsSenderCode

{
    "type":"array",
    "description":"Sender codes associated with the sms",
    "items":{
        "$ref":"#/definitions/SmsSenderCodeRest20"
    }
}

Nested Schema : FieldMerge

Type: object

Title: FieldMerge

Show Source

• accountFieldId: string
  Id of the associated account field.
• allowUrlsInValue: string
  Whether or not URLs are allowed in this field merge. False by default. Using URLs in a field merge can be a security risk. By default, when Oracle Eloqua attempts to insert the field merge, it removes any URLs while still inserting the remaining data. However, you can override this security feature by selecting the Allow URLs in field merge check box in the Eloqua user interface.
• contactFieldId: string
  Id of the associated contact field.
• createdAt: string
  Read Only: true

  The date and time the field merge was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the field merge.
• currentStatus: string
  The field merge's current status.
• customObjectFieldId: string
  Id of the associated custom object field.
• customObjectId: string
  Id of the associated custom object.
• customObjectSort: string
  The associated custom object sort type.
• defaultValue: string
  The default value of the field merge.
• 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 field merge.
• eventFieldId: string
  Id of the associated event field.
• eventId: string
  Id of the associated event.
• eventSessionFieldId: string
  Id of the associated event session field.
• fieldConditions: array fieldConditions
  Array of field condition fields.
• folderId: string
  Read Only: true

  Id of the associated folder.
• id: string
  Read Only: true

  Id of the field merge. This is a read-only property.
• mergeType: string
  Type of the field merge. Possible values include: contactField, accountField, eventField, eventSessionField, and customObjectField.
• name: string
  Name of the field merge.
• permissions: array permissions
  The permissions for the field merge granted to your current instance.
• queryStringKey: string
  The key value if the field merge contains a query string. See the Help Center to learn more about field merges with query strings. This is a read-only property.
• scheduledFor: string
  Read Only: true

  This property is not used for field merges.
• sourceTemplateId: string
  The id of the source template.
• syntax: string
  The syntax of the field merge.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

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

  The login id of the user that last updated the field merge.

{
    "title":"FieldMerge",
    "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 field merge. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The field merge's current status."
        },
        "name":{
            "type":"string",
            "description":"Name of the field merge."
        },
        "description":{
            "type":"string",
            "description":"The description of the field merge."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the field merge granted to your current instance.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the associated folder."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"The id of the source template."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the field merge."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the field merge was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the field merge."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the field merge was last updated."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for field merges."
        },
        "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>."
        },
        "syntax":{
            "type":"string",
            "description":"The syntax of the field merge."
        },
        "defaultValue":{
            "type":"string",
            "description":"The default value of the field merge."
        },
        "contactFieldId":{
            "type":"string",
            "description":"Id of the associated contact field."
        },
        "accountFieldId":{
            "type":"string",
            "description":"Id of the associated account field."
        },
        "eventId":{
            "type":"string",
            "description":"Id of the associated event."
        },
        "eventFieldId":{
            "type":"string",
            "description":"Id of the associated event field."
        },
        "eventSessionFieldId":{
            "type":"string",
            "description":"Id of the associated event session field."
        },
        "customObjectId":{
            "type":"string",
            "description":"Id of the associated custom object."
        },
        "customObjectFieldId":{
            "type":"string",
            "description":"Id of the associated custom object field."
        },
        "mergeType":{
            "type":"string",
            "description":"Type of the field merge. Possible values include: <code>contactField</code>, <code>accountField</code>, <code>eventField</code>, <code>eventSessionField</code>, and <code>customObjectField</code>."
        },
        "customObjectSort":{
            "type":"string",
            "description":"The associated custom object sort type."
        },
        "queryStringKey":{
            "type":"string",
            "description":"The key value if the field merge contains a query string. See the <a href='https://docs.oracle.com/en/cloud/saas/marketing/eloqua-user/Help/FieldMerges/Tasks/CreatingFieldMergeWithQueryString.htm'>Help Center</a> to learn more about field merges with query strings. This is a read-only property. "
        },
        "fieldConditions":{
            "type":"array",
            "description":"Array of field condition fields.",
            "items":{
                "$ref":"#/definitions/FieldConditionRest20"
            }
        },
        "allowUrlsInValue":{
            "type":"string",
            "description":"Whether or not URLs are allowed in this field merge. False by default. Using URLs in a field merge can be a security risk. By default, when Oracle Eloqua attempts to insert the field merge, it removes any URLs while still inserting the remaining data. However, you can override this security feature by selecting the Allow URLs in field merge check box in the Eloqua user interface."
        }
    }
}

Nested Schema : fieldConditions

Type: array

Array of field condition fields.

Show Source

• Array of: object FieldCondition
  Title: FieldCondition

{
    "type":"array",
    "description":"Array of field condition fields.",
    "items":{
        "$ref":"#/definitions/FieldConditionRest20"
    }
}

Nested Schema : permissions

Type: array

The permissions for the field merge granted to your current instance.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the field merge granted to your current instance.",
    "items":{
        "type":"string"
    }
}

Nested Schema : FieldCondition

Type: object

Title: FieldCondition

Show Source

• condition: object Condition
  Title: Condition
• createdAt: string
  Read Only: true
• createdBy: string
  Read Only: true
• currentStatus: string
• depth: string
  Read Only: true
• description: string
• fieldId: string
• folderId: string
  Read Only: true
• id: string
  Read Only: true
• name: string
• permissions: array permissions
• scheduledFor: string
  Read Only: true
• sourceTemplateId: string
• type: string
• updatedAt: string
  Read Only: true
• updatedBy: string
  Read Only: true

{
    "title":"FieldCondition",
    "properties":{
        "type":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "readOnly":true
        },
        "currentStatus":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "permissions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true
        },
        "sourceTemplateId":{
            "type":"string"
        },
        "createdBy":{
            "type":"string",
            "readOnly":true
        },
        "createdAt":{
            "type":"string",
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true
        },
        "depth":{
            "type":"string",
            "readOnly":true
        },
        "condition":{
            "$ref":"#/definitions/ConditionRest20"
        },
        "fieldId":{
            "type":"string"
        }
    }
}

Nested Schema : Condition

Type: object

Title: Condition

Show Source

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

{
    "title":"Condition",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        }
    }
}

Nested Schema : permissions

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : SmsLink

Type: object

Title: SmsLink

Show Source

• createdAt: string
  Read Only: true

  The date and time the sms link was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the sms link.
• currentStatus: string
  The sms link current status. This is a read-only property.
• 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. For more information, see Request depth.
• description: string
  Description of the sms link.
• folderId: string
  Read Only: true

  The folder id of the folder which contains the sms link.
• href: string
  Url represented by sms link.
• hyperlinkType: string
  Type of hyperlink represented by sms link.
• id: string
  Read Only: true

  Id of the sms link. This is a read-only property.
• name: string
  Name of the sms link.
• permissions: array permissions
  The permissions for the sms link granted to your current instance. This is a read-only property.
• scheduledFor: string
  Read Only: true

  This property is not used
• sourceTemplateId: string
  Id of the template used to create the asset.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the sms link was last updated. This is a read-only property.
• updatedBy: string
  Read Only: true

  The login id of the user that last updated the sms link.

{
    "title":"SmsLink",
    "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 sms link. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The sms link current status. This is a read-only property."
        },
        "name":{
            "type":"string",
            "description":"Name of the sms link."
        },
        "description":{
            "type":"string",
            "description":"Description of the sms link."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the sms link granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the sms link."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the template used to create the asset."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the sms link."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the sms link was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the sms link."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the sms link was last updated. This is a read-only property."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used"
        },
        "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>. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "href":{
            "type":"string",
            "description":"Url represented by sms link."
        },
        "hyperlinkType":{
            "type":"string",
            "description":"Type of hyperlink represented by sms link."
        }
    }
}

Nested Schema : permissions

Type: array

The permissions for the sms link granted to your current instance. This is a read-only property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the sms link granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

Nested Schema : KeywordResponse

Type: object

Title: KeywordResponse

Show Source

• createdAt: string
  Read Only: true

  The date and time the keyword response was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the keyword response.
• currentStatus: string
  The keyword response current status. This is a read-only property
• 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. For more information, see Request depth.
• description: string
  Description of the keyword response.
• folderId: string
  Read Only: true

  The folder id of the folder which contains the keyword response.
• id: string
  Read Only: true

  Id of the keyword response. This is a read-only property.
• keyword: string
  Keyword associated with keyword response.
• keywordType: string
  The type of the keyword.
• permissions: array permissions
  The permissions for the keyword response granted to your current instance. This is a read-only property.
• response: string
  Response associated with the keyword.
• scheduledFor: string
  Read Only: true

  This property is not used
• sourceTemplateId: string
  Id of the template used to create the asset.
• templateId: string
  Id of the template associated with the keyword response.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the keyword response was last updated. This is a read-only property.
• updatedBy: string
  Read Only: true

  The login id of the user that last updated the keyword response.

{
    "title":"KeywordResponse",
    "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 keyword response. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The keyword response current status. This is a read-only property"
        },
        "description":{
            "type":"string",
            "description":"Description of the keyword response."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the keyword response granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the keyword response."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the template used to create the asset."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the keyword response."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the keyword response was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the keyword response."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the keyword response was last updated. This is a read-only property."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used"
        },
        "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>. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "keyword":{
            "type":"string",
            "description":"Keyword associated with keyword response."
        },
        "response":{
            "type":"string",
            "description":"Response associated with the keyword."
        },
        "templateId":{
            "type":"string",
            "description":"Id of the template associated with the keyword response."
        },
        "keywordType":{
            "type":"string",
            "description":"The type of the keyword."
        }
    }
}

Nested Schema : permissions

Type: array

The permissions for the keyword response granted to your current instance. This is a read-only property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the keyword response granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

Nested Schema : SmsSenderCode

Type: object

Title: SmsSenderCode

Show Source

• countryCode: string
  Associated country code.
• createdAt: string
  Read Only: true

  The date and time the sms sender code was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the sms sender code.
• currentStatus: string
  The sms sender code current status. This is a read-only property.
• 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. For more information, see Request depth.
• description: string
  Description of the sms sender code.
• folderId: string
  Read Only: true

  The folder id of the folder which contains the sms sender code.
• id: string
  Read Only: true

  Id of the sms sender code. This is a read-only property.
• name: string
  Name of the sms sender code.
• permissions: array permissions
  The permissions for the sms sender code granted to your current instance. This is a read-only property.
• scheduledFor: string
  Read Only: true

  This property is not used
• senderCode: string
  Associated sender code.
• senderCodeId: string
  Id of the associated sender code.
• sourceTemplateId: string
  Id of the template used to create the asset.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the sms sender code was last updated. This is a read-only property.
• updatedBy: string
  Read Only: true

  The login id of the user that last updated the sms sender code.

{
    "title":"SmsSenderCode",
    "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 sms sender code. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The sms sender code current status. This is a read-only property."
        },
        "name":{
            "type":"string",
            "description":"Name of the sms sender code."
        },
        "description":{
            "type":"string",
            "description":"Description of the sms sender code."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the sms sender code granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the sms sender code."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the template used to create the asset."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the sms sender code."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the sms sender code was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the sms sender code."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the sms sender code was last updated. This is a read-only property."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used"
        },
        "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>. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "senderCodeId":{
            "type":"string",
            "description":"Id of the associated sender code."
        },
        "countryCode":{
            "type":"string",
            "description":"Associated country code."
        },
        "senderCode":{
            "type":"string",
            "description":"Associated sender code."
        }
    }
}

Nested Schema : permissions

Type: array

The permissions for the sms sender code granted to your current instance. This is a read-only property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the sms sender code granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Success.

Body ()

Root Schema : Sms

Type: object

Title: Sms

Show Source

• archived: string
  Whether or not the sms is archived
• content: string
  Sms Content
• createdAt: string
  Read Only: true

  The date and time the sms was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the sms
• currentStatus: string
  The sms's current status. This is a read-only property
• 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. For more information, see Request depth.
• description: string
  Description of the sms
• fieldMerges: array fieldMerges
  Field Merges associated with the sms
• folderId: string
  Read Only: true

  The folder id of the folder which contains the sms
• hyperLinks: array hyperLinks
  Hyperlinks associated with the sms
• id: string
  Read Only: true

  Id of the sms. This is a read-only property.
• initiationType: string
  Type of initiation
• keywordResponses: array keywordResponses
  Keyword responses associated with the sms
• name: string
  Name of the sms
• permissions: array permissions
  The permissions for the sms granted to your current instance. This is a read-only property.
• scheduledFor: string
  Read Only: true

  This property is not used
• senderCodes: array senderCodes
  Sender codes associated with the sms
• smsType: string
  Purpose of sms.
• sourceTemplateId: string
  Id of the template used to create the asset.
• templateId: string
  Id of the template associated with the sms
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the sms was last updated. This is a read-only property.
• updatedBy: string
  Read Only: true

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

{
    "title":"Sms",
    "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 sms. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The sms's current status. This is a read-only property"
        },
        "description":{
            "type":"string",
            "description":"Description of the sms"
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the sms granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the sms"
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the template used to create the asset."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the sms"
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the sms was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the sms."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the sms was last updated. This is a read-only property."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used"
        },
        "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>. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "name":{
            "type":"string",
            "description":"Name of the sms"
        },
        "content":{
            "type":"string",
            "description":"Sms Content"
        },
        "archived":{
            "type":"string",
            "description":"Whether or not the sms is archived"
        },
        "smsType":{
            "type":"string",
            "description":"Purpose of sms."
        },
        "initiationType":{
            "type":"string",
            "description":"Type of initiation"
        },
        "templateId":{
            "type":"string",
            "description":"Id of the template associated with the sms"
        },
        "senderCodes":{
            "type":"array",
            "description":"Sender codes associated with the sms",
            "items":{
                "$ref":"#/definitions/SmsSenderCodeRest20"
            }
        },
        "fieldMerges":{
            "type":"array",
            "description":"Field Merges associated with the sms",
            "items":{
                "$ref":"#/definitions/FieldMergeRest20"
            }
        },
        "hyperLinks":{
            "type":"array",
            "description":"Hyperlinks associated with the sms",
            "items":{
                "$ref":"#/definitions/SmsLinkRest20"
            }
        },
        "keywordResponses":{
            "type":"array",
            "description":"Keyword responses associated with the sms",
            "items":{
                "$ref":"#/definitions/KeywordResponseRest20"
            }
        }
    }
}

Nested Schema : fieldMerges

Type: array

Field Merges associated with the sms

Show Source

• Array of: object FieldMerge
  Title: FieldMerge

{
    "type":"array",
    "description":"Field Merges associated with the sms",
    "items":{
        "$ref":"#/definitions/FieldMergeRest20"
    }
}

Nested Schema : hyperLinks

Type: array

Hyperlinks associated with the sms

Show Source

• Array of: object SmsLink
  Title: SmsLink

{
    "type":"array",
    "description":"Hyperlinks associated with the sms",
    "items":{
        "$ref":"#/definitions/SmsLinkRest20"
    }
}

Nested Schema : keywordResponses

Type: array

Keyword responses associated with the sms

Show Source

• Array of: object KeywordResponse
  Title: KeywordResponse

{
    "type":"array",
    "description":"Keyword responses associated with the sms",
    "items":{
        "$ref":"#/definitions/KeywordResponseRest20"
    }
}

Nested Schema : permissions

Type: array

The permissions for the sms granted to your current instance. This is a read-only property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the sms granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

Nested Schema : senderCodes

Type: array

Sender codes associated with the sms

Show Source

• Array of: object SmsSenderCode
  Title: SmsSenderCode

{
    "type":"array",
    "description":"Sender codes associated with the sms",
    "items":{
        "$ref":"#/definitions/SmsSenderCodeRest20"
    }
}

Nested Schema : FieldMerge

Type: object

Title: FieldMerge

Show Source

• accountFieldId: string
  Id of the associated account field.
• allowUrlsInValue: string
  Whether or not URLs are allowed in this field merge. False by default. Using URLs in a field merge can be a security risk. By default, when Oracle Eloqua attempts to insert the field merge, it removes any URLs while still inserting the remaining data. However, you can override this security feature by selecting the Allow URLs in field merge check box in the Eloqua user interface.
• contactFieldId: string
  Id of the associated contact field.
• createdAt: string
  Read Only: true

  The date and time the field merge was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the field merge.
• currentStatus: string
  The field merge's current status.
• customObjectFieldId: string
  Id of the associated custom object field.
• customObjectId: string
  Id of the associated custom object.
• customObjectSort: string
  The associated custom object sort type.
• defaultValue: string
  The default value of the field merge.
• 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 field merge.
• eventFieldId: string
  Id of the associated event field.
• eventId: string
  Id of the associated event.
• eventSessionFieldId: string
  Id of the associated event session field.
• fieldConditions: array fieldConditions
  Array of field condition fields.
• folderId: string
  Read Only: true

  Id of the associated folder.
• id: string
  Read Only: true

  Id of the field merge. This is a read-only property.
• mergeType: string
  Type of the field merge. Possible values include: contactField, accountField, eventField, eventSessionField, and customObjectField.
• name: string
  Name of the field merge.
• permissions: array permissions
  The permissions for the field merge granted to your current instance.
• queryStringKey: string
  The key value if the field merge contains a query string. See the Help Center to learn more about field merges with query strings. This is a read-only property.
• scheduledFor: string
  Read Only: true

  This property is not used for field merges.
• sourceTemplateId: string
  The id of the source template.
• syntax: string
  The syntax of the field merge.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

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

  The login id of the user that last updated the field merge.

{
    "title":"FieldMerge",
    "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 field merge. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The field merge's current status."
        },
        "name":{
            "type":"string",
            "description":"Name of the field merge."
        },
        "description":{
            "type":"string",
            "description":"The description of the field merge."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the field merge granted to your current instance.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the associated folder."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"The id of the source template."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the field merge."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the field merge was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the field merge."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the field merge was last updated."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for field merges."
        },
        "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>."
        },
        "syntax":{
            "type":"string",
            "description":"The syntax of the field merge."
        },
        "defaultValue":{
            "type":"string",
            "description":"The default value of the field merge."
        },
        "contactFieldId":{
            "type":"string",
            "description":"Id of the associated contact field."
        },
        "accountFieldId":{
            "type":"string",
            "description":"Id of the associated account field."
        },
        "eventId":{
            "type":"string",
            "description":"Id of the associated event."
        },
        "eventFieldId":{
            "type":"string",
            "description":"Id of the associated event field."
        },
        "eventSessionFieldId":{
            "type":"string",
            "description":"Id of the associated event session field."
        },
        "customObjectId":{
            "type":"string",
            "description":"Id of the associated custom object."
        },
        "customObjectFieldId":{
            "type":"string",
            "description":"Id of the associated custom object field."
        },
        "mergeType":{
            "type":"string",
            "description":"Type of the field merge. Possible values include: <code>contactField</code>, <code>accountField</code>, <code>eventField</code>, <code>eventSessionField</code>, and <code>customObjectField</code>."
        },
        "customObjectSort":{
            "type":"string",
            "description":"The associated custom object sort type."
        },
        "queryStringKey":{
            "type":"string",
            "description":"The key value if the field merge contains a query string. See the <a href='https://docs.oracle.com/en/cloud/saas/marketing/eloqua-user/Help/FieldMerges/Tasks/CreatingFieldMergeWithQueryString.htm'>Help Center</a> to learn more about field merges with query strings. This is a read-only property. "
        },
        "fieldConditions":{
            "type":"array",
            "description":"Array of field condition fields.",
            "items":{
                "$ref":"#/definitions/FieldConditionRest20"
            }
        },
        "allowUrlsInValue":{
            "type":"string",
            "description":"Whether or not URLs are allowed in this field merge. False by default. Using URLs in a field merge can be a security risk. By default, when Oracle Eloqua attempts to insert the field merge, it removes any URLs while still inserting the remaining data. However, you can override this security feature by selecting the Allow URLs in field merge check box in the Eloqua user interface."
        }
    }
}

Nested Schema : fieldConditions

Type: array

Array of field condition fields.

Show Source

• Array of: object FieldCondition
  Title: FieldCondition

{
    "type":"array",
    "description":"Array of field condition fields.",
    "items":{
        "$ref":"#/definitions/FieldConditionRest20"
    }
}

Nested Schema : permissions

Type: array

The permissions for the field merge granted to your current instance.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the field merge granted to your current instance.",
    "items":{
        "type":"string"
    }
}

Nested Schema : FieldCondition

Type: object

Title: FieldCondition

Show Source

• condition: object Condition
  Title: Condition
• createdAt: string
  Read Only: true
• createdBy: string
  Read Only: true
• currentStatus: string
• depth: string
  Read Only: true
• description: string
• fieldId: string
• folderId: string
  Read Only: true
• id: string
  Read Only: true
• name: string
• permissions: array permissions
• scheduledFor: string
  Read Only: true
• sourceTemplateId: string
• type: string
• updatedAt: string
  Read Only: true
• updatedBy: string
  Read Only: true

{
    "title":"FieldCondition",
    "properties":{
        "type":{
            "type":"string"
        },
        "id":{
            "type":"string",
            "readOnly":true
        },
        "currentStatus":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "permissions":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true
        },
        "sourceTemplateId":{
            "type":"string"
        },
        "createdBy":{
            "type":"string",
            "readOnly":true
        },
        "createdAt":{
            "type":"string",
            "readOnly":true
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true
        },
        "depth":{
            "type":"string",
            "readOnly":true
        },
        "condition":{
            "$ref":"#/definitions/ConditionRest20"
        },
        "fieldId":{
            "type":"string"
        }
    }
}

Nested Schema : Condition

Type: object

Title: Condition

Show Source

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

{
    "title":"Condition",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        }
    }
}

Nested Schema : permissions

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : SmsLink

Type: object

Title: SmsLink

Show Source

• createdAt: string
  Read Only: true

  The date and time the sms link was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the sms link.
• currentStatus: string
  The sms link current status. This is a read-only property.
• 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. For more information, see Request depth.
• description: string
  Description of the sms link.
• folderId: string
  Read Only: true

  The folder id of the folder which contains the sms link.
• href: string
  Url represented by sms link.
• hyperlinkType: string
  Type of hyperlink represented by sms link.
• id: string
  Read Only: true

  Id of the sms link. This is a read-only property.
• name: string
  Name of the sms link.
• permissions: array permissions
  The permissions for the sms link granted to your current instance. This is a read-only property.
• scheduledFor: string
  Read Only: true

  This property is not used
• sourceTemplateId: string
  Id of the template used to create the asset.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the sms link was last updated. This is a read-only property.
• updatedBy: string
  Read Only: true

  The login id of the user that last updated the sms link.

{
    "title":"SmsLink",
    "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 sms link. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The sms link current status. This is a read-only property."
        },
        "name":{
            "type":"string",
            "description":"Name of the sms link."
        },
        "description":{
            "type":"string",
            "description":"Description of the sms link."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the sms link granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the sms link."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the template used to create the asset."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the sms link."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the sms link was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the sms link."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the sms link was last updated. This is a read-only property."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used"
        },
        "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>. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "href":{
            "type":"string",
            "description":"Url represented by sms link."
        },
        "hyperlinkType":{
            "type":"string",
            "description":"Type of hyperlink represented by sms link."
        }
    }
}

Nested Schema : permissions

Type: array

The permissions for the sms link granted to your current instance. This is a read-only property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the sms link granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

Nested Schema : KeywordResponse

Type: object

Title: KeywordResponse

Show Source

• createdAt: string
  Read Only: true

  The date and time the keyword response was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the keyword response.
• currentStatus: string
  The keyword response current status. This is a read-only property
• 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. For more information, see Request depth.
• description: string
  Description of the keyword response.
• folderId: string
  Read Only: true

  The folder id of the folder which contains the keyword response.
• id: string
  Read Only: true

  Id of the keyword response. This is a read-only property.
• keyword: string
  Keyword associated with keyword response.
• keywordType: string
  The type of the keyword.
• permissions: array permissions
  The permissions for the keyword response granted to your current instance. This is a read-only property.
• response: string
  Response associated with the keyword.
• scheduledFor: string
  Read Only: true

  This property is not used
• sourceTemplateId: string
  Id of the template used to create the asset.
• templateId: string
  Id of the template associated with the keyword response.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the keyword response was last updated. This is a read-only property.
• updatedBy: string
  Read Only: true

  The login id of the user that last updated the keyword response.

{
    "title":"KeywordResponse",
    "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 keyword response. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The keyword response current status. This is a read-only property"
        },
        "description":{
            "type":"string",
            "description":"Description of the keyword response."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the keyword response granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the keyword response."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the template used to create the asset."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the keyword response."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the keyword response was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the keyword response."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the keyword response was last updated. This is a read-only property."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used"
        },
        "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>. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "keyword":{
            "type":"string",
            "description":"Keyword associated with keyword response."
        },
        "response":{
            "type":"string",
            "description":"Response associated with the keyword."
        },
        "templateId":{
            "type":"string",
            "description":"Id of the template associated with the keyword response."
        },
        "keywordType":{
            "type":"string",
            "description":"The type of the keyword."
        }
    }
}

Nested Schema : permissions

Type: array

The permissions for the keyword response granted to your current instance. This is a read-only property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the keyword response granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

Nested Schema : SmsSenderCode

Type: object

Title: SmsSenderCode

Show Source

• countryCode: string
  Associated country code.
• createdAt: string
  Read Only: true

  The date and time the sms sender code was created, expressed in Unix time.
• createdBy: string
  Read Only: true

  The login id of the user who created the sms sender code.
• currentStatus: string
  The sms sender code current status. This is a read-only property.
• 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. For more information, see Request depth.
• description: string
  Description of the sms sender code.
• folderId: string
  Read Only: true

  The folder id of the folder which contains the sms sender code.
• id: string
  Read Only: true

  Id of the sms sender code. This is a read-only property.
• name: string
  Name of the sms sender code.
• permissions: array permissions
  The permissions for the sms sender code granted to your current instance. This is a read-only property.
• scheduledFor: string
  Read Only: true

  This property is not used
• senderCode: string
  Associated sender code.
• senderCodeId: string
  Id of the associated sender code.
• sourceTemplateId: string
  Id of the template used to create the asset.
• type: string
  The asset's type in Eloqua. This is a read-only property.
• updatedAt: string
  Read Only: true

  Unix timestamp for the date and time the sms sender code was last updated. This is a read-only property.
• updatedBy: string
  Read Only: true

  The login id of the user that last updated the sms sender code.

{
    "title":"SmsSenderCode",
    "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 sms sender code. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"The sms sender code current status. This is a read-only property."
        },
        "name":{
            "type":"string",
            "description":"Name of the sms sender code."
        },
        "description":{
            "type":"string",
            "description":"Description of the sms sender code."
        },
        "permissions":{
            "type":"array",
            "description":"The permissions for the sms sender code granted to your current instance. This is a read-only property.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"The folder id of the folder which contains the sms sender code."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"Id of the template used to create the asset."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user who created the sms sender code."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the sms sender code was created, expressed in Unix time."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"The login id of the user that last updated the sms sender code."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the sms sender code was last updated. This is a read-only property."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used"
        },
        "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>. For more information, see <a href='https://docs.oracle.com/cloud/latest/marketingcs_gs/OMCAB/index.html#CSHID=RequestDepth'>Request depth</a>."
        },
        "senderCodeId":{
            "type":"string",
            "description":"Id of the associated sender code."
        },
        "countryCode":{
            "type":"string",
            "description":"Associated country code."
        },
        "senderCode":{
            "type":"string",
            "description":"Associated sender code."
        }
    }
}

Nested Schema : permissions

Type: array

The permissions for the sms sender code granted to your current instance. This is a read-only property.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The permissions for the sms sender code granted to your current instance. This is a read-only property.",
    "items":{
        "type":"string"
    }
}

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