Skip to main content
PUT
Update a structured data field

Authorizations

asapp-api-id
string
header
required
asapp-api-secret
string
header
required

Path Parameters

structuredDataFieldId
string
required

Identifier of the structured data field

Body

application/json

Update a structured data field

name
string
required

The name of the structured data field

Example:

"Promotion was offered"

categoryId
string
required

The category id assigned

Example:

"OUTCOME"

type
string
required

The type of the object

Example:

"QUESTION"

active
boolean
required

Indicates if the structured data is active or not

Example:

false

question
object
required
segmentIds
string[]
required

The segment ids that the structured data field is associated with

Response

Successfully updated the structured data field.

id
string
required

The id of the structured data field

Example:

"q_promotion_was_offered"

name
string
required

The name of the structured data field

Example:

"Promotion was offered"

categoryId
string
required

The category of the structured data field. Possible values:

  • OUTCOME
Example:

"OUTCOME"

type
string
required

The type of the structured data field. Must be either:

  • QUESTION
  • ENTITY
Example:

"QUESTION"

active
boolean
required

Indicates if the structured data is active or not.

Example:

false

question
object
required
segmentIds
string[]
required

The segment ids that the structured data field is associated with