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

​
Request Body Parameters

​
name
string
required
The name of the group. The group name must be unique.
​
recipients
array
required
The recipients to receive be added to the group. This can contain valid phone numbers and Recipient references.

​
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