Append a material Forecast event

POST

https://api.sureshake.com/v2/entities/{entityId}/calls/{callId}/events

Path parameters

entityId
required
Any of the following:
string
string
}

callId
string
required
format: uuid

Request body JSON

Any of the following:

object
- type
  note
  required
- note
  string
  required
  maxLength: 4000 · minLength: 1
}
object
- type
  confidence_updated
  required
- confidencePct
  number
  required
  maximum: 100 · minimum: 0
- reason
  optional
  string
  maxLength: 2000
}

Returns

201

Default Response

JSON

data
object
required
- id
  string
  required
  format: uuid
- goalId
  string
  required
  format: uuid
- eventType
  string
  required
- actorUserId
  string
  or null
  required
- payload
  map of
  unknown
  or null
  required
- payloadHash
  string
  or null
  required
- anchoredTx
  string
  or null
  required
- anchoredAt
  string
  or null
  required
  format: date-time
- createdAt
  string
  required
  format: date-time
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

503

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

Append a material Forecast event

curl --request POST \
  --url 'https://api.sureshake.com/v2/entities/<entityId>/calls/<callId>/events' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "note",
  "note": "string"
}
'

const url = 'https://api.sureshake.com/v2/entities/<entityId>/calls/<callId>/events';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({type: 'note', note: 'string'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.sureshake.com/v2/entities/<entityId>/calls/<callId>/events"

payload = {
    "type": "note",
    "note": "string"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "goalId": "eca7991a-9711-43cb-a95b-b261e3bcd08e",
    "eventType": "string",
    "actorUserId": "string",
    "payload": {
      "property1": null,
      "property2": null
    },
    "payloadHash": "string",
    "anchoredTx": "string",
    "anchoredAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}