Referencia de la API de Banger

Listar productos del espacio de trabajo

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 200

Respuesta correcta.

application/json

• valueobject
• dataarrayobligatorio
• Cada elementoobject
• idstringobligatorio

  format: "uuid"

• workspace_idstringobligatorio

  format: "uuid"

• namestringobligatorio
• slugstringobligatorio
• kindstringobligatorio

  enum: "product", "store", "brand", "newsletter", "company", "other"

• website_urlstring | nullobligatorio
• domainsarrayobligatorio
• Cada elementostring
• descriptionstringobligatorio
• contextobjectobligatorio
• Propiedad adicionalCualquier valor
• brandobjectobligatorio
• company_namestring

  maxLength: 160

• logo_urlstring

  El icono: el símbolo solo, en tamaño pequeño (pie de correo, formularios deslizantes) y como cabecera cuando no hay logotipo tipográfico.

  maxLength: 2000

• wordmark_urlstring

  El logotipo tipográfico: el nombre de la empresa tal como está diseñado, mostrado solo en la parte superior de cada correo.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstringobligatorio

  deleting: eliminado por una persona; restaurable hasta delete_after, después se elimina definitivamente.

  enum: "active", "archived", "deleting"

• delete_afterstring | null

  Cuándo se elimina definitivamente un producto en estado deleting.

  format: "date-time"

• is_defaultbooleanobligatorio
• route_readybooleanobligatorio
• setuparrayobligatorio
• Cada elementoobject
• keystringobligatorio

  enum: "context", "domain", "mailboxes", "journeys", "broadcasts", "compliance"

• statusstringobligatorio

  enum: "todo", "in_progress", "complete", "not_relevant"

• completion_sourcestring | nullobligatorio

  enum: "system", "person", "agent", null

• notestringobligatorio
• updated_atstring | nullobligatorio

  format: "date-time"

• created_atstringobligatorio

  format: "date-time"

• updated_atstringobligatorio

  format: "date-time"

Ejemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products' \
  --header "Authorization: Bearer $BANGER_API_KEY"

Crear un producto

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud obligatorio

application/json

• valueobject
• namestringobligatorio

  minLength: 1 · maxLength: 160

• kindstring

  default: "product" · enum: "product", "store", "brand", "newsletter", "company", "other"

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Propiedad adicionalCualquier valor
• domainsarray

  maxItems: 20

• Cada elementostring

  maxLength: 253

Respuesta correcta 201

Respuesta correcta.

application/json

• valueobject
• dataobjectobligatorio
• idstringobligatorio

  format: "uuid"

• workspace_idstringobligatorio

  format: "uuid"

• namestringobligatorio
• slugstringobligatorio
• kindstringobligatorio

  enum: "product", "store", "brand", "newsletter", "company", "other"

• website_urlstring | nullobligatorio
• domainsarrayobligatorio
• Cada elementostring
• descriptionstringobligatorio
• contextobjectobligatorio
• Propiedad adicionalCualquier valor
• brandobjectobligatorio
• company_namestring

  maxLength: 160

• logo_urlstring

  El icono: el símbolo solo, en tamaño pequeño (pie de correo, formularios deslizantes) y como cabecera cuando no hay logotipo tipográfico.

  maxLength: 2000

• wordmark_urlstring

  El logotipo tipográfico: el nombre de la empresa tal como está diseñado, mostrado solo en la parte superior de cada correo.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstringobligatorio

  deleting: eliminado por una persona; restaurable hasta delete_after, después se elimina definitivamente.

  enum: "active", "archived", "deleting"

• delete_afterstring | null

  Cuándo se elimina definitivamente un producto en estado deleting.

  format: "date-time"

• is_defaultbooleanobligatorio
• route_readybooleanobligatorio
• setuparrayobligatorio
• Cada elementoobject
• keystringobligatorio

  enum: "context", "domain", "mailboxes", "journeys", "broadcasts", "compliance"

• statusstringobligatorio

  enum: "todo", "in_progress", "complete", "not_relevant"

• completion_sourcestring | nullobligatorio

  enum: "system", "person", "agent", null

• notestringobligatorio
• updated_atstring | nullobligatorio

  format: "date-time"

• created_atstringobligatorio

  format: "date-time"

• updated_atstringobligatorio

  format: "date-time"

Ejemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "name": "example",
  "kind": "product",
  "website_url": "example",
  "description": "example",
  "context": {},
  "domains": [
    "example"
  ]
}'

Obtener un producto

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 200

Respuesta correcta.

application/json

• valueobject
• dataobjectobligatorio
• idstringobligatorio

  format: "uuid"

• workspace_idstringobligatorio

  format: "uuid"

• namestringobligatorio
• slugstringobligatorio
• kindstringobligatorio

  enum: "product", "store", "brand", "newsletter", "company", "other"

• website_urlstring | nullobligatorio
• domainsarrayobligatorio
• Cada elementostring
• descriptionstringobligatorio
• contextobjectobligatorio
• Propiedad adicionalCualquier valor
• brandobjectobligatorio
• company_namestring

  maxLength: 160

• logo_urlstring

  El icono: el símbolo solo, en tamaño pequeño (pie de correo, formularios deslizantes) y como cabecera cuando no hay logotipo tipográfico.

  maxLength: 2000

• wordmark_urlstring

  El logotipo tipográfico: el nombre de la empresa tal como está diseñado, mostrado solo en la parte superior de cada correo.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstringobligatorio

  deleting: eliminado por una persona; restaurable hasta delete_after, después se elimina definitivamente.

  enum: "active", "archived", "deleting"

• delete_afterstring | null

  Cuándo se elimina definitivamente un producto en estado deleting.

  format: "date-time"

• is_defaultbooleanobligatorio
• route_readybooleanobligatorio
• setuparrayobligatorio
• Cada elementoobject
• keystringobligatorio

  enum: "context", "domain", "mailboxes", "journeys", "broadcasts", "compliance"

• statusstringobligatorio

  enum: "todo", "in_progress", "complete", "not_relevant"

• completion_sourcestring | nullobligatorio

  enum: "system", "person", "agent", null

• notestringobligatorio
• updated_atstring | nullobligatorio

  format: "date-time"

• created_atstringobligatorio

  format: "date-time"

• updated_atstringobligatorio

  format: "date-time"

Ejemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

Actualizar un producto

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud obligatorio

application/json

• valueobject
• namestring

  maxLength: 160

• kindstring

  enum: "product", "store", "brand", "newsletter", "company", "other"

• website_urlstring | null

  maxLength: 2000

• descriptionstring

  maxLength: 4000

• contextobject
• Propiedad adicionalCualquier valor
• brandobject
• company_namestring

  maxLength: 160

• logo_urlstring

  El icono: el símbolo solo, en tamaño pequeño (pie de correo, formularios deslizantes) y como cabecera cuando no hay logotipo tipográfico.

  maxLength: 2000

• wordmark_urlstring

  El logotipo tipográfico: el nombre de la empresa tal como está diseñado, mostrado solo en la parte superior de cada correo.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstring

  enum: "active", "archived"

Respuesta correcta 200

Respuesta correcta.

application/json

• valueobject
• dataobjectobligatorio
• idstringobligatorio

  format: "uuid"

• workspace_idstringobligatorio

  format: "uuid"

• namestringobligatorio
• slugstringobligatorio
• kindstringobligatorio

  enum: "product", "store", "brand", "newsletter", "company", "other"

• website_urlstring | nullobligatorio
• domainsarrayobligatorio
• Cada elementostring
• descriptionstringobligatorio
• contextobjectobligatorio
• Propiedad adicionalCualquier valor
• brandobjectobligatorio
• company_namestring

  maxLength: 160

• logo_urlstring

  El icono: el símbolo solo, en tamaño pequeño (pie de correo, formularios deslizantes) y como cabecera cuando no hay logotipo tipográfico.

  maxLength: 2000

• wordmark_urlstring

  El logotipo tipográfico: el nombre de la empresa tal como está diseñado, mostrado solo en la parte superior de cada correo.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstringobligatorio

  deleting: eliminado por una persona; restaurable hasta delete_after, después se elimina definitivamente.

  enum: "active", "archived", "deleting"

• delete_afterstring | null

  Cuándo se elimina definitivamente un producto en estado deleting.

  format: "date-time"

• is_defaultbooleanobligatorio
• route_readybooleanobligatorio
• setuparrayobligatorio
• Cada elementoobject
• keystringobligatorio

  enum: "context", "domain", "mailboxes", "journeys", "broadcasts", "compliance"

• statusstringobligatorio

  enum: "todo", "in_progress", "complete", "not_relevant"

• completion_sourcestring | nullobligatorio

  enum: "system", "person", "agent", null

• notestringobligatorio
• updated_atstring | nullobligatorio

  format: "date-time"

• created_atstringobligatorio

  format: "date-time"

• updated_atstringobligatorio

  format: "date-time"

Ejemplo de curl

curl --request PATCH --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "name": "example",
  "kind": "product",
  "website_url": "example",
  "description": "example",
  "context": {},
  "brand": {
    "company_name": "example",
    "logo_url": "example",
    "wordmark_url": "example",
    "website_url": "example",
    "primary_color": "example",
    "accent_color": "example",
    "background_color": "example",
    "surface_color": "example",
    "text_color": "example",
    "muted_text_color": "example",
    "heading_font_family": "example",
    "body_font_family": "example",
    "tone": "example",
    "footer_address": "example",
    "email_style": "example"
  },
  "status": "active"
}'

Elimina un producto (un proyecto en la aplicación) tras revisar la vista previa de eliminación. Deja de usarse de inmediato (se detiene su envío) y puede restaurarse durante 24 horas; después Banger elimina sus dominios de envío y todas las filas que le pertenecen. No se puede eliminar el último producto activo del espacio de trabajo. Requiere administrador del espacio de trabajo y una sesión iniciada; se rechazan las claves de API y las autorizaciones OAuth.

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud obligatorio

application/json

• valueobject

  Sin propiedades adicionales

• confirm_namestringobligatorio

  El nombre exacto del producto.

  minLength: 1 · maxLength: 160

• preview_tokenstringobligatorio

  minLength: 64 · maxLength: 64

Respuesta correcta 202

El producto está fuera de uso y se elimina definitivamente en delete_after si no se restaura antes. Una repetición idempotente devuelve el mismo resultado.

application/json

• valueobject
• dataobjectobligatorio
• idstringobligatorio

  format: "uuid"

• namestringobligatorio
• statusstringobligatorio

  enum: "deleting"

• delete_afterstringobligatorio

  Cuándo se elimina definitivamente el producto; hasta entonces se puede restaurar.

  format: "date-time"

• next_product_idstringobligatorio

  El producto predeterminado actual del espacio de trabajo.

  format: "uuid"

• replayedboolean

Ejemplo de curl

curl --request DELETE --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "confirm_name": "example",
  "preview_token": "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}'

Previsualiza la eliminación de un producto y todo lo que le pertenece, sin eliminar nada. Requiere administrador del espacio de trabajo, con sesión iniciada o mediante OAuth autorizado por el usuario.

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 200

Lo que la eliminación del producto elimina y detiene.

application/json

• valueobject
• dataobjectobligatorio
• productobjectobligatorio
• idstringobligatorio

  format: "uuid"

• namestringobligatorio
• is_defaultbooleanobligatorio
• next_default_productno especificadoobligatorio

  El producto que pasa a ser predeterminado del espacio de trabajo al eliminar el predeterminado.

• oneOf 1null
• oneOf 2object
• idstringobligatorio

  format: "uuid"

• namestringobligatorio
• last_productbooleanobligatorio

  No se puede eliminar el único producto activo.

• mailboxesarrayobligatorio
• Cada elementoobject
• idstringobligatorio

  format: "uuid"

• addressstringobligatorio
• domainsarrayobligatorio

  Dominios de envío que Banger elimina al terminar el plazo de restauración.

• Cada elementoobject
• idstringobligatorio

  format: "uuid"

• domainstringobligatorio
• journeysintegerobligatorio
• broadcastsintegerobligatorio
• signup_formsintegerobligatorio
• contactsintegerobligatorio
• api_keysintegerobligatorio
• webhooksintegerobligatorio
• pending_sendsintegerobligatorio
• impactarrayobligatorio
• Cada elementostring
• preview_tokenstringobligatorio

Ejemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}/deletion-preview' \
  --header "Authorization: Bearer $BANGER_API_KEY"

Restaura un producto eliminado antes de su delete_after. Se reactivan sus buzones, Jornadas, formularios de registro, webhooks e integraciones; las Campañas siguen pausadas. Requiere administrador del espacio de trabajo, con sesión iniciada o mediante OAuth autorizado por el usuario.

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 200

El producto vuelve a estar activo.

application/json

• valueobject
• dataobjectobligatorio
• idstringobligatorio

  format: "uuid"

• namestringobligatorio
• statusstringobligatorio

  enum: "active"

Ejemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}/restore' \
  --header "Authorization: Bearer $BANGER_API_KEY"

Actualizar un elemento de configuración del producto

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud obligatorio

application/json

• valueobject
• statusstringobligatorio

  enum: "todo", "in_progress", "complete", "not_relevant"

• completion_sourcestring

  default: "person" · enum: "system", "person", "agent"

• notestring

  maxLength: 1000

Respuesta correcta 200

Respuesta correcta.

application/json

• valueobject
• dataobjectobligatorio
• keystringobligatorio

  enum: "context", "domain", "mailboxes", "journeys", "broadcasts", "compliance"

• statusstringobligatorio

  enum: "todo", "in_progress", "complete", "not_relevant"

• completion_sourcestring | nullobligatorio

  enum: "system", "person", "agent", null

• notestringobligatorio
• updated_atstring | nullobligatorio

  format: "date-time"

Ejemplo de curl

curl --request PUT --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}/setup/{key}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "status": "todo",
  "completion_source": "person",
  "note": "example"
}'

Asociar un dominio a un producto

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud obligatorio

application/json

• valueobject
• domainstringobligatorio

  minLength: 3 · maxLength: 253

Respuesta correcta 201

Respuesta correcta.

application/json

• valueobject
• dataobjectobligatorio
• idstringobligatorio

  format: "uuid"

• workspace_idstringobligatorio

  format: "uuid"

• namestringobligatorio
• slugstringobligatorio
• kindstringobligatorio

  enum: "product", "store", "brand", "newsletter", "company", "other"

• website_urlstring | nullobligatorio
• domainsarrayobligatorio
• Cada elementostring
• descriptionstringobligatorio
• contextobjectobligatorio
• Propiedad adicionalCualquier valor
• brandobjectobligatorio
• company_namestring

  maxLength: 160

• logo_urlstring

  El icono: el símbolo solo, en tamaño pequeño (pie de correo, formularios deslizantes) y como cabecera cuando no hay logotipo tipográfico.

  maxLength: 2000

• wordmark_urlstring

  El logotipo tipográfico: el nombre de la empresa tal como está diseñado, mostrado solo en la parte superior de cada correo.

  maxLength: 2000

• website_urlstring

  maxLength: 2000

• primary_colorstring

  maxLength: 7

• accent_colorstring

  maxLength: 7

• background_colorstring

  maxLength: 7

• surface_colorstring

  maxLength: 7

• text_colorstring

  maxLength: 7

• muted_text_colorstring

  maxLength: 7

• heading_font_familystring

  maxLength: 200

• body_font_familystring

  maxLength: 200

• tonestring

  maxLength: 1000

• footer_addressstring

  maxLength: 500

• email_stylestring

  maxLength: 20

• statusstringobligatorio

  deleting: eliminado por una persona; restaurable hasta delete_after, después se elimina definitivamente.

  enum: "active", "archived", "deleting"

• delete_afterstring | null

  Cuándo se elimina definitivamente un producto en estado deleting.

  format: "date-time"

• is_defaultbooleanobligatorio
• route_readybooleanobligatorio
• setuparrayobligatorio
• Cada elementoobject
• keystringobligatorio

  enum: "context", "domain", "mailboxes", "journeys", "broadcasts", "compliance"

• statusstringobligatorio

  enum: "todo", "in_progress", "complete", "not_relevant"

• completion_sourcestring | nullobligatorio

  enum: "system", "person", "agent", null

• notestringobligatorio
• updated_atstring | nullobligatorio

  format: "date-time"

• created_atstringobligatorio

  format: "date-time"

• updated_atstringobligatorio

  format: "date-time"

Ejemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/products/{productId}/domains' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "domain": "example"
}'

listMailboxes

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 200

Buzones visibles para el actor.

application/json

• valueobject
• dataarrayobligatorio
• Cada elementoobject
• idstringobligatorio

  format: "uuid"

• workspace_idstringobligatorio

  format: "uuid"

• product_idstring | null

  El producto (proyecto) al que pertenece el buzón. Los clientes lo usan para agrupar buzones y crear enlaces a la aplicación web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobligatorio

  format: "email"

• display_namestringobligatorio
• providerstringobligatorio

  enum: "gmail", "smtp"

• statusstringobligatorio

  enum: "pending", "active", "suspended", "reconnect_required", "disabled"

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobligatorio

  enum: "domain", "starter"

Ejemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes' \
  --header "Authorization: Bearer $BANGER_API_KEY"

Crea un buzón de trabajo nativo de Banger en un dominio de envío del espacio de trabajo.

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud obligatorio

application/json

• valueobject

  Sin propiedades adicionales

• domain_idstringobligatorio

  format: "uuid"

• local_partstringobligatorio

  minLength: 1 · maxLength: 64

• display_namestring

  maxLength: 200

Respuesta correcta 200

Repetición idempotente de la creación de un buzón nativo.

application/json

• valueobject
• dataobjectobligatorio
• idstringobligatorio

  format: "uuid"

• workspace_idstringobligatorio

  format: "uuid"

• product_idstring | null

  El producto (proyecto) al que pertenece el buzón. Los clientes lo usan para agrupar buzones y crear enlaces a la aplicación web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobligatorio

  format: "email"

• display_namestringobligatorio
• providerstringobligatorio

  enum: "gmail", "smtp"

• statusstringobligatorio

  enum: "pending", "active", "suspended", "reconnect_required", "disabled"

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobligatorio

  enum: "domain", "starter"

Ejemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "domain_id": "00000000-0000-4000-8000-000000000001",
  "local_part": "example",
  "display_name": "example"
}'

Previsualiza la eliminación permanente de un buzón y los flujos de envío dependientes. Requiere administrador del espacio de trabajo y ámbito del producto.

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 200

Buzón exacto e impacto actual de la eliminación, sin eliminar nada.

application/json

• valueobject
• dataobjectobligatorio
• mailboxobjectobligatorio
• idstringobligatorio

  format: "uuid"

• addressstringobligatorio
• providerstringobligatorio
• domain_idstring | nullobligatorio

  format: "uuid"

• provider_connection_idstring | nullobligatorio

  format: "uuid"

• messagesintegerobligatorio
• draftsintegerobligatorio
• pending_sendsintegerobligatorio
• broadcastsarrayobligatorio
• Cada elementoobject
• idstringobligatorio

  format: "uuid"

• namestringobligatorio
• statusstringobligatorio
• journeysarrayobligatorio
• Cada elementoobject
• idstringobligatorio

  format: "uuid"

• namestringobligatorio
• statusstringobligatorio
• signup_formsarrayobligatorio
• Cada elementoobject
• idstringobligatorio

  format: "uuid"

• namestringobligatorio
• statusstringobligatorio
• impactarrayobligatorio
• Cada elementostring
• preview_tokenstringobligatorio

Ejemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes/{mailboxId}/deletion-preview' \
  --header "Authorization: Bearer $BANGER_API_KEY"

Define el nombre de remitente que ven los destinatarios en los correos de un buzón de Banger ("Name <address>"). Los buzones de Gmail conservan el nombre definido en Gmail. Requiere administrador del espacio de trabajo.

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud obligatorio

application/json

• valueobject

  Sin propiedades adicionales

• display_namestringobligatorio

  Una línea. Vacío envía solo la dirección.

  maxLength: 200

Respuesta correcta 200

El buzón con su nombre de remitente.

application/json

• valueobject
• dataobjectobligatorio
• idstringobligatorio

  format: "uuid"

• workspace_idstringobligatorio

  format: "uuid"

• product_idstring | null

  El producto (proyecto) al que pertenece el buzón. Los clientes lo usan para agrupar buzones y crear enlaces a la aplicación web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobligatorio

  format: "email"

• display_namestringobligatorio
• providerstringobligatorio

  enum: "gmail", "smtp"

• statusstringobligatorio

  enum: "pending", "active", "suspended", "reconnect_required", "disabled"

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobligatorio

  enum: "domain", "starter"

Ejemplo de curl

curl --request PATCH --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes/{mailboxId}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "display_name": "example"
}'

Elimina permanentemente un buzón conservando su dominio y los demás buzones. Requiere administrador del espacio de trabajo y ámbito del producto.

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud obligatorio

application/json

• valueobject

  Sin propiedades adicionales

• confirm_addressstringobligatorio

  minLength: 3 · maxLength: 320

• preview_tokenstringobligatorio

  minLength: 64 · maxLength: 64

Respuesta correcta 200

Eliminado o repetición idempotente. Los archivos almacenados se ponen en cola para su limpieza permanente.

application/json

• valueobject
• dataobjectobligatorio
• idstringobligatorio

  format: "uuid"

• addressstringobligatorio
• deletedbooleanobligatorio
• replayedboolean

Ejemplo de curl

curl --request DELETE --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes/{mailboxId}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "confirm_address": "example",
  "preview_token": "examplexxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}'

Crea un buzón alojado restringido a bandejas alojadas del mismo producto y al destinatario de registro del espacio de trabajo.

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud obligatorio

application/json

• valueobject

  Sin propiedades adicionales

• create_newboolean

  Crea un buzón alojado adicional en lugar de reanudar el inicial.

• local_partstring

  Nombre antes de @bangermail.com. Sin él, el buzón recibe un nombre formado por palabras como quiet-maple-harbor.

  minLength: 3 · maxLength: 40

• display_namestring

  maxLength: 200

Respuesta correcta 200

Repetición idempotente de la creación de una identidad inicial.

application/json

• valueobject
• dataobjectobligatorio
• idstringobligatorio

  format: "uuid"

• workspace_idstringobligatorio

  format: "uuid"

• product_idstring | null

  El producto (proyecto) al que pertenece el buzón. Los clientes lo usan para agrupar buzones y crear enlaces a la aplicación web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobligatorio

  format: "email"

• display_namestringobligatorio
• providerstringobligatorio

  enum: "gmail", "smtp"

• statusstringobligatorio

  enum: "pending", "active", "suspended", "reconnect_required", "disabled"

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobligatorio

  enum: "domain", "starter"

Ejemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes/starter' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "create_new": true,
  "local_part": "example",
  "display_name": "example"
}'

Levanta la pausa por reputación del remitente de un buzón, según las reglas de reanudación autoservicio de resumeSending.

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud obligatorio

application/json

• valueobject

  Sin propiedades adicionales

• acknowledge_recipient_complaintbooleanobligatorio

  const: true

• reasonstring

  Por qué se restablece el envío; se registra en el registro de auditoría.

  maxLength: 500

Respuesta correcta 200

Buzón reactivado o ya activo tras una solicitud anterior correcta.

application/json

• valueobject
• dataobjectobligatorio
• idstringobligatorio

  format: "uuid"

• workspace_idstringobligatorio

  format: "uuid"

• product_idstring | null

  El producto (proyecto) al que pertenece el buzón. Los clientes lo usan para agrupar buzones y crear enlaces a la aplicación web.

  format: "uuid"

• domain_idstring | null

  format: "uuid"

• addressstringobligatorio

  format: "email"

• display_namestringobligatorio
• providerstringobligatorio

  enum: "gmail", "smtp"

• statusstringobligatorio

  enum: "pending", "active", "suspended", "reconnect_required", "disabled"

• status_reasonstring | null
• suspended_atstring | null
• mailbox_kindstringobligatorio

  enum: "domain", "starter"

Ejemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/mailboxes/{mailboxId}/reactivate' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "acknowledge_recipient_complaint": true,
  "reason": "example"
}'

listDrafts

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 200

Respuesta correcta.

application/json

• valueobject
• dataarrayobligatorio
• Cada elementoobject
• idstringobligatorio

  format: "uuid"

• mailbox_idstringobligatorio

  format: "uuid"

• thread_idstring | nullobligatorio

  format: "uuid"

• versionintegerobligatorio
• toarrayobligatorio
• Cada elementoobject
• emailstringobligatorio
• namestring
• ccarrayobligatorio
• Cada elementoobject
• emailstringobligatorio
• namestring
• bccarrayobligatorio
• Cada elementoobject
• emailstringobligatorio
• namestring
• subjectstringobligatorio
• body_textstringobligatorio
• statusstringobligatorio
• created_atstringobligatorio

  format: "date-time"

• updated_atstringobligatorio

  format: "date-time"

• attachmentsarrayobligatorio
• Cada elementoobject
• idstringobligatorio

  format: "uuid"

• filenamestringobligatorio
• content_typestringobligatorio
• size_bytesintegerobligatorio
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Ejemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts?mailbox_id=00000000-0000-4000-8000-000000000001' \
  --header "Authorization: Bearer $BANGER_API_KEY"

createDraft

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud obligatorio

application/json

• valueobject

  Sin propiedades adicionales

• mailbox_idstringobligatorio

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Cada elementoobject
• namestring
• emailstringobligatorio

  format: "email"

• ccarray

  maxItems: 500

• Cada elementoobject
• namestring
• emailstringobligatorio

  format: "email"

• bccarray

  maxItems: 500

• Cada elementoobject
• namestring
• emailstringobligatorio

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

Respuesta correcta 201

Respuesta correcta.

application/json

• valueobject
• dataobjectobligatorio
• idstringobligatorio

  format: "uuid"

• mailbox_idstringobligatorio

  format: "uuid"

• thread_idstring | nullobligatorio

  format: "uuid"

• versionintegerobligatorio
• toarrayobligatorio
• Cada elementoobject
• emailstringobligatorio
• namestring
• ccarrayobligatorio
• Cada elementoobject
• emailstringobligatorio
• namestring
• bccarrayobligatorio
• Cada elementoobject
• emailstringobligatorio
• namestring
• subjectstringobligatorio
• body_textstringobligatorio
• statusstringobligatorio
• created_atstringobligatorio

  format: "date-time"

• updated_atstringobligatorio

  format: "date-time"

• attachmentsarrayobligatorio
• Cada elementoobject
• idstringobligatorio

  format: "uuid"

• filenamestringobligatorio
• content_typestringobligatorio
• size_bytesintegerobligatorio
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Ejemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "mailbox_id": "00000000-0000-4000-8000-000000000001",
  "thread_id": "00000000-0000-4000-8000-000000000001",
  "to": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "cc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "bcc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "subject": "example",
  "body_text": "example",
  "body_html": "example"
}'

getDraft

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 200

Rendimiento, estado e incidentes de entregabilidad canónicos.

application/json

• valueobject
• dataobjectobligatorio
• idstringobligatorio

  format: "uuid"

• mailbox_idstringobligatorio

  format: "uuid"

• thread_idstring | nullobligatorio

  format: "uuid"

• versionintegerobligatorio
• toarrayobligatorio
• Cada elementoobject
• emailstringobligatorio
• namestring
• ccarrayobligatorio
• Cada elementoobject
• emailstringobligatorio
• namestring
• bccarrayobligatorio
• Cada elementoobject
• emailstringobligatorio
• namestring
• subjectstringobligatorio
• body_textstringobligatorio
• statusstringobligatorio
• created_atstringobligatorio

  format: "date-time"

• updated_atstringobligatorio

  format: "date-time"

• attachmentsarrayobligatorio
• Cada elementoobject
• idstringobligatorio

  format: "uuid"

• filenamestringobligatorio
• content_typestringobligatorio
• size_bytesintegerobligatorio
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Ejemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

updateDraft

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud obligatorio

application/json

• valueno especificado
• allOf 1object

  Sin propiedades adicionales

• mailbox_idstringobligatorio

  format: "uuid"

• thread_idstring

  format: "uuid"

• toarray

  maxItems: 500

• Cada elementoobject
• namestring
• emailstringobligatorio

  format: "email"

• ccarray

  maxItems: 500

• Cada elementoobject
• namestring
• emailstringobligatorio

  format: "email"

• bccarray

  maxItems: 500

• Cada elementoobject
• namestring
• emailstringobligatorio

  format: "email"

• subjectstring

  maxLength: 10000

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• allOf 2object
• versionintegerobligatorio

  minimum: 1

Respuesta correcta 200

Respuesta correcta.

application/json

• valueobject
• dataobjectobligatorio
• idstringobligatorio

  format: "uuid"

• mailbox_idstringobligatorio

  format: "uuid"

• thread_idstring | nullobligatorio

  format: "uuid"

• versionintegerobligatorio
• toarrayobligatorio
• Cada elementoobject
• emailstringobligatorio
• namestring
• ccarrayobligatorio
• Cada elementoobject
• emailstringobligatorio
• namestring
• bccarrayobligatorio
• Cada elementoobject
• emailstringobligatorio
• namestring
• subjectstringobligatorio
• body_textstringobligatorio
• statusstringobligatorio
• created_atstringobligatorio

  format: "date-time"

• updated_atstringobligatorio

  format: "date-time"

• attachmentsarrayobligatorio
• Cada elementoobject
• idstringobligatorio

  format: "uuid"

• filenamestringobligatorio
• content_typestringobligatorio
• size_bytesintegerobligatorio
• sha256string
• created_atstring

  format: "date-time"

• body_html_urlstring

  format: "uri"

Ejemplo de curl

curl --request PUT --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "mailbox_id": "00000000-0000-4000-8000-000000000001",
  "thread_id": "00000000-0000-4000-8000-000000000001",
  "to": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "cc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "bcc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "subject": "example",
  "body_text": "example",
  "body_html": "example",
  "version": 1
}'

deleteDraft

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 204

Borrador y objetos referenciados programados para eliminación.

Sin cuerpo de respuesta.

Ejemplo de curl

curl --request DELETE --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

sendDraft

Envía el borrador desde su buzón, al que debe tener acceso quien llama. Si sus envíos requieren aprobación, recibe una aprobación pendiente; decide una persona que podría enviar el borrador directamente.

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 202

El envío está en cola o espera aprobación.

application/json

• valueobject
• datano especificadoobligatorio
• oneOf 1object
• idstringobligatorio

  format: "uuid"

• typestringobligatorio
• statusstringobligatorio

  enum: "accepted", "executing", "succeeded", "failed"

• workspace_revisionintegerobligatorio

  format: "int64"

• created_atstringobligatorio

  format: "date-time"

• oneOf 2object

  Sin propiedades adicionales

• approvalobjectobligatorio
• idstringobligatorio

  format: "uuid"

• requested_by_actor_idstringobligatorio
• action_kindstringobligatorio
• summarystringobligatorio
• capability_scopesarrayobligatorio
• Cada elementostring
• resource_scopeobjectobligatorio
• Propiedad adicionalarray
• Cada elementostring

  Se omiten niveles anidados adicionales

• payloadobjectobligatorio
• Propiedad adicionalCualquier valor
• payload_sha256stringobligatorio

  pattern: "^[0-9a-f]{64}$"

• statusstringobligatorio

  enum: "pending", "approved", "rejected", "cancelled", "expired"

• missedbooleanobligatorio
• expires_atstringobligatorio

  format: "date-time"

• decided_by_actor_idstring | null
• decision_reasonstring | null
• created_atstringobligatorio

  format: "date-time"

• updated_atstringobligatorio

  format: "date-time"

• decided_atstring | null

  format: "date-time"

• execution_job_idstring

  format: "uuid"

• reviewobject

  Sin propiedades adicionales

• dispositionstringobligatorio

  enum: "automatic", "human_required"

• recipient_countinteger | nullobligatorio

  minimum: 0

• reasonsarrayobligatorio
• Cada elementostring

  Se omiten niveles anidados adicionales

• checksarrayobligatorio
• Cada elementostring

  Se omiten niveles anidados adicionales

Ejemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}/send' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx'

uploadDraftAttachment

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud obligatorio

application/octet-stream

• valuestring

  format: "binary" · maxLength: 26214400

Respuesta correcta 201

Respuesta correcta.

application/json

• valueobject
• dataobjectobligatorio
• idstringobligatorio

  format: "uuid"

• filenamestringobligatorio
• content_typestringobligatorio
• size_bytesintegerobligatorio
• sha256string
• created_atstring

  format: "date-time"

Ejemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}/attachments' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'X-Banger-Filename: example' \
  --header 'Content-Type: application/octet-stream' \
  --data-binary @request-body

deleteDraftAttachment

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 204

Adjunto programado para eliminación en B2 teniendo en cuenta las versiones.

Sin cuerpo de respuesta.

Ejemplo de curl

curl --request DELETE --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}/attachments/{attachmentId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

Leer el cuerpo HTML de un borrador

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 200

HTML del borrador.

text/html

• valuestring

Ejemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/drafts/{draftId}/html' \
  --header "Authorization: Bearer $BANGER_API_KEY"

listSendIntents

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 200

Envíos canónicos recientes y su estado en el proveedor.

application/json

• valueobject
• dataarrayobligatorio
• Cada elementoobject

  Sin propiedades adicionales

• idstringobligatorio

  format: "uuid"

• statusstringobligatorio

  enum: "accepted", "scheduled", "queued", "executing", "partially_succeeded", "succeeded", "failed", "canceled"

• traffic_classstringobligatorio

  enum: "mailbox", "product", "broadcast"

• recipient_countintegerobligatorio

  minimum: 1

• provider_keystringobligatorio
• provider_statestringobligatorio

  enum: "pending", "leased", "submitted", "accepted", "ambiguous", "reconciling", "succeeded", "failed", "canceled"

• provider_message_idstring | null
• error_codestring | null
• created_atstringobligatorio

  format: "date-time"

• updated_atstringobligatorio

  format: "date-time"

• completed_atstring | null

  format: "date-time"

Ejemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/send-intents?limit=50' \
  --header "Authorization: Bearer $BANGER_API_KEY"

getSendIntent

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 200

Estado canónico del envío asíncrono.

application/json

• valueobject
• dataobjectobligatorio

  Sin propiedades adicionales

• idstringobligatorio

  format: "uuid"

• statusstringobligatorio

  enum: "accepted", "scheduled", "queued", "executing", "partially_succeeded", "succeeded", "failed", "canceled"

• traffic_classstringobligatorio

  enum: "mailbox", "product", "broadcast"

• recipient_countintegerobligatorio

  minimum: 1

• provider_keystringobligatorio
• provider_statestringobligatorio

  enum: "pending", "leased", "submitted", "accepted", "ambiguous", "reconciling", "succeeded", "failed", "canceled"

• provider_message_idstring | null
• error_codestring | null
• created_atstringobligatorio

  format: "date-time"

• updated_atstringobligatorio

  format: "date-time"

• completed_atstring | null

  format: "date-time"

Ejemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/send-intents/{sendIntentId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

listTransactionalSends

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 200

Respuesta correcta.

application/json

• valueobject
• dataarrayobligatorio
• Cada elementoobject
• idstringobligatorio

  format: "uuid"

• mailbox_idstring | nullobligatorio

  format: "uuid"

• command_idstring | nullobligatorio

  format: "uuid"

• statusstringobligatorio
• command_statusstring | nullobligatorio
• subjectstring
• recipientsarray
• Cada elementoobject
• emailstringobligatorio
• namestring
• recipient_countintegerobligatorio
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Propiedad adicionalinteger
• provider_message_idstring | null
• languageno especificado

  El idioma en que se envió este correo; null si no se tradujo.

• anyOf 1object

  El idioma en que una persona recibió un correo. Solo lo tienen los correos traducidos (de contenido gestionado).

• localestringobligatorio

  Etiqueta BCP 47 del idioma en que se escribió el correo.

• requested_localestring

  Solo presente en un envío antiguo que salió en otro idioma: el idioma que la persona debería haber recibido.

• fallback_reasonstring

  enum: "translation_missing", "translation_pending", "translation_review_required", "translation_failed", "translation_timeout"

• anyOf 2null
• journeyobject | null

  El paso y la inscripción de la Jornada que enviaron este correo; null para otros envíos.

• journey_idstringobligatorio

  format: "uuid"

• step_idstringobligatorio

  format: "uuid"

• enrollment_idstringobligatorio

  format: "uuid"

• experimentobject | null

  La variante del experimento de este correo; null si no se aplicó ninguna.

• experiment_idstringobligatorio

  format: "uuid"

• variant_keystringobligatorio
• created_atstringobligatorio

  format: "date-time"

• updated_atstringobligatorio

  format: "date-time"

• completed_atstring | nullobligatorio

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Propiedad adicionalCualquier valor
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Cada elementoobject
• emailstringobligatorio
• namestring
• headersobject
• Propiedad adicionalstring
• tagsarray
• Cada elementoobject
• namestringobligatorio
• valuestringobligatorio

Ejemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/transactional-sends?limit=200' \
  --header "Authorization: Bearer $BANGER_API_KEY"

createTransactionalSend

Un destinatario por envío de Jornada. To acepta un destinatario en cualquier formato RecipientInput ("a@example.com", "Pat <a@example.com>", { email, name } o una lista de un elemento); Cc y Bcc deben estar vacíos. reply_to usa por defecto el buzón de la Jornada (una lista vacía también indica el valor predeterminado); el correo de Producto necesita exactamente uno. Una Jornada nueva de API usa por defecto contenido fuente gestionado; las Jornadas de código heredado conservan envíos de contenido completo. Un rechazo (4xx) no deja nada congelado para el destinatario, así que una llamada corregida con una nueva clave de idempotencia envía.

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud obligatorio

application/json

• valueobject
• mailbox_idstringobligatorio

  format: "uuid"

• tono especificadoobligatorio

  Destinatarios de to, cc, bcc y reply_to: una dirección ("a@example.com" o "Pat <a@example.com>"), un objeto { email, name } o una lista que mezcle ambos. Banger los almacena como objetos { email, name } con el correo en minúsculas. El hash de idempotencia incluye el cuerpo tal como se envía, así que reintenta con el mismo formato.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringobligatorio

  format: "email"

• oneOf 3array

  maxItems: 500

• Cada elementono especificado
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringobligatorio

  format: "email"

• ccarray

  maxItems: 0

• Cada elementoobject
• namestring
• emailstringobligatorio

  format: "email"

• bccarray

  maxItems: 0

• Cada elementoobject
• namestring
• emailstringobligatorio

  format: "email"

• subjectstring

  maxLength: 10000

• expires_atstring

  Descarta un envío diferido de Jornada después de este instante; como máximo siete días desde la solicitud original.

  format: "date-time"

• expires_after_secondsinteger

  minimum: 1 · maximum: 604800

• body_textstring

  maxLength: 2000000

• body_htmlstring

  maxLength: 2000000

• reply_tono especificado

  Destinatarios de to, cc, bcc y reply_to: una dirección ("a@example.com" o "Pat <a@example.com>"), un objeto { email, name } o una lista que mezcle ambos. Banger los almacena como objetos { email, name } con el correo en minúsculas. El hash de idempotencia incluye el cuerpo tal como se envía, así que reintenta con el mismo formato.

• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringobligatorio

  format: "email"

• oneOf 3array

  maxItems: 500

• Cada elementono especificado
• oneOf 1string

  minLength: 3 · maxLength: 1000

• oneOf 2object
• namestring
• emailstringobligatorio

  format: "email"

• headersobject
• Propiedad adicionalstring

  maxLength: 5000

• tagsarray

  maxItems: 49

• Cada elementoobject

  Sin propiedades adicionales

• namestringobligatorio

  minLength: 1 · maxLength: 256

• valuestringobligatorio

  minLength: 1 · maxLength: 256

Respuesta correcta 202

Respuesta correcta.

application/json

• valueobject
• dataobjectobligatorio
• action_kindstringobligatorio

  enum: "transactional.send"

• idstring

  format: "uuid"

• send_intent_idstring

  format: "uuid"

• provider_attempt_idstring

  format: "uuid"

• statusstringobligatorio

  Estados sent/queued de la entrega o, para una solicitud congelada: deferred (programada por la política o en espera de traducción), processing (en envío), discarded.

• replayedboolean
• journeyno especificadoobligatorio
• anyOf 1object
• journey_idstringobligatorio

  format: "uuid"

• enrollment_idstringobligatorio

  format: "uuid"

• step_idstringobligatorio

  format: "uuid"

• step_positionintegerobligatorio
• originstring

  enum: "journey"

• journey_identitystring
• anyOf 2null
• ignored_variablesarrayobligatorio
• Cada elementostring
• scheduled_atstring

  format: "date-time"

• reasonstring
• communication_reservation_idstring

  format: "uuid"

Ejemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/transactional-sends' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "mailbox_id": "00000000-0000-4000-8000-000000000001",
  "to": "example",
  "cc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "bcc": [
    {
      "name": "example",
      "email": "person@example.com"
    }
  ],
  "subject": "example",
  "expires_at": "2026-01-01T00:00:00Z",
  "expires_after_seconds": 1,
  "body_text": "example",
  "body_html": "example",
  "reply_to": "example",
  "headers": {},
  "tags": [
    {
      "name": "example",
      "value": "example"
    }
  ]
}'

getTransactionalSend

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 200

Respuesta correcta.

application/json

• valueobject
• dataobjectobligatorio
• idstringobligatorio

  format: "uuid"

• mailbox_idstring | nullobligatorio

  format: "uuid"

• command_idstring | nullobligatorio

  format: "uuid"

• statusstringobligatorio
• command_statusstring | nullobligatorio
• subjectstring
• recipientsarray
• Cada elementoobject
• emailstringobligatorio
• namestring
• recipient_countintegerobligatorio
• error_codestring | null
• send_intent_idstring

  format: "uuid"

• providerstring | null
• route_kindstring | null
• sourcestring
• from_addressstring
• recipient_statesobject
• Propiedad adicionalinteger
• provider_message_idstring | null
• languageno especificado

  El idioma en que se envió este correo; null si no se tradujo.

• anyOf 1object

  El idioma en que una persona recibió un correo. Solo lo tienen los correos traducidos (de contenido gestionado).

• localestringobligatorio

  Etiqueta BCP 47 del idioma en que se escribió el correo.

• requested_localestring

  Solo presente en un envío antiguo que salió en otro idioma: el idioma que la persona debería haber recibido.

• fallback_reasonstring

  enum: "translation_missing", "translation_pending", "translation_review_required", "translation_failed", "translation_timeout"

• anyOf 2null
• journeyobject | null

  El paso y la inscripción de la Jornada que enviaron este correo; null para otros envíos.

• journey_idstringobligatorio

  format: "uuid"

• step_idstringobligatorio

  format: "uuid"

• enrollment_idstringobligatorio

  format: "uuid"

• experimentobject | null

  La variante del experimento de este correo; null si no se aplicó ninguna.

• experiment_idstringobligatorio

  format: "uuid"

• variant_keystringobligatorio
• created_atstringobligatorio

  format: "date-time"

• updated_atstringobligatorio

  format: "date-time"

• completed_atstring | nullobligatorio

  format: "date-time"

• template_idstring | null

  format: "uuid"

• template_versioninteger | null
• workspace_revisioninteger | null
• command_resultobject
• Propiedad adicionalCualquier valor
• command_started_atstring | null

  format: "date-time"

• command_completed_atstring | null

  format: "date-time"

• body_textstring
• body_htmlstring
• reply_toarray
• Cada elementoobject
• emailstringobligatorio
• namestring
• headersobject
• Propiedad adicionalstring
• tagsarray
• Cada elementoobject
• namestringobligatorio
• valuestringobligatorio

Ejemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/transactional-sends/{transactionalSendId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

listTransactionalSendTimeline

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 200

Cronología ordenada de aceptación, intentos del proveedor y eventos del destinatario.

application/json

• valueobject
• dataarrayobligatorio
• Cada elementoobject
• occurred_atstringobligatorio

  format: "date-time"

• event_typestringobligatorio
• labelstringobligatorio
• providerstring | null
• recipient_domainstring | null
• error_codestring | null

Ejemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/transactional-sends/{transactionalSendId}/timeline' \
  --header "Authorization: Bearer $BANGER_API_KEY"

retryTransactionalSend

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 202

Respuesta correcta.

application/json

• valueobject
• dataobjectobligatorio
• action_kindstringobligatorio

  enum: "transactional.send"

• idstringobligatorio

  format: "uuid"

• send_intent_idstringobligatorio

  format: "uuid"

• provider_attempt_idstringobligatorio

  format: "uuid"

• statusstringobligatorio
• replayedbooleanobligatorio

Ejemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/transactional-sends/{transactionalSendId}/retry' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Idempotency-Key: examplexxxxxxxxx'

listThreads

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 200

Conversaciones del espacio de trabajo paginadas por claves.

application/json

• valueobject
• dataarrayobligatorio
• Cada elementoobject
• idstringobligatorio

  format: "uuid"

• mailbox_idstringobligatorio

  format: "uuid"

• subjectstringobligatorio
• snippetstringobligatorio
• last_message_atstringobligatorio

  format: "date-time"

• message_countintegerobligatorio
• unread_countintegerobligatorio
• is_archivedbooleanobligatorio
• is_trashbooleanobligatorio
• is_spambooleanobligatorio
• is_starredbooleanobligatorio
• is_sentbooleanobligatorio
• has_attachmentsbooleanobligatorio
• labelsarrayobligatorio
• Cada elementostring
• participantsarray
• Cada elementoobject
• namestring
• emailstringobligatorio

  format: "email"

• pageobjectobligatorio
• next_cursorstring
• has_morebooleanobligatorio

Ejemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/threads?cursor=example&limit=50&mailbox_id=00000000-0000-4000-8000-000000000001&label_id=00000000-0000-4000-8000-000000000001&view=inbox' \
  --header "Authorization: Bearer $BANGER_API_KEY"

getThread

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 200

Conversación y mensajes ordenados.

application/json

• valueobject
• datano especificadoobligatorio
• allOf 1object
• idstringobligatorio

  format: "uuid"

• mailbox_idstringobligatorio

  format: "uuid"

• subjectstringobligatorio
• snippetstringobligatorio
• last_message_atstringobligatorio

  format: "date-time"

• message_countintegerobligatorio
• unread_countintegerobligatorio
• is_archivedbooleanobligatorio
• is_trashbooleanobligatorio
• is_spambooleanobligatorio
• is_starredbooleanobligatorio
• is_sentbooleanobligatorio
• has_attachmentsbooleanobligatorio
• labelsarrayobligatorio
• Cada elementostring
• participantsarray
• Cada elementoobject
• namestring
• emailstringobligatorio

  format: "email"

• allOf 2object
• messagesarrayobligatorio
• Cada elementoobject
• idstringobligatorio

  format: "uuid"

• mailbox_idstringobligatorio

  format: "uuid"

• thread_idstringobligatorio

  format: "uuid"

• sent_atstringobligatorio

  format: "date-time"

• received_atstring

  format: "date-time"

• envelope_recipientsarray

  Destinatarios originales del sobre SMTP, normalizados en mayúsculas/minúsculas por el borde SMTP, antes del enrutamiento de alias de solo recepción. Vacío para mensajes antiguos o fuentes no SMTP. Independiente de las cabeceras visibles To/Cc.

• Cada elementostring

  format: "email"

  Se omiten niveles anidados adicionales

• fromobjectobligatorio
• namestring

  Se omiten niveles anidados adicionales

• emailstringobligatorio

  format: "email"

  Se omiten niveles anidados adicionales

• toarrayobligatorio
• Cada elementoobject

  Se omiten niveles anidados adicionales

• ccarray
• Cada elementoobject

  Se omiten niveles anidados adicionales

• reply_toarray
• Cada elementoobject

  Se omiten niveles anidados adicionales

• is_sentboolean

  Si este mensaje se envió desde el buzón, incluido desde un alias.

• body_textstring
• body_html_urlstring

  format: "uri"

• reply_originobject
• send_intent_idstringobligatorio

  format: "uuid"

  Se omiten niveles anidados adicionales

• sourcestringobligatorio

  enum: "gateway", "transactional", "marketing", "mailbox", "agent"

  Se omiten niveles anidados adicionales

• source_idstring

  format: "uuid"

  Se omiten niveles anidados adicionales

• traffic_classstringobligatorio

  enum: "transactional", "marketing", "mailbox"

  Se omiten niveles anidados adicionales

• kindstringobligatorio

  enum: "campaign", "sequence", "transactional", "mailbox", "agent"

  Se omiten niveles anidados adicionales

• namestring

  Se omiten niveles anidados adicionales

• has_attachmentsbooleanobligatorio
• attachmentsarray
• Cada elementoobject

  Se omiten niveles anidados adicionales

Ejemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/threads/{threadId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

getMessageHtml

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 200

Cuerpo HTML del mensaje autenticado y restringido por sandbox.

text/html

• valuestring

Ejemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/messages/{messageId}/html' \
  --header "Authorization: Bearer $BANGER_API_KEY"

downloadAttachment

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 200

Flujo de adjunto autenticado.

application/octet-stream

• valuestring

  format: "binary"

Ejemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/attachments/{attachmentId}/content' \
  --header "Authorization: Bearer $BANGER_API_KEY"

searchMail

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 200

Resultados de búsqueda de todo el espacio de trabajo.

application/json

• valueobject
• dataarrayobligatorio
• Cada elementoobject
• idstringobligatorio

  format: "uuid"

• mailbox_idstringobligatorio

  format: "uuid"

• subjectstringobligatorio
• snippetstringobligatorio
• last_message_atstringobligatorio

  format: "date-time"

• message_countintegerobligatorio
• unread_countintegerobligatorio
• is_archivedbooleanobligatorio
• is_trashbooleanobligatorio
• is_spambooleanobligatorio
• is_starredbooleanobligatorio
• is_sentbooleanobligatorio
• has_attachmentsbooleanobligatorio
• labelsarrayobligatorio
• Cada elementostring
• participantsarray
• Cada elementoobject
• namestring
• emailstringobligatorio

  format: "email"

• pageobjectobligatorio
• next_cursorstring
• has_morebooleanobligatorio

Ejemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/search?q=example&cursor=example&limit=50&mailbox_id=00000000-0000-4000-8000-000000000001' \
  --header "Authorization: Bearer $BANGER_API_KEY"

listContacts

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 200

Respuesta correcta.

application/json

• valueobject
• dataarrayobligatorio
• Cada elementoobject
• idstringobligatorio

  format: "uuid"

• emailstringobligatorio

  format: "email"

• display_namestring | nullobligatorio
• attributesobjectobligatorio
• Propiedad adicionalCualquier valor
• statusstringobligatorio

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• created_atstringobligatorio

  format: "date-time"

• updated_atstringobligatorio

  format: "date-time"

• pageobjectobligatorio
• next_cursorstring
• has_morebooleanobligatorio

Ejemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts?cursor=example&limit=50&q=example' \
  --header "Authorization: Bearer $BANGER_API_KEY"

upsertContact

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud obligatorio

application/json

• valueobject

  Sin propiedades adicionales

• emailstringobligatorio

  format: "email"

• display_namestring

  maxLength: 1000

• statusstringobligatorio

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• attributesobject
• Propiedad adicionalCualquier valor
• consent_confirmedboolean

  Obligatorio al suscribir una dirección nueva.

Respuesta correcta 201

Respuesta correcta.

application/json

• valueobject
• dataobjectobligatorio
• idstringobligatorio

  format: "uuid"

• emailstringobligatorio

  format: "email"

• display_namestring | nullobligatorio
• attributesobjectobligatorio
• Propiedad adicionalCualquier valor
• statusstringobligatorio

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• created_atstringobligatorio

  format: "date-time"

• updated_atstringobligatorio

  format: "date-time"

Ejemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "email": "person@example.com",
  "display_name": "example",
  "status": "subscribed",
  "attributes": {},
  "consent_confirmed": true
}'

getContact

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 200

Respuesta correcta.

application/json

• valueobject
• dataobjectobligatorio
• idstringobligatorio

  format: "uuid"

• emailstringobligatorio

  format: "email"

• display_namestring | nullobligatorio
• attributesobjectobligatorio
• Propiedad adicionalCualquier valor
• statusstringobligatorio

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• created_atstringobligatorio

  format: "date-time"

• updated_atstringobligatorio

  format: "date-time"

• suppressedbooleanobligatorio
• suppression_reasonstring | nullobligatorio
• sourcesarrayobligatorio
• Cada elementoobject
• kindstringobligatorio
• referencestringobligatorio
• connection_idstring | nullobligatorio

  format: "uuid"

• metadataobjectobligatorio
• Propiedad adicionalCualquier valor
• first_seen_atstringobligatorio

  format: "date-time"

• last_seen_atstringobligatorio

  format: "date-time"

• listsarrayobligatorio
• Cada elementoobject
• idstringobligatorio

  format: "uuid"

• namestringobligatorio
• subscription_statusstringobligatorio
• consent_evidencearrayobligatorio
• Cada elementoobject
• kindstringobligatorio
• referencestringobligatorio
• connection_idstring | nullobligatorio

  format: "uuid"

• metadataobjectobligatorio
• Propiedad adicionalCualquier valor
• first_seen_atstringobligatorio

  format: "date-time"

• last_seen_atstringobligatorio

  format: "date-time"

Ejemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts/{contactId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

deleteContact

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 204

Contacto eliminado.

Sin cuerpo de respuesta.

Ejemplo de curl

curl --request DELETE --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts/{contactId}' \
  --header "Authorization: Bearer $BANGER_API_KEY"

listContactImports

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud

El contrato no especifica un cuerpo de solicitud.

Respuesta correcta 200

Respuesta correcta.

application/json

• valueobject
• dataarrayobligatorio
• Cada elementoobject
• idstring

  format: "uuid"

• filenamestring
• list_idstring | null

  format: "uuid"

• list_namestring | null
• statusstring
• total_rowsinteger
• imported_rowsinteger
• invalid_rowsinteger
• error_summaryarray
• Cada elementostring
• consent_confirmedboolean
• consent_confirmed_atstring | null

  format: "date-time"

• processed_rowsinteger
• attempt_countinteger
• last_error_codestring | null
• created_atstring

  format: "date-time"

• completed_atstring | null

  format: "date-time"

Ejemplo de curl

curl --request GET --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts/imports' \
  --header "Authorization: Bearer $BANGER_API_KEY"

importContacts

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud obligatorio

application/json

• valueobject
• filenamestringobligatorio

  minLength: 1 · maxLength: 500

• list_idstring

  format: "uuid"

• consent_confirmedboolean

  Obligatorio si alguna fila importada está suscrita.

• rowsarrayobligatorio

  minItems: 1 · maxItems: 5000

• Cada elementoobject
• emailstringobligatorio

  format: "email"

• display_namestring

  maxLength: 1000

• statusstring

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• attributesobject
• Propiedad adicionalCualquier valor

Respuesta correcta 201

Respuesta correcta.

application/json

• valueobject
• dataobjectobligatorio
• idstringobligatorio

  format: "uuid"

• statusstringobligatorio

  enum: "queued"

• total_rowsintegerobligatorio
• imported_rowsintegerobligatorio
• invalid_rowsintegerobligatorio
• list_idstring | nullobligatorio

  format: "uuid"

Ejemplo de curl

curl --request POST --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts/imports' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "filename": "example",
  "list_id": "00000000-0000-4000-8000-000000000001",
  "consent_confirmed": true,
  "rows": [
    {
      "email": "person@example.com",
      "display_name": "example",
      "status": "subscribed",
      "attributes": {}
    }
  ]
}'

Combinar atributos tipados sin cambiar la suscripción ni el consentimiento

Requiere contacts:write y contacts:read. Solo actualiza un contacto existente. Conserva los atributos omitidos, almacena false explícito y null elimina un campo. Proporciona hechos verificados de la fuente; la ausencia de datos no es false. La suscripción, supresión, identidad e historial de fuentes no cambian.

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud obligatorio

application/json

• valueobject

  Sin propiedades adicionales

• attributesobjectobligatorio
• Propiedad adicionalCualquier valor

Respuesta correcta 200

Lectura actual del contacto; replayed es true si esta modificación ya se aplicó.

application/json

• valueobject
• dataobjectobligatorio
• idstringobligatorio

  format: "uuid"

• attributesobjectobligatorio
• Propiedad adicionalCualquier valor
• statusstringobligatorio

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• replayedbooleanobligatorio
• Propiedad adicionalCualquier valor

Ejemplo de curl

curl --request PATCH --globoff 'https://api.bangermail.com/v1/workspaces/{workspaceId}/contacts/{contactId}/attributes' \
  --header "Authorization: Bearer $BANGER_API_KEY" \
  --header 'X-Banger-Product-Id: 00000000-0000-4000-8000-000000000001' \
  --header 'Idempotency-Key: example' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "attributes": {}
}'

upsertProductContact

Autenticación: clave de API Bearer del espacio de trabajo.

Parámetros

Cuerpo de la solicitud obligatorio

application/json

• valueobject

  Sin propiedades adicionales

• emailstringobligatorio

  format: "email" · maxLength: 320

• display_namestring

  minLength: 0 · maxLength: 1000

• attributesobject
• Propiedad adicionalCualquier valor
• statusstringobligatorio

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• consent_evidenceobject

  Sin propiedades adicionales

• sourcestring

  minLength: 1 · maxLength: 2000

• referencestring

  minLength: 1 · maxLength: 2000

• observed_atstring

  format: "date-time"

• statementstring

  minLength: 1 · maxLength: 2000

• consent_confirmedboolean

Respuesta correcta 200

Lectura canónica o recibo idempotente. La aceptación del proveedor es sent; delivered requiere un evento de entrega y no demuestra llegada a la bandeja de entrada.

application/json

• valueobject
• datano especificadoobligatorio
• allOf 1object
• idstringobligatorio

  format: "uuid"

• emailstringobligatorio

  format: "email"

• display_namestring | nullobligatorio
• attributesobjectobligatorio
• Propiedad adicionalCualquier valor
• statusstringobligatorio

  enum: "subscribed", "unsubscribed", "bounced", "complained"

• created_atstringobligatorio

  format: "date-time"

• updated_atstringobligatorio

  format: "date-time"

• suppressedbooleanobligatorio
• suppression_reasonstring | nullobligatorio
• sourcesarrayobligatorio
• Cada elementoobject
• kindstringobligatorio
• referencestringobligatorio
• connection_idstring | nullobligatorio

  format: "uuid"

• metadataobjectobligatorio
• Propiedad adicionalCualquier valor
• first_seen_atstringobligatorio

  format: "date-time"

• last_seen_atstringobligatorio

  format: "date-time"

• listsarrayobligatorio
• Cada elementoobject
• idstringobligatorio

  format: "uuid"

• namestringobligatorio
• subscription_statusstringobligatorio
• consent_evidencearrayobligatorio
• Cada elementoobject
• kindstringobligatorio
• referencestringobligatorio
• connection_idstring | nullobligatorio

  format: "uuid"

• metadataobjectobligatorio
• Propiedad adicionalCualquier valor
• first_seen_atstringobligatorio

  format: "date-time"

• last_seen_atstringobligatorio

  format: "date-time"

• allOf 2object
• replayedbooleanobligatorio