The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Possible Errors

KT-CT-1113: Disabled GraphQL field requested.
KT-CT-7899: An internal error occurred.
KT-CT-8903: Unable to update opportunity.

Allowed Viewers

Customer

Partner User

Third party

Required Permissions

Can query leads

Query Complexity

Examples

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Query

query OpportunityValueByKey(
  $key: String,
  $opportunityId: ID
) {
  opportunityValueByKey(
    key: $key,
    opportunityId: $opportunityId
  )
}

Variables

{
  "key": "might-visit-Republican-would-reflect",
  "opportunityId": "70315855"
}

Response

{
  "data": {
    "opportunityValueByKey": "per-most-grow-about-home"
  }
}