> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sendbaze.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Make a sender the default

> Send `{ "default": true }` to make an approved sender the one used when a send names no `senderId`. The previous default stops being it. Requires `sms:send`.



## OpenAPI

````yaml /api-reference/openapi.yaml patch /v1/senders/{id}
openapi: 3.1.0
info:
  title: Sendbaze API
  version: '1.0'
  description: >
    Transactional email and SMS for Africa. Send from your own domain through
    Amazon SES in Cape Town.

    Every send returns an id immediately; delivery is reported by webhook and in
    the dashboard logs.
  contact:
    name: Sendbaze support
    email: support@sendbaze.com
    url: https://www.sendbaze.com
servers:
  - url: https://api.sendbaze.com
security:
  - bearerAuth: []
tags:
  - name: Emails
  - name: Templates
  - name: Domains
  - name: Suppressions
  - name: Webhooks
  - name: SMS
  - name: Contacts
  - name: Senders
  - name: Usage
paths:
  /v1/senders/{id}:
    patch:
      tags:
        - Senders
      summary: Make a sender the default
      description: >-
        Send `{ "default": true }` to make an approved sender the one used when
        a send names no `senderId`. The previous default stops being it.
        Requires `sms:send`.
      operationId: updateSender
      parameters:
        - $ref: '#/components/parameters/SenderId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - default
              properties:
                default:
                  type: boolean
                  enum:
                    - true
      responses:
        '200':
          description: The sender
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Sender'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/Unprocessable'
components:
  parameters:
    SenderId:
      name: id
      in: path
      required: true
      schema:
        type: string
        example: sdr_01j9x7k2r4m8q3v5n6b7c8d9e0
  schemas:
    Sender:
      type: object
      required:
        - id
        - value
        - kind
        - status
        - isDefault
        - useCase
        - countries
        - caveats
        - reviewNote
        - requestedAt
        - reviewedAt
      properties:
        id:
          type: string
          example: sdr_01j9x7k2r4m8q3v5n6b7c8d9e0
        value:
          type: string
          description: >-
            As the networks show it; name it on a send as senderId once
            approved.
          example: AcmeShop
        kind:
          $ref: '#/components/schemas/SenderKind'
        status:
          $ref: '#/components/schemas/SenderStatus'
        isDefault:
          type: boolean
          description: Used when a send names no sender. At most one per organisation.
        useCase:
          type: string
        countries:
          type: array
          items:
            type: string
          example:
            - ZA
            - BW
        caveats:
          type: array
          items:
            type: string
          description: >-
            What the networks do with this kind of sender in those countries, in
            plain language.
        reviewNote:
          type:
            - string
            - 'null'
          description: >-
            The reviewer's note: why it was rejected or revoked, or how it was
            registered.
        requestedAt:
          type: string
          format: date-time
        reviewedAt:
          type:
            - string
            - 'null'
          format: date-time
    SenderKind:
      type: string
      enum:
        - numeric
        - alphanumeric
    SenderStatus:
      type: string
      enum:
        - requested
        - approved
        - rejected
        - revoked
      description: >-
        requested = being registered with the networks; approved = usable;
        rejected = could not be registered (see reviewNote); revoked = no longer
        usable.
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
    ErrorBody:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Stable error code; see the errors reference.
          example: validation_error
        message:
          type: string
        docs:
          type: string
          format: uri
        fields:
          type: object
          description: Present on validation errors. Dotted path to messages.
          additionalProperties:
            type: array
            items:
              type: string
        limit:
          type: integer
          description: On `plan_limit`, the ceiling that was reached.
        upgradeUrl:
          type: string
          format: uri
          description: >-
            Where to change plan, when a bigger plan would have allowed the
            request.
        topUpUrl:
          type: string
          format: uri
          description: >-
            Where to add wallet funds, when a balance would have allowed the
            request.
        settingsUrl:
          type: string
          format: uri
          description: >-
            Where to change an organisation setting that blocked the request
            (SMS destinations).
        domainsUrl:
          type: string
          format: uri
          description: >-
            Where to add and verify a sending domain, on
            `sandbox_recipient_not_allowed` and `sandbox_limit_reached`.
  responses:
    NotFound:
      description: No such resource in your organisation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: not_found
              message: No email with id em_x.
              docs: https://docs.sendbaze.com/errors#not_found
    Unprocessable:
      description: >-
        Validation failed, a recipient is suppressed, or an SMS destination is
        not supported (destination_not_supported)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: validation_error
              message: The request has invalid fields.
              docs: https://docs.sendbaze.com/errors#validation_error
              fields:
                to.1:
                  - must be a valid email address
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        An API key from the dashboard. `sk_live_…` sends; `sk_test_…` validates
        and returns ids without sending.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.