conversation

List conversation custom properties

List the custom properties defined for conversations of the partner the API key belongs to. Use it to resolve the ids that customProperties is keyed by on the other endpoints: the id is stable, while the display name can be renamed at any time. The full list is returned in one response — it is not paginated. Properties restricted to specific user groups are not listed, since an API key has no user whose groups could be checked. Requires the conversation:read scope.

GET

conversation

custom-property

curl --request GET \
  --url https://connect.provisionapp.io/v1/conversation/custom-property \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://connect.provisionapp.io/v1/conversation/custom-property', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "id": "ca_warranty_count",
    "name": "Warranty count",
    "type": "number",
    "options": [
      {
        "id": "east",
        "name": "East"
      }
    ]
  }
]

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

Authorizations

x-api-key

string

header

required

Send the API key in the x-api-key header.

Response

Custom properties defined for conversations

string

required

Stable id of the property. This is what customProperties is keyed by on reads and writes — the display name can be renamed, this cannot.

Example:

"ca_warranty_count"

entity

enum<string>

required

The entity a custom property is defined for

Available options:

site,

conversation,

client

name

string

required

Display name, as configured in ProVision

Example:

"Warranty count"

type

string

required

Value type the property accepts

Example:

"number"

options

object[]

required

Selectable options for dropdown and multi_select; empty for every other type

Show child attributes

List conversation custom properties

curl --request GET \
  --url https://connect.provisionapp.io/v1/conversation/custom-property \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://connect.provisionapp.io/v1/conversation/custom-property', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "id": "ca_warranty_count",
    "name": "Warranty count",
    "type": "number",
    "options": [
      {
        "id": "east",
        "name": "East"
      }
    ]
  }
]

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}