Compensation Planning
Public API

Get change communication letter details

Changed on

Get change communication letter details for the compensation planning cycle.

A cycle's letter is either a single message or assembled from ordered sections, and hasSections says which. When hasSections is false, changeCommunicationMessageText is the stored single message. When it is true, that field is the assembled letter instead: the bodies of the sections this cycle can use, joined in stored order. Sections describing a compensation type the cycle does not run are left out, as are sections with no visible content. It is neither everything stored nor any one employee's letter. A section for a compensation type this cycle does not run reaches nobody, so it is excluded; but a recipient also reads only the sections their own award qualifies them for, so a cycle running more than one compensation type assembles more than any single employee is sent. sections reports every stored section regardless, with isActive marking the ones that reach anyone, and is the precise read. sections is read-only; the PUT to change_comm/template cannot write it and returns 409 on a cycle that has sections.

OAuth Scopes: planning_cycles

get/api/v1/compensation/planning_cycles/{id}/change_comm

Request

Path parameters

idinteger required

Response

Success

changeCommunicationMessageTextstring nullable

The letter body. The assembled section bodies when hasSections is true, otherwise the stored single message.

changeCommunicationSubjectTextstring nullable

The letter subject template.

cycleStatusstring nullable

The cycle's status, such as DRAFT.

variablePlaceholdersobject

The placeholder tokens a letter body may contain, keyed by token, each with a display name and an example value.

hasSectionsboolean

Whether this cycle's letter is assembled from sections. When true, the template PUT returns 409. Absent, along with sections, when the cycle does not exist or has been deleted: that response carries variablePlaceholders alone.

Changes

    • info

      api operation id d6987e300672a00c7cfe59afebb64156 removed and replaced with 6c7522fc5664153e97459c2b76ca55ca

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status