v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-181,0851,7264.5 MB

Opt-Out Management

Create auto-response setting

post/messaging_profiles/{profile_id}/autoresp_configs

Path parameters

profile_idstring required

Unique identifier of the profile.

Request body

op'start' | 'stop' | 'info' required

keywordsstring[] required

resp_textstring

country_codestring required

Example request

{
  "keywords": [
    "keyword1",
    "keyword2"
  ],
  "resp_text": "Thank you for your message",
  "country_code": "US"
}

Response

Successful Response

Example response

{
  "data": {
    "op": "start",
    "keywords": [
      "START",
      "BEGIN"
    ],
    "resp_text": "Thank you for subscribing to our service.",
    "country_code": "*",
    "id": "b8f9c1c0-5b5a-4b1e-8c1c-0b5a4b1e8c1c"
  }
}