Skip to main content
POST
Create or reuse a recipient

Authorizations

Authorization
string
header
required

A business-bound HaulStow API key. Send Authorization: Bearer hsg_live_key_... to the live server or a hsg_test_key_... key to the sandbox server. Never expose this key in a browser.

Headers

X-Request-ID
string

Optional caller correlation ID. Use 1–128 ASCII letters, digits, ., _, -, or :. Invalid values are replaced. The accepted/generated value is returned in the response.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9._:-]+$
Idempotency-Key
string
required

A unique key for this logical mutation. Retained for 24 hours.

Required string length: 8 - 255

Body

application/json
phone_number
string
required

Recipient phone number in E.164 form.

Pattern: ^\+[1-9][0-9]{7,14}$
Example:

"+233245412312"

name
string
Required string length: 1 - 255
Example:

"Ama Mensah"

Response

Existing recipient returned.

success
boolean
required
statusCode
enum<integer>
required
Available options:
200,
201
message
string
required
data
object
required