crm

2.0info: 1.13.1 Campanhas description: Serviço responsável pelo módulo Campanhas do CRM. x-senior-domain: CRM x-senior-domain-path: crm x-senior-service-path: campaign contact: name: Senior X Platform url: https://dev.senior.com.br email: seniorx-dev@senior.com.brhost: api.senior.com.br /crm/campaignsecurityDefinitions: bearerAuth: type: apiKey in: header name: Authorization – application/json – application/jsonparameters: clientId: name: client_id type: string in: header required: true description: Identificação da aplicação cadastrada no portal do desenvolvedor (api.xplatform.com.br)paths: /confirmUploadFiles: post: description: Confirmará o upload dos arquivos x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – files properties: files: type: array items: #/definitions/urlUploadFileRecord description: Arquivos responses: 200: description: Ok schema: type: object required: – files properties: files: #/definitions/urlUploadFileRecord default: description: Error response schema: #/definitions/genericError /manageEmailMarketing: post: description: Gerenciar a criação/atualização de um emailMarketing x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/emailMarketingRecord responses: 200: description: Ok schema: type: object required: – name – status – campaignType – scheduling – targetAudienceType – senderOption – subject – body – messageType properties: custom: type: string description: Campos customizados id: type: string description: Id name: type: string description: Nome status: #/definitions/statusEnum campaignType: #/definitions/campaignType expectedRevenue: type: string description: Receita esperada expectedAnswer: type: number description: Resposta esperada estimatedCost: type: string description: Custo estimado realCost: type: string description: Custo real scheduling: type: string description: Agendamento note: type: string description: Observação targetAudienceType: #/definitions/targetAudienceTypeEnum senderOption: #/definitions/senderOptionEnum subject: type: string description: Assunto sender: type: string description: Remetente replyTo: type: string description: Responder para body: type: string description: Corpo do email filters: type: string description: Filtros negativeFilters: type: integer description: Negativa dos filtros cancellationReason: #/definitions/cancellationReason messageType: #/definitions/messageTypeEmailMarketingEnum template: #/definitions/templateEmailMarketing attachments: #/definitions/emailMarketingAttachment default: description: Error response schema: #/definitions/genericError /emailTest: post: description: Action referente ao email de teste x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – subject – content properties: subject: type: string description: Assunto content: type: string description: Conteúdo responses: 200: description: Ok schema: type: object required: – sent properties: sent: type: boolean description: Email enviado com sucesso ou não default: description: Error response schema: #/definitions/genericError /getUrlUploadFiles: post: description: Retornar a url do S3 para realizar o upload dos arquivos x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – files properties: files: type: array items: #/definitions/urlUploadFileRecord description: Arquivos responses: 200: description: Ok schema: type: object required: – files properties: files: #/definitions/urlUploadFileRecord default: description: Error response schema: #/definitions/genericError get: description: Retornar a url do S3 para realizar o upload dos arquivos x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – files properties: files: type: array items: #/definitions/urlUploadFileRecord description: Arquivos responses: 200: description: Ok schema: type: object required: – files properties: files: #/definitions/urlUploadFileRecord default: description: Error response schema: #/definitions/genericError /sendPlannedEmailsMarketing: post: description: Action assíncrona que inicia o processo dos envios de email dos Emails Marketing com o status atual como PLANNED x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId responses: 200: description: Ok schema: type: object required: – sendingStarted properties: sendingStarted: type: boolean description: Se começou o envio das campanhas default: description: Error response schema: #/definitions/genericError /getSmartMessage: post: description: Gerar mensagem inteligente x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – subject – objective properties: subject: type: string description: Assunto objective: type: string description: Objetivo responses: 200: description: Ok schema: type: object required: – generatedText properties: generatedText: type: string description: Texto gerado default: description: Error response schema: #/definitions/genericError get: description: Gerar mensagem inteligente x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – subject – objective properties: subject: type: string description: Assunto objective: type: string description: Objetivo responses: 200: description: Ok schema: type: object required: – generatedText properties: generatedText: type: string description: Texto gerado default: description: Error response schema: #/definitions/genericError /getUrlDownloadFiles: post: description: Retornar a url do S3 para realizar o download dos arquivos x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – files properties: files: type: array items: #/definitions/urlDownloadFilesRecord description: Arquivos responses: 200: description: Ok schema: type: object required: – files properties: files: #/definitions/urlDownloadFilesRecord default: description: Error response schema: #/definitions/genericError get: description: Retornar a url do S3 para realizar o download dos arquivos x-senior-event: false deprecated: false tags: – Endpoints security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: type: object required: – files properties: files: type: array items: #/definitions/urlDownloadFilesRecord description: Arquivos responses: 200: description: Ok schema: type: object required: – files properties: files: #/definitions/urlDownloadFilesRecord default: description: Error response schema: #/definitions/genericError /cancellationreasonCreated: post: description: Event of cancellationReason create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/cancellationReason responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /cancellationreasonDeleted: post: description: Event of cancellationReason delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/cancellationReason responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /cancellationreasonUpdated: post: description: Event of cancellationReason update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/cancellationReason responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /campaigntypeCreated: post: description: Event of campaignType create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/campaignType responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /campaigntypeDeleted: post: description: Event of campaignType delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/campaignType responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /campaigntypeUpdated: post: description: Event of campaignType update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/campaignType responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /emailmarketingCreated: post: description: Event of emailMarketing create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/emailMarketing responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /emailmarketingDeleted: post: description: Event of emailMarketing delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/emailMarketing responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /emailmarketingUpdated: post: description: Event of emailMarketing update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/emailMarketing responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /templateemailmarketingCreated: post: description: Event of templateEmailMarketing create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/templateEmailMarketing responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /templateemailmarketingDeleted: post: description: Event of templateEmailMarketing delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/templateEmailMarketing responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /templateemailmarketingUpdated: post: description: Event of templateEmailMarketing update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/templateEmailMarketing responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /emailmarketingattachmentCreated: post: description: Event of emailMarketingAttachment create x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/emailMarketingAttachment responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /emailmarketingattachmentDeleted: post: description: Event of emailMarketingAttachment delete x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/emailMarketingAttachment responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /emailmarketingattachmentUpdated: post: description: Event of emailMarketingAttachment update x-senior-event: true deprecated: false tags: – Events security: – bearerAuth: [] parameters: – #/parameters/clientId – name: input in: body required: true schema: #/definitions/emailMarketingAttachment responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/cancellationReason: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/cancellationReason responses: 200: description: The created resource schema: #/definitions/cancellationReason default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/cancellationReason responses: 200: description: The created resource schema: #/definitions/cancellationReason default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/cancellationReason default: description: Error response schema: #/definitions/genericError /entities/cancellationReason/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cancellationReason responses: 200: description: Ok schema: #/definitions/cancellationReason default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/cancellationReason responses: 200: description: Ok schema: #/definitions/cancellationReason default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/cancellationReason default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/cancellationReason/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/cancellationReason responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/emailMarketingAttachment: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/emailMarketingAttachment responses: 200: description: The created resource schema: #/definitions/emailMarketingAttachment default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/emailMarketingAttachment responses: 200: description: The created resource schema: #/definitions/emailMarketingAttachment default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/emailMarketingAttachment default: description: Error response schema: #/definitions/genericError /entities/emailMarketingAttachment/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/emailMarketingAttachment responses: 200: description: Ok schema: #/definitions/emailMarketingAttachment default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/emailMarketingAttachment responses: 200: description: Ok schema: #/definitions/emailMarketingAttachment default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/emailMarketingAttachment default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/emailMarketingAttachment/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/emailMarketingAttachment responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/templateEmailMarketing: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/templateEmailMarketing responses: 200: description: The created resource schema: #/definitions/templateEmailMarketing default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/templateEmailMarketing responses: 200: description: The created resource schema: #/definitions/templateEmailMarketing default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/templateEmailMarketing default: description: Error response schema: #/definitions/genericError /entities/templateEmailMarketing/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/templateEmailMarketing responses: 200: description: Ok schema: #/definitions/templateEmailMarketing default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/templateEmailMarketing responses: 200: description: Ok schema: #/definitions/templateEmailMarketing default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/templateEmailMarketing default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/templateEmailMarketing/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/templateEmailMarketing responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/emailMarketing: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/emailMarketing responses: 200: description: The created resource schema: #/definitions/emailMarketing default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/emailMarketing responses: 200: description: The created resource schema: #/definitions/emailMarketing default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/emailMarketing default: description: Error response schema: #/definitions/genericError /entities/emailMarketing/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/emailMarketing responses: 200: description: Ok schema: #/definitions/emailMarketing default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/emailMarketing responses: 200: description: Ok schema: #/definitions/emailMarketing default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/emailMarketing default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/emailMarketing/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/emailMarketing responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericError /entities/campaignType: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/campaignType responses: 200: description: The created resource schema: #/definitions/campaignType default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entity in: body required: true schema: #/definitions/campaignType responses: 200: description: The created resource schema: #/definitions/campaignType default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: offset in: query type: number – name: size in: query type: number responses: 200: description: The created resource schema: type: array items: #/definitions/campaignType default: description: Error response schema: #/definitions/genericError /entities/campaignType/{id}: put: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/campaignType responses: 200: description: Ok schema: #/definitions/campaignType default: description: Error response schema: #/definitions/genericError patch: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string – name: entity in: body required: true schema: #/definitions/campaignType responses: 200: description: Ok schema: #/definitions/campaignType default: description: Error response schema: #/definitions/genericError get: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok schema: #/definitions/campaignType default: description: Error response schema: #/definitions/genericError delete: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: id in: path required: true type: string responses: 200: description: Ok default: description: Error response schema: #/definitions/genericError /entities/campaignType/bulk: post: description: This entity is customizable. tags: – Entities security: – bearerAuth: [] parameters: – #/parameters/clientId – name: entities in: body required: true schema: type: array items: #/definitions/campaignType responses: 200: description: The bulk creation has created resources default: description: Error response schema: #/definitions/genericErrordefinitions: senderOptionEnum: type: string enum: – SMTP – RESPONSIBLE_ACCOUNT – MANUAL targetAudienceTypeEnum: type: string enum: – ACCOUNTS_AND_CONTACTS – ACCOUNTS_ONLY – ACCOUNT_CONTACTS_ONLY statusEnum: type: string enum: – DRAFT – PLANNED – PREPARING – IN_PROGRESS – FINISHED – CANCELED messageTypeEmailMarketingEnum: type: string enum: – TEXT – IMPORTED_HTML – TEMPLATE messageTypeTemplateEmailMarketingEnum: type: string enum: – TEXT – IMPORTED_HTML folderUploadEnum: type: string enum: – EMAIL_MARKETING_ATTACHMENT – EMAIL_MARKETING_BODY – EMAIL_MARKETING_TEMPLATE_BODY emailMarketingRecord: type: object required: – name – status – campaignType – scheduling – targetAudienceType – senderOption – subject – body – messageType properties: custom: type: string description: Campos customizados format: byte id: type: string description: Id name: type: string description: Nome status: #/definitions/statusEnum campaignType: #/definitions/campaignType expectedRevenue: type: string description: Receita esperada expectedAnswer: type: number description: Resposta esperada format: double estimatedCost: type: string description: Custo estimado realCost: type: string description: Custo real scheduling: type: string description: Agendamento format: date-time note: type: string description: Observação targetAudienceType: #/definitions/targetAudienceTypeEnum senderOption: #/definitions/senderOptionEnum subject: type: string description: Assunto sender: type: string description: Remetente replyTo: type: string description: Responder para body: type: string description: Corpo do email filters: type: array items: type: string description: Filtros negativeFilters: type: array items: type: integer description: Negativa dos filtros cancellationReason: #/definitions/cancellationReason messageType: #/definitions/messageTypeEmailMarketingEnum template: #/definitions/templateEmailMarketing attachments: type: array items: #/definitions/emailMarketingAttachment description: Anexos do Email Marketing campaignType: type: object properties: id: type: string description: format: uuid name: type: string description: Nome active: type: boolean description: Status cancellationReason: type: object properties: id: type: string description: format: uuid name: type: string description: Nome active: type: boolean description: Status templateEmailMarketing: type: object required: – name – body properties: id: type: string description: format: uuid name: type: string description: Nome body: type: string description: Corpo do template messageType: #/definitions/messageTypeTemplateEmailMarketingEnum active: type: boolean description: Status emailMarketingAttachment: type: object required: – fileName – size properties: id: type: string description: format: uuid fileName: type: string description: Nome do arquivo size: type: number description: Tamanho do Arquivo format: double emailMarketing: #/definitions/emailMarketing emailMarketing: type: object required: – name – status – campaignType – scheduling – targetAudienceType – senderOption – subject – body – messageType properties: id: type: string description: format: uuid name: type: string description: Nome status: #/definitions/statusEnum campaignType: #/definitions/campaignType expectedRevenue: type: string description: Receita esperada expectedAnswer: type: number description: Resposta esperada format: double estimatedCost: type: string description: Custo estimado realCost: type: string description: Custo real scheduling: type: string description: Agendamento format: date-time targetAudienceType: #/definitions/targetAudienceTypeEnum senderOption: #/definitions/senderOptionEnum note: type: string description: Observação subject: type: string description: Assunto sender: type: string description: Remetente replyTo: type: string description: Responder para body: type: string description: Corpo do email filters: type: string description: Filtros negativeFilters: type: string description: Negativa dos filtros amountTargetAudience: type: integer description: Quantidade de publico alvos relacionados cancellationReason: #/definitions/cancellationReason messageType: #/definitions/messageTypeEmailMarketingEnum template: #/definitions/templateEmailMarketing createdBy: type: string description: createdAt: type: string description: format: date-time changedBy: type: string description: changedAt: type: string description: format: date-time urlUploadFileRecord: type: object required: – fileName – folderName properties: fileName: type: string description: Nome do arquivo folderName: #/definitions/folderUploadEnum type: string description: Versão url: type: string description: URL urlDownloadFilesRecord: type: object required: – fileName – folderName properties: fileName: type: string description: Nome do arquivo folderName: #/definitions/folderUploadEnum type: string description: Versão url: type: string description: URL isDeleted: type: boolean description: Define se o arquivo foi excluído genericError: properties: message: type: string description: Messaging describing the error. reason: type: string description: A symbolic code identifying the category of the reason of the error. enum: – BAD_REQUEST – UNAUTHORIZED – PAYMENT_REQUIRED – FORBIDDEN – OBJECT_NOT_FOUND – REQUEST_TIMEOUT – GONE – UNPROCESSABLE – INTERNAL_ERROR – NOT_IMPLEMENTED – SERVICE_UNAVAILABLE – INSUFFICIENT_STORAGE