The Credentialing Outreach Resource API from Certifyos — 5 operation(s) for credentialing outreach resource.
openapi: 3.2.0
info:
description: API for Certify application
title: Certify API Layer Credentialing Outreach Resource API
version: 1.0.0
servers:
- url: http://localhost:9000
description: Local Development Server
- url: https://api-service.staging.certifyos.com
description: Staging Server
- url: https://api-service.internal.certifyos.com
description: Internal Server
- url: https://api-service.test.certifyos.com
description: Test Server
- url: https://api-service.demo.certifyos.com
description: Demo Server
- url: https://api-service.certifyos.com
description: Production Server
tags:
- name: Credentialing Outreach Resource
paths:
/credentialing-outreaches:
post:
summary: Send a new credentialing outreach email
description: Sends a credentialing outreach email to one or more email addresses, with optional CC, BCC, reply-to, and attachments. The 'toEmails' field accepts a list of email addresses directly.
operationId: sendCredentialingOutreach
parameters:
- description: Tenant ID
required: true
name: tenant-id
in: header
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SendCredentialingOutreachRequest'
required: true
responses:
'201':
description: 'Outreach email sent successfully. Two response shapes are possible: (1) Multi-tenant request (workflowIds.size > 1): body is MultiTenantOutreachResult with fields outreachId (String) and sends (PerWorkflowSendStatus[]). (2) Single-workflow request: body is a bare String containing the outreach record ID.'
content:
application/json: {}
'400':
description: Invalid request data
content:
application/json: {}
'401':
description: Unauthorized - Authentication required
'403':
description: Forbidden - User does not have required permissions
'500':
description: Internal Server Error - An unexpected error occurred
tags:
- Credentialing Outreach Resource
security:
- jwt: []
/credentialing-outreaches/attachments/{attachmentId}/download:
get:
summary: Download email attachment
description: Returns a presigned URL for downloading an email attachment from Google Cloud Storage. The URL expires after 1 hour.
operationId: downloadEmailAttachment
parameters:
- description: Attachment ID
required: true
name: attachmentId
in: path
schema:
type: string
- description: Tenant ID
required: true
name: tenant-id
in: header
schema:
type: string
responses:
'200':
description: Presigned URL generated successfully
content:
application/json:
schema:
$ref: '#/components/schemas/AttachmentDownloadResponse'
'401':
description: Unauthorized - Authentication required
'403':
description: Forbidden - User does not have required permissions
'404':
description: Attachment not found
'500':
description: Internal Server Error - An unexpected error occurred
tags:
- Credentialing Outreach Resource
security:
- jwt: []
/credentialing-outreaches/workflow/{workflowId}:
get:
summary: List all outreaches for a workflow
description: Returns a list of all outreaches associated with the specified credentialing workflow
operationId: listCredentialingOutreaches
parameters:
- description: Workflow ID
required: true
name: workflowId
in: path
schema:
type: string
- description: Tenant ID
required: true
name: tenant-id
in: header
schema:
type: string
responses:
'200':
description: List of outreaches retrieved successfully
content:
application/json: {}
'401':
description: Unauthorized - Authentication required
'403':
description: Forbidden - User does not have required permissions
'500':
description: Internal Server Error - An unexpected error occurred
tags:
- Credentialing Outreach Resource
security:
- jwt: []
/credentialing-outreaches/{id}:
get:
summary: Get a single outreach by ID
description: Returns the details of a specific outreach by its ID
operationId: getCredentialingOutreach
parameters:
- description: Outreach ID
required: true
name: id
in: path
schema:
type: string
- description: Tenant ID
required: true
name: tenant-id
in: header
schema:
type: string
responses:
'200':
description: Outreach retrieved successfully
content:
application/json: {}
'401':
description: Unauthorized - Authentication required
'403':
description: Forbidden - User does not have required permissions
'404':
description: Outreach not found
'500':
description: Internal Server Error - An unexpected error occurred
tags:
- Credentialing Outreach Resource
security:
- jwt: []
/credentialing-outreaches/{id}/details:
get:
summary: Get a single outreach with emails and replies
description: Returns the details of a specific outreach including all its emails, their replies, and a timeline
operationId: getCredentialingOutreachDetail
parameters:
- description: Outreach ID
required: true
name: id
in: path
schema:
type: string
- description: Tenant ID
required: true
name: tenant-id
in: header
schema:
type: string
responses:
'200':
description: Outreach detail retrieved successfully
content:
application/json: {}
'401':
description: Unauthorized - Authentication required
'403':
description: Forbidden - User does not have required permissions
'404':
description: Outreach not found
'500':
description: Internal Server Error - An unexpected error occurred
tags:
- Credentialing Outreach Resource
security:
- jwt: []
components:
schemas:
AttachmentDownloadResponse:
description: Response containing presigned URL for downloading email attachment
type: object
properties:
url:
type: string
description: Presigned URL for downloading the attachment
expiresIn:
type: integer
format: int32
description: Number of hours until the URL expires
expiresAt:
type: integer
format: int64
description: Unix timestamp when the URL expires
fileName:
type: string
description: Original filename of the attachment
AttachmentDTO:
type: object
required:
- filename
- content
- contentType
properties:
filename:
type: string
pattern: \S
content:
type: string
format: binary
contentType:
type: string
pattern: \S
SendCredentialingOutreachRequest:
description: Request body for sending a credentialing outreach email
type: object
properties:
workflowId:
type: string
description: The workflow ID for the credentialing outreach. Required for single-workflow requests. When workflowIds is provided with more than one entry, this field is optional.
examples:
- workflow-123
workflowIds:
type: array
items:
type: string
description: List of workflow IDs for multi-tenant outreach. When more than one entry is provided, initiatingWorkflowId must also be set. Single-workflow requests should leave this null and use workflowId instead.
examples:
- - workflow-123
- workflow-456
initiatingWorkflowId:
type: string
description: The workflow ID of the initiating org for multi-tenant outreach. Required when workflowIds contains more than one entry. Must be present in the workflowIds list. The initiating workflow's tenant outreach-settings template is applied to all bundled workflows.
examples:
- workflow-123
toEmails:
type: array
items:
type: string
description: List of email addresses to send the outreach email to
examples:
- - recipient@example.com
minItems: 1
body:
type: string
description: Email body content
examples:
- Please complete your credentialing application.
pattern: \S
ccEmails:
type: array
items:
type: string
description: Optional list of CC email addresses
examples:
- - cc@example.com
bccEmails:
type: array
items:
type: string
description: Optional list of BCC email addresses
examples:
- - bcc@example.com
outreachReasons:
type: array
items:
type: string
description: List of reasons for the outreach
examples:
- - Missing documentation
- Expired license
minItems: 1
subject:
type: string
description: Email subject line
examples:
- 'Action Required: Complete Your Credentialing'
pattern: \S
attachments:
type: array
items:
$ref: '#/components/schemas/AttachmentDTO'
description: Optional list of email attachments
multiTenant:
type: boolean
required:
- toEmails
- body
- outreachReasons
- subject
securitySchemes:
jwt:
type: http
description: JWT Authentication - Provide only the raw token without Bearer prefix
scheme: bearer
bearerFormat: JWT