Retrieve a keyword
get
/api/rest/2.0/assets/sms/keyword/{id}
Retrieves the Keyword specified by the
id
parameter.Request
Supported Media Types
- application/json
Path Parameters
-
id(required): integer
Id of the Keyword
Query Parameters
-
depth: string
Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth:
minimal
,partial
, andcomplete
. Any other values passed are reset tominimal
by default.
Response
Supported Media Types
- application/json
200 Response
OK
Root Schema : Keyword
Type:
object
Title:
Show Source
Keyword
-
countryCodes:
array countryCodes
Countty codes associated with keyword.
-
createdAt:
string
Read Only:
true
The date and time the keyword was created, expressed in Unix time. -
createdBy:
string
Read Only:
true
The login id of the user who created the keyword. -
currentStatus:
string
The keyword'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
, andcomplete
. Any other values passed are reset tocomplete
by default. For more information, see Request depth. -
description:
string
The description of the keyword.
-
folderId:
string
Read Only:
true
The folder id of the folder which contains the keyword. -
id:
string
Read Only:
true
Id of the keyword. This is a read-only property. -
keyword:
string
The name of the Keyword.
-
keywordPosition:
string
Position of keyword.
-
keywordType:
string
The type of the keyword.
-
name:
string
The name of the keyword.
-
permissions:
array permissions
The permissions for the keyword granted to your current instance. This is a read-only property.
-
scheduledFor:
string
Read Only:
true
This property is not used. -
senderCodeId:
integer
Id of the associated sender code.
-
sourceTemplateId:
string
Id of the template used to create the keyword.
-
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 was last updated. -
updatedBy:
string
Read Only:
true
The login id of the user that last updated the keyword.
Nested Schema : permissions
Type:
array
The permissions for the keyword granted to your current instance. This is a read-only property.
Show Source
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.