Save change comm template
Changed onSave the change communication email template for a compensation planning cycle.
Only applies to a cycle whose letter is a single message. On a cycle assembled from sections the letter body lives in those section rows, so this route returns 409 with stringErrorCode CHANGE_COMM_SECTIONS_OWN_LETTER and writes nothing at all, including the subject. Check hasSections on the change_comm GET to tell the two apart before writing.
A successful save also marks the cycle's change communications reviewed, which the launch route requires before it will move a cycle to Live. Supplying the letter body counts as having read it, so a cycle created and authored entirely through this API can be launched without a visit to the web UI. Only a save that succeeds and supplies something to read does this: a 409, a rejected request, a failed write, or a save whose subject and body are both empty leaves the cycle unreviewed. Clearing a letter is still allowed and still returns 200, but it cannot stand in for having read one, so a cycle cleared this way will refuse to launch until a real letter is saved. Re-saving is harmless and keeps the original review time. The response is unchanged either way.
OAuth Scopes: planning_cycles.write
Request
- Base URLhttps://companySubDomain.bamboohr.com
- AuthOAuth 2Authorization code/authorize.phpToken URL/token.phpScopesplanning_cycles.write
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Request body
Response
Template saved successfully
Changes
- info
api operation id
c79f9c5950f983e59d2626faa30c00a1removed and replaced with1f2ebf2e827777529d695e3898906924 - info
added the non-success response with the status
- info
added the non-success response with the status
- info