Skip to content

Save Intent To Contact Metadata

POST
/intent/contacts/metadata

Write each contact’s resolved intent onto the contact record, in the background.

202: the work runs after the response, on THIS request’s own background tasks. The org is always the key’s own; force_update overwrites intent metadata already present instead of only filling gaps.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Write each contact’s resolved intent onto the contact record.

No org_id: the org is the authenticated key’s own.

object
force_update

Overwrite intent metadata already on a contact, rather than only filling gaps.

boolean

Responses

202

Successful Response

object
data
required

One intent object or handler response.

Open-shaped: these payloads carry corpus detail that grows with the corpus. A list result is returned under items.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string