openapi: 3.2.0 info: title: Fenergo Nebula Outreach Command… description: '**Outreach Command API**: Outreach Command API provides endpoints in order to manage and configure all related models and their versions.' version: 1.0.0 servers: - url: /outreachcommand security: - Bearer: [] tags: - name: Fenergo.Nebula.Outreach.Command.Api paths: /api/EmailDomain: post: tags: - Fenergo.Nebula.Outreach.Command.Api parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/NewEmailDomainDtoServiceRequest' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/EmailDomainDtoServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT summary: Create api email domain x-summary-source: derived operationId: postApiEmailDomain x-operation-id-source: derived /api/EmailDomain/{id}/verify: put: tags: - Fenergo.Nebula.Outreach.Command.Api parameters: - name: id in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/EmailDomainDtoServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT summary: Replace api email domain by id verify x-summary-source: derived operationId: putApiEmailDomainByIdVerify x-operation-id-source: derived /api/EmailDomain/{id}/enable: put: tags: - Fenergo.Nebula.Outreach.Command.Api parameters: - name: id in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT summary: Replace api email domain by id enable x-summary-source: derived operationId: putApiEmailDomainByIdEnable x-operation-id-source: derived /api/EmailDomain/{id}/disable: put: tags: - Fenergo.Nebula.Outreach.Command.Api parameters: - name: id in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT summary: Replace api email domain by id disable x-summary-source: derived operationId: putApiEmailDomainByIdDisable x-operation-id-source: derived /api/EmailDomain/{id}: delete: tags: - Fenergo.Nebula.Outreach.Command.Api parameters: - name: id in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT summary: Delete api email domain by id x-summary-source: derived operationId: deleteApiEmailDomainById x-operation-id-source: derived /api/EmailMessages: post: tags: - Fenergo.Nebula.Outreach.Command.Api parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/EmailSendDtoServiceRequest' responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/EmailSendResponseDtoServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT summary: Create api email messages x-summary-source: derived operationId: postApiEmailMessages x-operation-id-source: derived /api/portalAccess: post: tags: - Fenergo.Nebula.Outreach.Command.Api parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/PortalAccessEmailDtoServiceRequest' responses: '202': description: Accepted content: application/json: schema: $ref: '#/components/schemas/PortalAccessEmailResponseDtoServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT summary: Create api portal access x-summary-source: derived operationId: postApiPortalAccess x-operation-id-source: derived /api/outreachDraft: post: tags: - Fenergo.Nebula.Outreach.Command.Api parameters: - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/NewOutreachDraftDtoServiceRequest' responses: '201': description: Created content: application/json: schema: $ref: '#/components/schemas/OutreachDraftDtoServiceResponse' '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT summary: Create api outreach draft x-summary-source: derived operationId: postApiOutreachDraft x-operation-id-source: derived /api/outreachDraft/draftId/{id}: put: tags: - Fenergo.Nebula.Outreach.Command.Api parameters: - name: id in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 requestBody: content: application/json: schema: allOf: - $ref: '#/components/schemas/UpdateOutreachDraftDtoServiceRequest' responses: '200': description: OK '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT summary: Replace api outreach draft draft id by id x-summary-source: derived operationId: putApiOutreachDraftDraftIdById x-operation-id-source: derived delete: tags: - Fenergo.Nebula.Outreach.Command.Api parameters: - name: id in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '202': description: Accepted '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT summary: Delete api outreach draft draft id by id x-summary-source: derived operationId: deleteApiOutreachDraftDraftIdById x-operation-id-source: derived /api/outreachDraft/draftId/{id}/submit: post: tags: - Fenergo.Nebula.Outreach.Command.Api parameters: - name: id in: path required: true schema: type: string format: uuid - name: X-TENANT-ID in: header description: The UiD of the tenant representing organization required: true schema: type: string example: b11f8be3-f29b-4959-8964-956d4af7c468 responses: '200': description: OK '401': description: User is not authorized to perform this request content: application/json: example: message: Unauthorized '403': description: Access to resource is forbidden. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: {} messages: - message: 'Access denied. Following permissions are required: Permission1, Permission2' type: Forbidden errorCode: Error Code '500': description: Internal server exception. Please, contact your provider. content: application/json: schema: $ref: '#/components/schemas/ObjectServiceResponse' example: data: null messages: - message: Internal server exception. Please, contact your provider. type: Error errorCode: INTERNAL_SERVER_ERROR '410': description: Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers. content: application/json: schema: $ref: '#/components/schemas/StringServiceResponse' example: data: null messages: - message: This endpoint is obsolete and was terminated on yyyy-MM-dd type: Error errorCode: OBSOLETE_ENDPOINT summary: Create api outreach draft draft id by id submit x-summary-source: derived operationId: postApiOutreachDraftDraftIdByIdSubmit x-operation-id-source: derived components: schemas: PortalAccessEmailResponseDto: type: object properties: id: type: - string - 'null' description: Id of the generated portal access link token example: a1b2c3d4-e5f6-4a1b-8c2d-3e4f5a6b7c8d message: type: - string - 'null' description: Message from mailgun example: Queued. Thank you. additionalProperties: false description: Response DTO representing a portal access link email send response OutreachDataFieldDto: type: object properties: fieldName: type: - string - 'null' tooltip: type: - string - 'null' category: type: - string - 'null' dataKey: type: - string - 'null' additionalProperties: false PortalAccessEmailDto: type: object properties: to: type: - string - 'null' description: Email address of the recipient example: user.name@fenergo.com journeyId: type: - string - 'null' description: The journey this portal access link grants access to example: a1b2c3d4-e5f6-4a1b-8c2d-3e4f5a6b7c8d draftId: type: string description: The Outreach Draft whose journey summary report the portal form should load. format: uuid example: d369d812-7c10-4952-8c28-3ad50df19c10 domainId: type: - string - 'null' description: (optional) Domain Id of an email domain to be used for sending email. Defaults to domain identified by TenantId format: uuid variables: type: - object - 'null' additionalProperties: type: - string - 'null' description: '(optional) Branding/template variable overrides for the PORTALACCESS template - PortalName, PortalIconLink, Subject, PrimaryColor, MainText, SubText, ButtonText, FooterText. Any variable not supplied here falls back to a bank-approved default, so a caller can omit this entirely. PortalAccessLink and CaseReference are always server-derived and cannot be overridden.' example: PortalName: Fenergo Portal Subject: Your secure link additionalProperties: false description: Request DTO representing a portal access link email send request OutreachItemsDto: type: object properties: dataFields: type: - array - 'null' items: $ref: '#/components/schemas/OutreachDataFieldDto' dataGroups: type: - array - 'null' items: $ref: '#/components/schemas/OutreachDataGroupDto' documents: type: - array - 'null' items: $ref: '#/components/schemas/OutreachDocumentDto' relatedParties: type: - array - 'null' items: $ref: '#/components/schemas/OutreachRelatedPartyDto' additionalProperties: false EmailSendResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/EmailSendResponseDto' description: Response DTO representing email send response messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false OutreachDraftDto: type: object properties: id: type: string format: uuid journeyId: type: - string - 'null' mainEntityId: type: - string - 'null' mainEntityType: type: - string - 'null' createdBy: type: - string - 'null' createdAt: type: string format: date-time draftedAt: type: - string - 'null' format: date-time status: type: - string - 'null' summary: type: - string - 'null' items: allOf: - $ref: '#/components/schemas/OutreachItemsDto' contacts: type: - array - 'null' items: $ref: '#/components/schemas/OutreachContactDto' outreachChannel: type: - string - 'null' message: allOf: - $ref: '#/components/schemas/OutreachMessageDto' additionalProperties: false description: Response DTO representing an outreach draft UpdateOutreachDraftDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/UpdateOutreachDraftDto' description: Request DTO for updating an outreach draft additionalProperties: false OutreachDocumentDto: type: object properties: documentRequirementName: type: - string - 'null' tooltip: type: - string - 'null' category: type: - string - 'null' dataKey: type: - string - 'null' additionalProperties: false NewOutreachDraftDto: type: object properties: journeyId: type: - string - 'null' description: The journey this outreach draft belongs to mainEntityId: type: - string - 'null' description: The main entity (client) this outreach draft targets additionalProperties: false description: Request DTO for initialising a new outreach draft EmailSendDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/EmailSendDto' description: Request DTO representing email send request additionalProperties: false EmailSendResponseDto: type: object properties: id: type: - string - 'null' description: Message Id in mailgun example: 20230104083737.750bcf084d35a5a2@testmail.fenergonebula.com message: type: - string - 'null' description: Message from mailgun example: Queued. Thank you. additionalProperties: false description: Response DTO representing email send response NewOutreachDraftDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/NewOutreachDraftDto' description: Request DTO for initialising a new outreach draft additionalProperties: false SendingDnsRecord: type: object properties: recordType: type: - string - 'null' name: type: - string - 'null' value: type: - string - 'null' additionalProperties: false description: DTO representing Sending Dns Record EmailDomainDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/EmailDomainDto' description: DTO representing email domain messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false EmailSendDto: type: object properties: to: type: - string - 'null' description: Email address of a receipient example: user.name@fenergo.com headerCc: type: - string - 'null' description: (optional) Email address added only to the visible Cc header without routing delivery example: header.cc.user@fenergo.com templateName: type: - string - 'null' description: Name of mailgun template example: journey-template variables: type: - object - 'null' additionalProperties: type: - string - 'null' description: Variables which will be passed to template example: Username: John Doe Logo: https://test-images.com/image domainId: type: - string - 'null' description: (optional) Domain Id of an email domain to be used for sending email. Defaults to domain identified by TenantId format: uuid additionalProperties: false description: Request DTO representing email send request PortalAccessEmailResponseDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/PortalAccessEmailResponseDto' description: Response DTO representing a portal access link email send response messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false ObjectServiceResponse: type: object properties: data: {} messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false StringServiceResponse: type: object properties: data: type: - string - 'null' messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false OutreachRelatedPartyDto: type: object properties: entityId: type: - string - 'null' entityDraftId: type: - string - 'null' entityType: type: - string - 'null' relationship: type: - string - 'null' items: allOf: - $ref: '#/components/schemas/OutreachItemsDto' additionalProperties: false NewEmailDomainDto: type: object properties: name: type: - string - 'null' description: Domain name example: testmail.fenergonebula.com useTenantIdAsDomainId: type: boolean description: Determines if Domain ID should be set to TenantId. True by default. additionalProperties: false description: Request DTO representing new email domain request OutreachDataGroupDto: type: object properties: dataGroupName: type: - string - 'null' tooltip: type: - string - 'null' category: type: - string - 'null' dataKey: type: - string - 'null' overallMinimumCount: type: - integer - 'null' format: int32 requiredTypesMinCount: type: - object - 'null' additionalProperties: type: integer format: int32 additionalProperties: false OutreachContactDto: type: object properties: fullName: type: - string - 'null' role: type: - string - 'null' selected: type: boolean additionalProperties: false PortalAccessEmailDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/PortalAccessEmailDto' description: Request DTO representing a portal access link email send request additionalProperties: false NewEmailDomainDtoServiceRequest: type: object properties: data: allOf: - $ref: '#/components/schemas/NewEmailDomainDto' description: Request DTO representing new email domain request additionalProperties: false ServiceResponseMessage: type: object properties: message: type: - string - 'null' type: type: - string - 'null' errorCode: type: - string - 'null' additionalProperties: false ReceivingDnsRecord: type: object properties: recordType: type: - string - 'null' value: type: - string - 'null' priority: type: - string - 'null' additionalProperties: false description: DTO representing Receiving Dns Record UpdateOutreachDraftDto: type: object properties: summary: type: - string - 'null' items: allOf: - $ref: '#/components/schemas/OutreachItemsDto' contacts: type: - array - 'null' items: $ref: '#/components/schemas/OutreachContactDto' outreachChannel: type: - string - 'null' message: allOf: - $ref: '#/components/schemas/OutreachMessageDto' additionalProperties: false description: Request DTO for updating an outreach draft OutreachMessageDto: type: object properties: messageSubject: type: - string - 'null' messageTemplate: type: - string - 'null' additionalProperties: false EmailDomainDto: type: object properties: id: type: - string - 'null' description: Domain Id format: uuid example: 118313c6-91e6-4b05-a537-5a1ab906418f name: type: - string - 'null' description: Domain name example: testmail.fenergonebula.com state: type: - string - 'null' description: Domain state according to mailgun example: verified enabled: type: boolean description: Determines if domain is enabled and can be used example: true receivingDnsRecords: type: - array - 'null' items: $ref: '#/components/schemas/ReceivingDnsRecord' description: Domain receiving DNS records from mailgun example: - priority: '10' record_type: MX valid: valid value: mxa.mailgun.org sendingDnsRecords: type: - array - 'null' items: $ref: '#/components/schemas/SendingDnsRecord' description: Domain sending DNS records from mailgun example: - record_type: TXT valid: valid name: domain.com value: v=spf1 include:mailgun.org ~all additionalProperties: false description: DTO representing email domain OutreachDraftDtoServiceResponse: type: object properties: data: allOf: - $ref: '#/components/schemas/OutreachDraftDto' description: Response DTO representing an outreach draft messages: type: - array - 'null' items: $ref: '#/components/schemas/ServiceResponseMessage' additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please insert JWT with Bearer into field name: Authorization in: header