> ## 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.

# Request a sender

> Asks for a dedicated sender: a number your organisation owns, or a brand name of 3 to 11 letters and digits.
Sendbaze registers it with the networks and approves or rejects it (you are emailed); until then a send that names
it answers `403 sender_not_approved`. The first approved sender becomes your default. Requires `sms:send` and a plan
that includes dedicated senders (Growth and up; `403 plan_limit` otherwise). One request per sender value.




## OpenAPI

````yaml /api-reference/openapi.yaml post /v1/senders
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:
    post:
      tags:
        - Senders
      summary: Request a sender
      description: >
        Asks for a dedicated sender: a number your organisation owns, or a brand
        name of 3 to 11 letters and digits.

        Sendbaze registers it with the networks and approves or rejects it (you
        are emailed); until then a send that names

        it answers `403 sender_not_approved`. The first approved sender becomes
        your default. Requires `sms:send` and a plan

        that includes dedicated senders (Growth and up; `403 plan_limit`
        otherwise). One request per sender value.
      operationId: requestSender
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RequestSenderRequest'
            example:
              value: AcmeShop
              useCase: >-
                Order confirmations and delivery updates for our online shop,
                and monthly offers to customers who opted in.
              countries:
                - ZA
                - BW
      responses:
        '201':
          description: Requested
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Sender'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          $ref: '#/components/responses/Conflict'
        '422':
          $ref: '#/components/responses/Unprocessable'
components:
  schemas:
    RequestSenderRequest:
      type: object
      required:
        - value
        - useCase
      properties:
        value:
          type: string
          description: >-
            A brand name of 3 to 11 letters and digits (single spaces allowed),
            or a number of 6 to 15 digits you own.
          example: AcmeShop
        useCase:
          type: string
          minLength: 20
          maxLength: 1000
          description: What you send from it; kept for the network application.
        countries:
          type: array
          items:
            type: string
          description: >-
            ISO 3166-1 alpha-2 countries it should be used in. Defaults to the
            countries your organisation enabled.
    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:
    Forbidden:
      description: >-
        Insufficient scope, unverified domain, suspended organisation, an SMS
        destination the organisation has not enabled (destination_not_enabled),
        a marketing SMS without a consent record (consent_missing), a sender id
        that is not approved (sender_not_approved), or a Free organisation
        sending live SMS before its card check (card_check_required)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            error:
              code: domain_not_verified
              message: >-
                yourshop.co.za is not a verified sending domain of this
                organisation.
              docs: https://docs.sendbaze.com/errors#domain_not_verified
    Conflict:
      description: Idempotency conflict or duplicate name
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    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.