Get Contact by ID
Query the details of a specific contact using its unique ID.
Contacts
Contacts are the foundation of your communication system in SendMe123. Through these endpoints you can create, query, update and delete contacts efficiently.
Available Endpoints
Section titled “Available Endpoints”The contact endpoints allow you to manage your entire contact database.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/contacts | Get paginated list of contacts |
| POST | /api/contacts | Create a new contact |
| GET | /api/contacts/{id} | Get contact by ID |
| PATCH | /api/contacts/{id} | Update existing contact |
| DELETE | /api/contacts/{id} | Delete specific contact |
Get Started
Section titled “Get Started”Explore the available endpoints:
Update Contact
Modify the information of an existing contact.
Delete Contact
Permanently delete a contact from your database.
General Information
Section titled “General Information”Contact Fields
Section titled “Contact Fields”| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Contact name |
phone | string | Yes | Phone number (without prefix) |
lastName | string | No | Contact last name |
email | string | No | Email address |
countryCode | string | No | Country code (e.g: “57”) |
status | enum | No | Status: ACTIVE, INACTIVE, BLOCKED |
birthDate | datetime | No | Birth date |
tagIds | array | No | Associated tag IDs |
customValues | object | No | Custom fields |
Contact Status
Section titled “Contact Status”| Status | Description |
|---|---|
ACTIVE | Active contact (can receive messages) |
INACTIVE | Inactive contact (temporarily paused) |
BLOCKED | Blocked contact (cannot receive messages) |
Validations
Section titled “Validations”- Phone: Must be a valid 10-digit number
- Email: Must have valid format if provided
- Name: Minimum 2 characters, maximum 100
- countryCode: Must be a valid numeric code