> ## Documentation Index > Fetch the complete documentation index at: https://inbound.new/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update endpoint > Update an existing endpoint's name, description, active status, config, or webhook format ## OpenAPI ````yaml https://app.stainless.com/api/spec/documented/inbound/openapi.documented.yml put /api/e2/endpoints/{id} openapi: 3.1.0 info: title: Inbound Email API description: >+ # Inbound API The Inbound API allows you to manage email infrastructure programmatically - domains, email addresses, webhooks, and more. ## Authentication All API requests require a Bearer token in the Authorization header: ```bash curl -H "Authorization: Bearer YOUR_API_KEY" \ https://inbound.new/api/e2/domains ``` ## Base URL ``` https://inbound.new/api/e2 ``` ## Quick Start 1. **Create a domain** - Register your domain with Inbound 2. **Configure DNS** - Add the provided DNS records to your domain 3. **Create an email address** - Set up addresses to receive emails 4. **Create an endpoint** - Configure where emails are delivered (webhook, forwarding, etc.) version: 2.0.0 servers: - url: https://inbound.new description: Production API server security: - bearerAuth: [] tags: - name: Webhooks description: Webhooks sent by Inbound to your configured endpoints when events occur. - name: Emails description: >- Send, list, and manage emails. Supports immediate sending, scheduling, replies, and retry functionality. - name: Mail description: >- Inbox and thread views for received emails. Filter by domain, address, or search. - name: Domains description: >- Manage domains for sending and receiving emails. Domains must be verified via DNS before use. - name: Endpoints description: >- Configure where incoming emails are delivered - webhooks, email forwarding, or custom handlers. - name: Email Addresses description: Create and manage email addresses on your verified domains. - name: Attachments description: Download email attachments using authenticated requests. paths: /api/e2/endpoints/{id}: put: tags: - Endpoints summary: Update endpoint description: >- Update an existing endpoint's name, description, active status, config, or webhook format operationId: putApiE2EndpointsById parameters: - name: id in: path required: true schema: type: string requestBody: required: true content: application/json: schema: type: object properties: name: minLength: 1 maxLength: 255 type: string description: maxLength: 1000 type: string isActive: type: boolean config: anyOf: - title: WebhookConfig type: object properties: url: type: string timeout: minimum: 1 maximum: 300 type: number retryAttempts: minimum: 0 maximum: 10 type: number headers: description: Custom headers to include with webhook requests type: object patternProperties: ^(.*)$: type: string required: - url - title: EmailConfig type: object properties: forwardTo: format: email type: string includeAttachments: type: boolean subjectPrefix: maxLength: 255 type: string fromAddress: format: email type: string senderName: maxLength: 255 type: string preserveHeaders: type: boolean required: - forwardTo - title: EmailGroupConfig type: object properties: emails: minItems: 1 maxItems: 50 type: array items: format: email type: string includeAttachments: type: boolean subjectPrefix: maxLength: 255 type: string fromAddress: format: email type: string senderName: maxLength: 255 type: string preserveHeaders: type: boolean required: - emails webhookFormat: type: string enum: - inbound - discord - slack application/x-www-form-urlencoded: schema: type: object properties: name: minLength: 1 maxLength: 255 type: string description: maxLength: 1000 type: string isActive: type: boolean config: anyOf: - title: WebhookConfig type: object properties: url: type: string timeout: minimum: 1 maximum: 300 type: number retryAttempts: minimum: 0 maximum: 10 type: number headers: description: Custom headers to include with webhook requests type: object patternProperties: ^(.*)$: type: string required: - url - title: EmailConfig type: object properties: forwardTo: format: email type: string includeAttachments: type: boolean subjectPrefix: maxLength: 255 type: string fromAddress: format: email type: string senderName: maxLength: 255 type: string preserveHeaders: type: boolean required: - forwardTo - title: EmailGroupConfig type: object properties: emails: minItems: 1 maxItems: 50 type: array items: format: email type: string includeAttachments: type: boolean subjectPrefix: maxLength: 255 type: string fromAddress: format: email type: string senderName: maxLength: 255 type: string preserveHeaders: type: boolean required: - emails webhookFormat: type: string enum: - inbound - discord - slack multipart/form-data: schema: type: object properties: name: minLength: 1 maxLength: 255 type: string description: maxLength: 1000 type: string isActive: type: boolean config: anyOf: - title: WebhookConfig type: object properties: url: type: string timeout: minimum: 1 maximum: 300 type: number retryAttempts: minimum: 0 maximum: 10 type: number headers: description: Custom headers to include with webhook requests type: object patternProperties: ^(.*)$: type: string required: - url - title: EmailConfig type: object properties: forwardTo: format: email type: string includeAttachments: type: boolean subjectPrefix: maxLength: 255 type: string fromAddress: format: email type: string senderName: maxLength: 255 type: string preserveHeaders: type: boolean required: - forwardTo - title: EmailGroupConfig type: object properties: emails: minItems: 1 maxItems: 50 type: array items: format: email type: string includeAttachments: type: boolean subjectPrefix: maxLength: 255 type: string fromAddress: format: email type: string senderName: maxLength: 255 type: string preserveHeaders: type: boolean required: - emails webhookFormat: type: string enum: - inbound - discord - slack responses: '200': description: Response for status 200 content: application/json: schema: type: object properties: id: type: string name: type: string type: enum: - webhook - email - email_group type: string config: x-stainless-any: true isActive: type: boolean description: nullable: true anyOf: - type: string - type: 'null' userId: type: string createdAt: nullable: true anyOf: - type: string - type: 'null' updatedAt: nullable: true anyOf: - type: string - type: 'null' groupEmails: nullable: true anyOf: - type: array items: type: string - type: 'null' required: - id - name - type - config - isActive - description - userId - createdAt - updatedAt - groupEmails '400': description: Response for status 400 content: application/json: schema: type: object properties: error: type: string details: type: string required: - error '401': description: Response for status 401 content: application/json: schema: type: object properties: error: type: string message: type: string statusCode: type: number required: - error - message - statusCode '404': description: Response for status 404 content: application/json: schema: type: object properties: error: type: string required: - error '500': description: Response for status 500 content: application/json: schema: type: object properties: error: type: string message: type: string statusCode: type: number required: - error - message - statusCode x-codeSamples: - lang: JavaScript source: |- import Inbound from 'inboundemail'; const client = new Inbound({ apiKey: process.env['INBOUND_API_KEY'], // This is the default and can be omitted }); const endpoint = await client.endpoints.update('id'); console.log(endpoint.id); components: securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: >- Your Inbound API key. Include it in the Authorization header as: Bearer ````