Docs
Account, keys and webhooks ›

Set heard

PUT/v1/me/heard

Set heard.

Requestcurl
  1. curl -X PUT https://agental.io/v1/me/heard \
  2. -H "Authorization: Bearer $AGENTAL_API_KEY" \
  3. -H "Content-Type: application/json" \
  4. -d '{"heard":"…"}'
Answer200 OK · Heard
  1. {
  2. "heard": string | null,
  3. }

The answer as it is kept.

Headers

Authorizationrequired
Bearer key
An API key that may make this call.

Body

heardrequired
string
A few words, kept as one line of at most 200 characters. It replaces an earlier answer.

Returns

200 The answer as it is kept.

Heard1 field
heard
stringnull
What the person wrote to "How did you hear about agental?".
More Null until they answer.

Errors and other answers

400heard_empty the answer says nothing. Nothing was kept.
403session_required an API key cannot do this. A person signed in can, in the console.

Every error answers { "error": { "code", "message" } }; a key without the action a call needs answers 403 key_action_forbidden, naming it.