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
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
403Forbidden
500Internal server error
