Read the US texting registration

get_site_message_registration

Reads where a site's business registration for texting the United States stands, and the details the form starts from.

POST /v1/get_site_message_registrationScopeconfig:readRead only

Texts to US numbers need the site's business registered with US carriers once, on any plan. state is none (not registered yet), in-review (sent, US carriers usually answer in 3 to 7 business days), action-needed (carriers asked for a change, reason says what to do, then send it again with register_site_message_business) or approved (number is the site's own US number). The other fields are what was sent, with the tax ID shown only by its last 4 digits, or the defaults the form starts from: businessName and website from the site, and messageFlow, how people agree to get texts, written from the site. privacyUrl and termsUrl are the texting privacy page and terms Modulify hosts for the site. See US texting.

Request

Call it with a POST to https://api.modulify.ai/v1/get_site_message_registration, sending the inputs below as a JSON object. The token needs the config:read scope.

It only reads and changes nothing, so retrying it is safe.

curl -X POST https://api.modulify.ai/v1/get_site_message_registration \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"projectId":"PROJECT_ID"}'

Over MCP, the same method is the get_site_message_registration tool.

Inputs

Input Type Required Description
projectId string Yes The site id.

Response

Every call answers with the JSON envelope of success, message, data, code and version. data holds the result described above, and on a method that returns a total, count carries it. The response headers carry the call's X-Request-Id and what is left of your per-minute budget in X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. Errors explains every status code a call can answer with.