Jump to

• Request
• Response

Update a lead qualification answer

patch

/crmRestApi/resources/11.13.18.05/leads/{leadsUniqID}/child/Assessments/{AssessmentId}/child/AssessAnswerGroups/{AssessAnswerGroupId}/child/AssessmentAnswer/{AnswerId}

Request

Path Parameters

• AnswerId(required): integer(int64)
  The unique identifier of the qualification answer.
• AssessAnswerGroupId(required): integer(int64)
  The unique identifier of the answer group.
• AssessmentId(required): integer(int64)
  The unique identifier of a lead qualification.
• leadsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Sales Leads resource and used to uniquely identify an instance of Sales Leads. The client should not generate the hash key value. Instead, the client should query on the Sales Leads collection resource in order to navigate to a specific instance of Sales Leads to get the hash key.

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• Answered: string
  Indicates if the question is answered or not.
• AnswerId: integer (int64)
  The unique identifier of the qualification answer.
• AttributeValueId: integer (int64)
  Title: Response

  The unique identifier of the response.
• Comments: string
  Title: Comments

  Maximum Length: 1500

  The comments entered by the user about the qualification runtime.
• HasComments: string
  Indicates if the comments are present or not.

{
    "type":"object",
    "properties":{
        "AnswerId":{
            "type":"integer",
            "description":"The unique identifier of the qualification answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Answered":{
            "type":"string",
            "description":"Indicates if the question is answered or not.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AttributeValueId",
                    "Comments",
                    "FreeformTextRow"
                ]
            }
        },
        "AttributeValueId":{
            "title":"Response",
            "type":"integer",
            "description":"The unique identifier of the response.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            }
        },
        "Comments":{
            "title":"Comments",
            "maxLength":1500,
            "type":"string",
            "description":"The comments entered by the user about the qualification runtime.",
            "nullable":true
        },
        "HasComments":{
            "type":"string",
            "description":"Indicates if the comments are present or not.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Comments"
                ]
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : leads-Assessments-AssessAnswerGroups-AssessmentAnswer-item-response

Type: object

Show Source

• Answered: string
  Indicates if the question is answered or not.
• AnswerId: integer (int64)
  The unique identifier of the qualification answer.
• AssessmentId: integer (int64)
  The unique identifier of the lead qualification template associated with answer.
• AttributeGroupId: integer (int64)
  Title: Question Group

  The unique identifier of the question group associated with the qualification answer.
• AttributeId: integer (int64)
  Title: Question

  The unique identifier of the question associated with the qualification answer.
• AttributeName: string
  Read Only: true

  Maximum Length: 500

  The name of the question.
• AttributeValueId: integer (int64)
  Title: Response

  The unique identifier of the response.
• Comments: string
  Title: Comments

  Maximum Length: 1500

  The comments entered by the user about the qualification runtime.
• HasComments: string
  Indicates if the comments are present or not.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ResponseValue: string
  Title: Response

  Read Only: true

  The response of the question.

{
    "type":"object",
    "properties":{
        "AnswerId":{
            "type":"integer",
            "description":"The unique identifier of the qualification answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Answered":{
            "type":"string",
            "description":"Indicates if the question is answered or not.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AttributeValueId",
                    "Comments",
                    "FreeformTextRow"
                ]
            },
            "x-queryable":true
        },
        "AssessmentId":{
            "type":"integer",
            "description":"The unique identifier of the lead qualification template associated with answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeGroupId":{
            "title":"Question Group",
            "type":"integer",
            "description":"The unique identifier of the question group associated with the qualification answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeId":{
            "title":"Question",
            "type":"integer",
            "description":"The unique identifier of the question associated with the qualification answer.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "AttributeName":{
            "maxLength":500,
            "type":"string",
            "description":"The name of the question.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AttributeValueId":{
            "title":"Response",
            "type":"integer",
            "description":"The unique identifier of the response.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "precision":18
            },
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "maxLength":1500,
            "type":"string",
            "description":"The comments entered by the user about the qualification runtime.",
            "nullable":true,
            "x-queryable":true
        },
        "HasComments":{
            "type":"string",
            "description":"Indicates if the comments are present or not.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Comments"
                ]
            },
            "x-queryable":true
        },
        "ResponseValue":{
            "title":"Response",
            "type":"string",
            "description":"The response of the question.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top