Saltar al contenido

Conecta ou altera a conta Resend da comunidade

PUT/api/email-provider

Auth
Requiere token
Quién puede:
owner
admin
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

Só owner e admin, plano Business ou acima (`email.ownProvider`; abaixo: 403 `emailProvider.planRequired`). Para conectar: `apiKey` (chave "só envio" restrita ao domínio é a recomendada), `fromEmail`, `fromName`, `acceptDataNotice: true` (os endereços dos membros passam a ir para a conta Resend da comunidade) e, antes de verificar, `webhookSecret`. A chave e o segredo entram uma vez e **não voltam** (só `last4`); toda troca vai para a auditoria. O remetente não pode ser de caixa gratuita (gmail, outlook…) nem da Memberfy (400 com `errors`). (Os exemplos usam `@memberfy.net` por convenção da documentação; no uso real o remetente é do domínio verificado na Resend da comunidade.) Trocar a chave ou o endereço do remetente volta o `status` para `pending` (verificar de novo); nome e `replyTo` mudam sem isso.

Headers

NombreTipoDescripción
X-CommunityIdopcionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Cuerpo de la solicitud application/json

NombreTipoDescripción
apiKeyopcionalstringChave de API da Resend (`re_…`). Obrigatória para conectar.
webhookSecretopcionalstringSegredo de assinatura do webhook da Resend (`whsec_…`).
fromEmailopcionalstring
fromNameopcionalstringmax 120
replyToopcionalstring
acceptDataNoticeopcionalbooleanObrigatório na primeira vez (versão atual do aviso).

Respuestas

CódigoDescripción
200A conexão (sem a chave e sem o segredo).
400Requisição inválida — falha de validação.
403Autenticado, mas sem permissão para esta operação.
422Falta aceitar o aviso de dados (`dataNoticeRequired`).

Ejemplo con curl

curl -X PUT "https://api.memberfy.net/api/email-provider" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'