Get Auto Suggest for Smart Campaign¶

GET /rest/asset/v1/smartCampaign/{id}/autoSuggest.json

Permissions Read-Only AssetsRead-Write Assets

Method: GET
Path: /rest/asset/v1/smartCampaign/{id}/autoSuggest.json
Tag: Smart Campaigns
Operation ID: getSmartCampaignAutoSuggestUsingGET

Returns suggested values for configuring a flow step choice. Required Permissions: Read-Only Assets, Read-Write Assets

Formats¶

Request: application/x-www-form-urlencoded
Response: application/json

Request¶

Path parameters¶

Name	Type	Required	Description	Constraints
`id`	integer (int32)	Yes	Id of the smart campaign

Query parameters¶

Name	Type	Required	Description	Constraints
`ruleTypeId.id`	integer (int32)	Yes	Id of the rule type
`ruleTypeId.type`	string	Yes	Type of the rule type	enum: activity, attribute
`optionTypeId.id`	integer (int32)	Yes	Id of the option type
`optionTypeId.type`	string	Yes	Type of the option type	enum: activity, attribute
`primaryAttributeValue`	string	No	Value used to filter suggestions

Example request¶

GET {{base_url}}/rest/asset/v1/smartCampaign/{{id}}/autoSuggest.json?ruleTypeId.id={{ruleTypeId.id}}&ruleTypeId.type=activity&optionTypeId.id={{optionTypeId.id}}&optionTypeId.type=activity&primaryAttributeValue={{primaryAttributeValue}}
Accept: application/json

Responses¶

200 — OK¶

Schema: model: ResponseOfAutoSuggestValue

Generated example¶

{
  "errors": [
    {
      "code": "string",
      "message": "string"
    }
  ],
  "requestId": "123",
  "result": [
    {
      "id": 123,
      "displayName": "Example name",
      "name": "Example name"
    }
  ],
  "success": true,
  "warnings": [
    "string"
  ]
}

Referenced models¶

ResponseOfAutoSuggestValue

Source¶

Generated from swagger-asset.json.

Generated examples are inferred from the schema. They are illustrative and may not be valid production payloads.