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

# Sender ID Registration API

> Register a custom sender name or number for outbound SMS. Requests are reviewed and approved by email. Until approved, messages use the default sender ID.

<Note>
  You would need to register a sender ID with the endpoint mentioned below. All messages sent before then will be delivered with the default sender ID.
</Note>

Register your Sender ID with this endpoint. You will get an email once it has been approved. All messages sent before then will be delivered with the default sender ID.

### Request

```http [POST] theme={null}
{{baseUrl}}api/v1/messaging/sender_id
```

### Body parameter

| Parameter  | Type   | Description                                                       | Required |
| ---------- | ------ | ----------------------------------------------------------------- | -------- |
| sender\_id | string | Sender ID you wish to register, should be less than 11 characters | required |

<Warning>
  Kindly note that you can only register your Sender ID in production.
</Warning>

### Sample response

```json Response theme={null}
{
  "entity": {
    "message": "Sender ID Request Successful, you will get an email once it's activated."
  }
}
```

### Response Fields

| Field          | Type   | Description                                                     |
| -------------- | ------ | --------------------------------------------------------------- |
| entity         | object | Contains the sender ID registration result                      |
| entity.message | string | Confirmation message indicating the registration request status |

## Fetch Sender IDs

Fetch the list of all your Sender IDs.

### Request

```http [GET] theme={null}
{{baseUrl}}api/v1/messaging/sender_ids
```

### Sample response

```json Response theme={null}
{
    "entity": [
        {
            "sender_id": "Dojah",
            "activated": true,
            "createdAt": "2020-10-30T09:54:17.145Z"
        }
    ]
}
```

### Response Fields

| Field                | Type    | Description                                                     |
| -------------------- | ------- | --------------------------------------------------------------- |
| entity               | array   | List of registered sender IDs                                   |
| entity\[].sender\_id | string  | The registered sender ID name                                   |
| entity\[].activated  | boolean | `true` if the sender ID has been approved and is active for use |
| entity\[].createdAt  | string  | ISO 8601 timestamp of when the sender ID was registered         |