Update outreach settings for a type
PUT/organizations/:organizationId/outreach-settings/:type
Saves outreach settings for a single outreach type and credentialing cycle. Only the cycle named in the request body's credentialingCycle field (defaults to INITIAL) is affected; the other cycle's previously saved data for this type is left untouched. Calling this twice with the same body produces the same stored state (idempotent), and no events are emitted. This method and POST /organizations/{organizationId}/outreach-settings/{type} call the exact same underlying operation and behave identically, including creating settings that did not previously exist; there is currently no functional difference between the two. An invalid type value results in a generic 500, not a 400 - see the 500 response description. Requires the TENANT_SETTINGS_OUTREACH_UPDATE permission.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 500
The saved OutreachSettingsResponse for this type and cycle, reflecting the request body that was just written.
The request body is missing, template.subject or template.body is blank, an outreach reason is missing its reason or instruction text, a ccEmails entry is blank, or the tenant-id header is missing or blank.
Unauthorized - Authentication required
Forbidden - User does not have required permissions
Organization not found
Internal Server Error. Also currently returned - instead of a 400 - when type is not one of PRACTITIONER_CREDENTIALING, FACILITY_CREDENTIALING, or PRACTITIONER_MONITORING.