/ Docs
API ReferenceContacts

Get a Contact

Page Tools
GET/contacts/{identifier}

Fetch a single contact by Smobi id or phone number.

Authenticate with your brand’s x-api-key.Authentication

Path Parameters

identifierstringrequired

Contact id (uuid) or phone number (digits-only recommended in URLs; E.164 requires encoding + as %2B)

Responses

The contact

idstringrequired
phoneNumberstringrequired

Always returned in E.164 format

activebooleanrequired

false when the contact has been archived (DELETE)

firstNamestring · nullablerequired
lastNamestring · nullablerequired
emailstring · nullablerequired
statestring · nullablerequired
countrystring · nullablerequired
dobstring · nullablerequired

Date of birth (YYYY-MM-DD)

genderstring · nullablerequired
preferredLanguagestring · nullablerequired
tagsarray of stringrequired
Show item detailsHide item details for response-200.tags

Each item

string
customFieldsobjectrequired

Stored custom-field values keyed by field name. See create/update request schemas for accepted write types and limits.

Show child fieldsHide child fields for response-200.customFields
[key]any

Additional keys may contain any JSON value.

marketingConsentobjectrequired
Show child fieldsHide child fields for response-200.marketingConsent
channelstringrequired
Allowed values"MOBILE"
statusstringrequired

Campaigns are only sent to OPTED_IN contacts. Contacts created via the API start as UNKNOWN until consent is set.

Allowed values"UNKNOWN""SENT""OPTED_IN""OPTED_OUT"
updatedAtstring · nullablerequired
createdAtstringrequired
updatedAtstringrequired

Create or Update Contacts in Bulk

POST /contacts/bulk

Update a Contact

PATCH /contacts/{identifier}