Skip to Content
Birthdays & Milestones

Sync contact birthday & optionally greet immediately

View Markdown (.md)
POST
/api/v1/public/birthdays/sync

Saves contact date of birth for automated celebration alerts and optionally dispatches an immediate greeting SMS.

Authorization

headerX-Api-Key<token>

SMS Pro API Key (sk_live_... or sk_test_...)

Request Body

application/json
  1. body
phoneNumber*string
name?string
birthDate?string
Formatdate
sendGreetImmediately?boolean
Defaultfalse

Response Body

Contact birthday synced or greeting dispatched

application/json
  1. response
status?string
message?string
Example Request
curl -X POST 'https://api.smspro.com/api/v1/public/birthdays/sync' \  -H 'Content-Type: application/json' \  -d '{  "phoneNumber": "string"}'
Example Response
{  "status": "string",  "message": "string"}