Skip to main content
GET
Get a suggested field update set

Authorizations

Authorization
string
header
required

A static Affinity API key, presented as a bearer token.

Path Parameters

suggestedFieldUpdateId
string<uuid>
required

Suggested field update set ID

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

Response

OK

Field updates an Affinity agent suggested from one note or meeting. Each suggestion waits for you to accept or reject it, and nothing is written to the CRM until you accept.

id
string<uuid>
required

The set's unique identifier

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

status
enum<string>
required

The status of a set of suggested field updates.

  • pending: suggestions are being generated. suggestions is empty.
  • open: at least one suggestion is pending.
  • done: every suggestion is decided, none were generated, or a newer set was generated for the same subject.
  • expired: the set's expiry passed, so it can no longer be decided. No expiry is set today.
  • failed: generation failed.
Available options:
pending,
open,
done,
expired,
failed
Example:

"open"

subject
SuggestedFieldUpdateSubject · object
required

The record the suggestions are generated from

suggestionCount
integer<int32>
required

The number of suggestions in the set

Required range: 0 <= x <= 100
Example:

3

pendingSuggestionCount
integer<int32>
required

The number of pending suggestions

Required range: 0 <= x <= 100
Example:

1

suggestions
SuggestedFieldUpdateSuggestion · object[]
required

The suggestions in the set. Empty while status is pending.

Maximum array length: 100
createdAt
string<date-time>
required

When generation was requested

Example:

"2026-10-06T12:00:00Z"

resolvedAt
string<date-time> | null
required

When the set reached done, expired, or failed. null while pending or open.

Example:

null