{
"taskUrl": "https://api.affinity.co/v2/tasks/suggested-field-updates/create/7c9e6679-7425-40de-944b-e07fc1f90ae7"
}{
"errors": [
{
"code": "bad-request",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "authorization",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "not-found",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "authentication",
"message": "<string>"
}
]
}Generate suggested field updates
| ⚠️ This endpoint is currently in BETA |
|---|
The endpoint returns 404 when AI agents access is not enabled for the organization.
Generate suggested field updates from a note or a meeting. Generation runs asynchronously: poll the returned taskUrl until the task finishes, then retrieve the set. The set can also be retrieved while generation runs, with status pending.
Sets belong to the user who requested them. Sets generated automatically for a new note belong to the note’s creator. You have at most one pending set per subject. While it is generating, repeated requests return its task. Otherwise each request generates a new set, and your open set for the subject becomes done. Its undecided suggestions can no longer be decided. Other users’ sets for the subject are not affected.
Returns 404 when the subject does not exist or is not accessible to you.
{
"taskUrl": "https://api.affinity.co/v2/tasks/suggested-field-updates/create/7c9e6679-7425-40de-944b-e07fc1f90ae7"
}{
"errors": [
{
"code": "bad-request",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "authorization",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "not-found",
"message": "<string>"
}
]
}{
"errors": [
{
"code": "authentication",
"message": "<string>"
}
]
}Authorizations
A static Affinity API key, presented as a bearer token.
Body
Request body for generating suggested field updates
The record the suggestions are generated from
Show child attributes
Show child attributes
Response
Accepted
Response body for generating suggested field updates
URL to poll for the generation task's status
"https://api.affinity.co/v2/tasks/suggested-field-updates/create/7c9e6679-7425-40de-944b-e07fc1f90ae7"
Was this page helpful?