{
  "opencollection": "1.0.0",
  "info": {
    "name": "Certify API Layer Organization Outreach Settings Resource API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Organization Outreach Settings Resource",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get all outreach settings for an organization",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:9000/organizations/:organizationId/outreach-settings",
            "headers": [
              {
                "name": "tenant-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns all outreach settings configured for an organization, grouped by outreach type"
        },
        {
          "info": {
            "name": "Get global outreach CC email addresses",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:9000/organizations/:organizationId/outreach-settings/cc-emails",
            "headers": [
              {
                "name": "tenant-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns the global CC email addresses configured for all outreach types for an organization"
        },
        {
          "info": {
            "name": "Update global outreach CC email addresses",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://localhost:9000/organizations/:organizationId/outreach-settings/cc-emails",
            "headers": [
              {
                "name": "tenant-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Updates the global CC email addresses for all outreach types for an organization"
        },
        {
          "info": {
            "name": "Get outreach settings for a specific type",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:9000/organizations/:organizationId/outreach-settings/:type",
            "headers": [
              {
                "name": "tenant-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "type",
                "value": "",
                "type": "path",
                "description": "Outreach type"
              },
              {
                "name": "credentialingCycle",
                "value": "",
                "type": "query",
                "description": "Credentialing cycle (INITIAL or RECREDENTIALING)"
              },
              {
                "name": "workflowId",
                "value": "",
                "type": "query",
                "description": "Credentialing workflow ID (alternative to credentialingCycle)"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns outreach settings for a specific outreach type (PRACTITIONER_CREDENTIALING, FACILITY_CREDENTIALING, or PRACTITIONER_MONITORING)"
        },
        {
          "info": {
            "name": "Create or update outreach settings for a type",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "http://localhost:9000/organizations/:organizationId/outreach-settings/:type",
            "headers": [
              {
                "name": "tenant-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "type",
                "value": "",
                "type": "path",
                "description": "Outreach type"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Creates or updates outreach settings for a specific outreach type. If settings for the type already exist, they will be replaced."
        },
        {
          "info": {
            "name": "Update outreach settings for a specific type",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "http://localhost:9000/organizations/:organizationId/outreach-settings/:type",
            "headers": [
              {
                "name": "tenant-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "type",
                "value": "",
                "type": "path",
                "description": "Outreach type"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Updates outreach settings for a specific outreach type. Settings for the type must already exist."
        },
        {
          "info": {
            "name": "Delete outreach settings for a specific type",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "http://localhost:9000/organizations/:organizationId/outreach-settings/:type",
            "headers": [
              {
                "name": "tenant-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "type",
                "value": "",
                "type": "path",
                "description": "Outreach type"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Deletes outreach settings for a specific outreach type"
        },
        {
          "info": {
            "name": "Get email composer autopopulation data for credentialing workflows",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "http://localhost:9000/organizations/:organizationId/outreach-settings/:type/email-composer-data",
            "headers": [
              {
                "name": "tenant-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "organizationId",
                "value": "",
                "type": "path",
                "description": "Organization ID"
              },
              {
                "name": "type",
                "value": "",
                "type": "path",
                "description": "Outreach type"
              },
              {
                "name": "reasonIds",
                "value": "reason1,reason2",
                "type": "query",
                "description": "Comma-separated list of outreach reason IDs to get instructions for"
              },
              {
                "name": "workflowId",
                "value": "",
                "type": "query",
                "description": "Credentialing workflow ID"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns template settings, dynamic field values, and reason instructions needed to autopopulate the email composer for credentialing workflows. Supports both PRACTITIONER_CREDENTIALING and FACILITY_CREDENTIALING workflows for INITIAL and RECREDENTIALING cycles. This endpoint combines outreach settings with workflow data to provide all required information for the frontend. Accepts comma-separated reason IDs."
        }
      ]
    }
  ],
  "bundled": true
}