Skip to main content
POST
/
recipients
Create a new Recipient
curl --request POST \
  --url https://staging.api.onenumber.africa/v1/recipients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>"
}
'
{
  "statusCode": 123,
  "message": "<string>",
  "data": [
    {
      "reference": "<string>",
      "phoneNumber": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "email": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.onenumber.africa/llms.txt

Use this file to discover all available pages before exploring further.

​
Request Body Parameters

​
phoneNumber
string
required
The phone number of the Recipient.
​
firstName
string
The first name of the Recipient.
​
lastName
string
The first name of the Recipient.
​
email
string
The email of the Recipient.

​
Successful Response Data

​
statusCode
int
required
The status of the response. For successful response, value is 201. Check the Response Codes page for details.
​
message
string
required
The message of the response.
​
data
array