List experiences you can invoke

GET/v3/experiences

The experiences enabled for your account, with the actions you may invoke on each and the fields each action accepts. This is the authoritative list — an action missing here cannot be sent.

ReturnsExpand Collapse

experiences: optional array of object { actions, display_name, experience }

actions: optional array of object { fields, name, summary }

fields: optional map[object { max, required, type } ]

Fields you may send in params, keyed by the exact name to use.

max: optional number

Maximum length, for strings.

required: optional boolean

type: optional "string" or "cents" or "int"

One of the following:

"string"

"cents"

"int"

name: optional string

summary: optional string

display_name: optional string

experience: optional string

List experiences you can invoke

curl https://api.linqapp.com/api/partner/v3/experiences \
    -H "Authorization: Bearer $LINQ_API_V3_API_KEY"

{
  "experiences": [
    {
      "actions": [
        {
          "fields": {
            "foo": {
              "max": 0,
              "required": true,
              "type": "string"
            }
          },
          "name": "attach_card",
          "summary": "Ask the customer to add a card to their wallet."
        }
      ],
      "display_name": "Agentcard",
      "experience": "agentcard"
    }
  ]
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2004/"
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error",
    "doc_url": "https://docs.linqapp.com/error/codes/3xxx/3006/"
  },
  "success": false
}

Returns Examples

{
  "experiences": [
    {
      "actions": [
        {
          "fields": {
            "foo": {
              "max": 0,
              "required": true,
              "type": "string"
            }
          },
          "name": "attach_card",
          "summary": "Ask the customer to add a card to their wallet."
        }
      ],
      "display_name": "Agentcard",
      "experience": "agentcard"
    }
  ]
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2004/"
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error",
    "doc_url": "https://docs.linqapp.com/error/codes/3xxx/3006/"
  },
  "success": false
}