Replace a call entry
Completely replaces the writable contents of an existing call record for the company identified by X-Client-Code. This is a full replacement, not a partial update: omitted nullable fields are cleared, and the submitted contracts replace all stored contract relationships. Orion returns 404 Not Found when the specified record does not exist.
The request must include callerName and a valid active callerType. Lookup values and contract call types follow the same resolution and defaulting rules described for creation.
Orion determines the acting user from the configured token identity claims. If none of these claims is present, Orion uses the trimmed userName from the request body to identify the caller in machine-to-machine scenarios.
X-Correlation-Id makes the replacement idempotent for at least 24 hours. A successful replacement or completed identical replay returns 200 OK; replays also include X-Idempotent-Replay: true and do not apply the replacement again. Reusing the ID for different content or while the original request is still running returns 409 Conflict.
This operation does not support PATCH, ETags, If-Match, or optimistic concurrency.
Path Parameters
Headers
Required company selector containing 3-4 ASCII letters. The caller must have access to the selected company.
Match pattern:^[A-Za-z]{3,4}$
>= 3 characters<= 4 characters
Example:ABCD
Required nonblank idempotency key, maximum 100 raw-input characters; accepted values are trimmed. Scoped by canonical tenant, operation, and resource identity; clients must generate operation-unique values.
Match pattern:^[\s\S]*$
>= 1 characters<= 100 characters
Example:call-entry-create-123
Body
Body
Full replacement payload. Omitted nullable fields are cleared; contracts replace the stored collection. Unknown JSON properties remain permissive.
CallEntryWriteRequest
Full-field name-based request shared by POST and PUT. Tenant selection and authorization never use payload userName. String maximum lengths apply to raw input before trimming. Accepted lookup names and identifiers are trimmed; blank optional identifiers and survey values become null. Storage encoding may limit Unicode persistence; character-length bounds do not guarantee Unicode round-tripping.
Conditional interim M2M actor. Raw input is limited to 255 characters even when a token claim supplies the actor. Otherwise trimmed, opaque, and required.
Match pattern:^[\s\S]*$
>= 0 characters<= 255 characters
Optional contracts; missing, null, and empty are equivalent. Trimmed contract numbers joined with commas must total at most 200 characters, including separators. Contract and call-type order is non-semantic for idempotency.
Show Child Parameters
Required active caller-type name, trimmed and matched case-insensitively to its canonical tenant value.
Match pattern:^[\s\S]*$
>= 1 characters<= 50 characters
Canonical root call-type name. Required without contracts; otherwise supplies an inheritable default. If absent, every contract must supply at least one call type.
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
Optional active product-type name resolved to its canonical tenant value.
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
>= 0<= 255
Match pattern:^[\s\S]*$
>= 0 characters<= 7000 characters
Canonical values: Not Offere, Not Taken, Taken. Accepted case-insensitively after trimming; blank input becomes null. Maximum length applies before trimming.
Allowed values:Not OffereTakenNot Taken
Match pattern:^[\s\S]*$
>= 0 characters<= 10 characters
SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
Required nonblank caller identity. Raw input is limited to 500 characters; accepted values are trimmed.
Match pattern:^[\s\S]*$
>= 1 characters<= 500 characters
Match pattern:^[\s\S]*$
>= 0 characters<= 20 characters
Match pattern:^[\s\S]*$
>= 0 characters<= 250 characters
Optional active transaction-type name resolved to its canonical tenant value.
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
Decimal monetary value within the SQL money range. SQL rounds to four fractional digits; extra decimal places are not rejected by the API.
>= -922337203685477.6<= 922337203685477.6
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
Optional authorization-status value, maximum 5 raw-input characters.
Match pattern:^[\s\S]*$
>= 0 characters<= 5 characters
Date of birth represented as a date-time, not a date-only value. SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
Optional four-character SSN field. No digits-only restriction is imposed.
Match pattern:^[\s\S]*$
>= 0 characters<= 4 characters
Match pattern:^[\s\S]*$
>= 0 characters<= 7000 characters
SQL datetime range: 1753-01-01T00:00:00 through 9999-12-31T23:59:59.997. SQL rounds fractional seconds to approximately 3.33 ms precision. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
Match pattern:^[\s\S]*$
>= 0 characters<= 50 characters
Response
Response
OK. First full replacement or identical completed replay; a replay does not apply the replacement again.
CallEntry
>= 1 characters
Server-generated call-entry identity.
<= 50 characters
<= 50 characters
<= 50 characters
Legacy comma-joined contract-number mirror.
<= 200 characters
>= 0<= 255
<= 7000 characters
<= 10 characters
Computed from follow-up dates: null when followUpRequestedDate is null; otherwise false when followUpCompletedDate is null, and true when it is present. Not writable.
SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
Acting user supplied by token identity or conditional userName. PUT replaces this actor while preserving createdDate.
>= 1 characters<= 255 characters
Server-generated creation timestamp. SQL datetime range: 1753-01-01T00:00:00 through 9999-12-31T23:59:59.997. SQL rounds fractional seconds to approximately 3.33 ms precision. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
Server-generated last-write timestamp. SQL datetime range: 1753-01-01T00:00:00 through 9999-12-31T23:59:59.997. SQL rounds fractional seconds to approximately 3.33 ms precision. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
<= 500 characters
<= 20 characters
<= 250 characters
<= 50 characters
SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
Decimal monetary value within the SQL money range. SQL rounds to four fractional digits; extra decimal places are not rejected by the API.
>= -922337203685477.6<= 922337203685477.6
<= 50 characters
Optional authorization-status value, maximum 5 raw-input characters.
<= 5 characters
Date of birth represented as a date-time, not a date-only value. SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
Optional four-character SSN field. No digits-only restriction is imposed.
<= 4 characters
<= 7000 characters
SQL datetime range: 1753-01-01T00:00:00 through 9999-12-31T23:59:59.997. SQL rounds fractional seconds to approximately 3.33 ms precision. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
<= 50 characters
<= 50 characters
Show Child Parameters
Authentication
Path Parameters
Headers
Body
Get a call entry
Retrieves one complete CallEntry by its ID. The caller must have read access to the company that owns the record.
Identify the company with X-Client-Code or the backward-compatible clientCode query parameter. At least one is required. If both are supplied with different values, the query parameter takes precedence. Orion returns 404 Not Found when the record does not exist in the selected company.
Query Parameters
Deprecated: use X-Client-Code. Selects one company. Takes precedence over X-Client-Code if both are supplied. If neither is supplied, search includes every company the caller is authorized to read; get-by-ID requires at least one tenant selector.
Match pattern:^[A-Za-z]{3,4}$
>= 3 characters<= 4 characters
Example:ABCD
Path Parameters
Headers
Preferred tenant selector for new consumers. Optional only for legacy GET compatibility. If query clientCode is also supplied and conflicts after normalization, the query value wins and the conflict is logged.
Match pattern:^[A-Za-z]{3,4}$
>= 3 characters<= 4 characters
Example:ABCD
Response
Response
OK
CallEntry
>= 1 characters
Server-generated call-entry identity.
<= 50 characters
<= 50 characters
<= 50 characters
Legacy comma-joined contract-number mirror.
<= 200 characters
>= 0<= 255
<= 7000 characters
<= 10 characters
Computed from follow-up dates: null when followUpRequestedDate is null; otherwise false when followUpCompletedDate is null, and true when it is present. Not writable.
SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
Acting user supplied by token identity or conditional userName. PUT replaces this actor while preserving createdDate.
>= 1 characters<= 255 characters
Server-generated creation timestamp. SQL datetime range: 1753-01-01T00:00:00 through 9999-12-31T23:59:59.997. SQL rounds fractional seconds to approximately 3.33 ms precision. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
Server-generated last-write timestamp. SQL datetime range: 1753-01-01T00:00:00 through 9999-12-31T23:59:59.997. SQL rounds fractional seconds to approximately 3.33 ms precision. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
<= 500 characters
<= 20 characters
<= 250 characters
<= 50 characters
SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
Decimal monetary value within the SQL money range. SQL rounds to four fractional digits; extra decimal places are not rejected by the API.
>= -922337203685477.6<= 922337203685477.6
<= 50 characters
Optional authorization-status value, maximum 5 raw-input characters.
<= 5 characters
Date of birth represented as a date-time, not a date-only value. SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
Optional four-character SSN field. No digits-only restriction is imposed.
<= 4 characters
<= 7000 characters
SQL datetime range: 1753-01-01T00:00:00 through 9999-12-31T23:59:59.997. SQL rounds fractional seconds to approximately 3.33 ms precision. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
<= 50 characters
<= 50 characters
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Headers
CallEntry
object>= 1 characters
Server-generated call-entry identity.
<= 50 characters
<= 50 characters
<= 50 characters
Legacy comma-joined contract-number mirror.
<= 200 characters
>= 0<= 255
<= 7000 characters
<= 10 characters
Computed from follow-up dates: null when followUpRequestedDate is null; otherwise false when followUpCompletedDate is null, and true when it is present. Not writable.
SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
Acting user supplied by token identity or conditional userName. PUT replaces this actor while preserving createdDate.
>= 1 characters<= 255 characters
Server-generated creation timestamp. SQL datetime range: 1753-01-01T00:00:00 through 9999-12-31T23:59:59.997. SQL rounds fractional seconds to approximately 3.33 ms precision. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
Server-generated last-write timestamp. SQL datetime range: 1753-01-01T00:00:00 through 9999-12-31T23:59:59.997. SQL rounds fractional seconds to approximately 3.33 ms precision. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
<= 500 characters
<= 20 characters
<= 250 characters
<= 50 characters
SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
Decimal monetary value within the SQL money range. SQL rounds to four fractional digits; extra decimal places are not rejected by the API.
>= -922337203685477.6<= 922337203685477.6
<= 50 characters
Optional authorization-status value, maximum 5 raw-input characters.
<= 5 characters
Date of birth represented as a date-time, not a date-only value. SQL smalldatetime range: 1900-01-01T00:00:00 through 2079-06-06T23:59:59. SQL rounds seconds to minute precision. Range validation does not simulate rounding at storage boundaries. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
Optional four-character SSN field. No digits-only restriction is imposed.
<= 4 characters
<= 7000 characters
SQL datetime range: 1753-01-01T00:00:00 through 9999-12-31T23:59:59.997. SQL rounds fractional seconds to approximately 3.33 ms precision. Storage has no timezone; reads use the API server’s local-time interpretation, with no UTC normalization guarantee.
<= 50 characters
<= 50 characters
Show Child Parameters
CallEntryContract
object>= 1 characters<= 50 characters
Match pattern:^[\s\S]*$
>= 1 characters<= 50 characters