Advanced OptIn/OptOut API

Advanced OptIn/OptOut API

List Auto-Response Settings

SecuritybearerAuth
Request
path Parameters
profile_id
required
string <uuid> (Profile Id)
query Parameters
country_code
string (Country Code)
created_at[gte]
string (Created At[Gte])
created_at[lte]
string (Created At[Lte])
updated_at[gte]
string (Updated At[Gte])
updated_at[lte]
string (Updated At[Lte])
Responses
200

Successful Response

Response Schema: application/json
required
Array of objects (Data)
required
object (PaginationMeta)
default

Unexpected error

Response Schema: application/json
Array of objects (Error)
Array
code
required
string <int>
detail
string
meta
object
object
title
required
string
get/messaging_profiles/{profile_id}/autoresp_configs
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "country_code": "US",
      • "created_at": "2023-03-21T23:37:45.858535+00:00",
      • "id": "677ec1cb-949e-4aeb-a1c3-6d9ddffc1409",
      • "keywords": [
        • "START",
        • "BEGIN"
        ],
      • "op": "start",
      • "resp_text": "Thank you for subscribing US customer.",
      • "updated_at": "2023-03-21T23:37:45.858535+00:00"
      },
    • {
      • "country_code": "US",
      • "created_at": "2023-03-10T21:54:46.293380+00:00",
      • "id": "54b7e19f-98a8-416f-81d1-a2782eade48b",
      • "keywords": [
        • "END",
        • "STOP"
        ],
      • "op": "stop",
      • "resp_text": "You have unsubscribed.",
      • "updated_at": "2023-03-10T21:54:46.293380+00:00"
      },
    • {
      • "country_code": "*",
      • "created_at": "2023-03-14T14:46:21.097735+00:00",
      • "id": "cfe07be1-2369-433f-be00-eb176008e834",
      • "keywords": [
        • "START"
        ],
      • "op": "start",
      • "resp_text": "Thank you for subscribing.",
      • "updated_at": "2023-03-14T14:46:21.097735+00:00"
      }
    ],
  • "meta": {
    • "page_number": 1,
    • "page_size": 5,
    • "total_pages": 1,
    • "total_results": 3
    }
}
Create Auto-Reponse Setting
SecuritybearerAuth 
Request 
path Parameters
profile_id
required
string (Profile Id) 
 
Request Body schema: application/json
required
country_code
required
string (Country Code) 
 
keywords
required
Array of strings (Keywords) 
 
op
required
string (Op) 
 Enum: "start" "stop" "info"  
resp_text
string (Resp Text) 
 
Responses 
200
Successful Response


Response Schema: application/json
required
object (AutorespConfigSchema) 
 
country_code
required
string (Country Code) 
 
created_at
required
string <date-time>  (Created At) 
 
id
required
string (Id) 
 
keywords
required
Array of strings (Keywords) 
 
op
required
string (Op) 
 Enum: "start" "stop" "info"  
resp_text
string (Resp Text) 
 
updated_at
required
string <date-time>  (Updated At) 
 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
post/messaging_profiles/{profile_id}/autoresp_configs
Request samples 
application/json
{
  • "country_code": "US",
  • "keywords": [
    • "keyword1",
    • "keyword2"
    ],
  • "op": "start",
  • "resp_text": "Thank you for your message"
}
Response samples 
application/json
{
  • "data": {
    • "country_code": "US",
    • "created_at": "2023-03-22T00:06:49.068817+00:00",
    • "id": "c2298f86-a4dc-4cac-b6b6-4a3d01c290fa",
    • "keywords": [
      • "START"
      ],
    • "op": "start",
    • "resp_text": "Hello there!",
    • "updated_at": "2023-03-22T00:06:49.068817+00:00"
    }
}
Delete Auto-Response Setting
SecuritybearerAuth 
Request 
path Parameters
profile_id
required
string <uuid>  (Profile Id) 
 
autoresp_cfg_id
required
string <uuid>  (Autoresp Cfg Id) 
 
Responses 
200
Successful Response


Response Schema: application/json
any
 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
delete/messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id}
Request samples 
Response samples 
application/json
null
Get Auto-Response Setting
SecuritybearerAuth 
Request 
path Parameters
profile_id
required
string <uuid>  (Profile Id) 
 
autoresp_cfg_id
required
string <uuid>  (Autoresp Cfg Id) 
 
Responses 
200
Successful Response


Response Schema: application/json
required
object (AutorespConfigSchema) 
 
country_code
required
string (Country Code) 
 
created_at
required
string <date-time>  (Created At) 
 
id
required
string (Id) 
 
keywords
required
Array of strings (Keywords) 
 
op
required
string (Op) 
 Enum: "start" "stop" "info"  
resp_text
string (Resp Text) 
 
updated_at
required
string <date-time>  (Updated At) 
 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "country_code": "US",
    • "created_at": "2023-03-13T17:51:03.826453+00:00",
    • "id": "adc37adf-d110-4355-9e9a-262847e68e89",
    • "keywords": [
      • "UNSTOP"
      ],
    • "op": "start",
    • "resp_text": "Hello there!",
    • "updated_at": "2023-03-13T17:51:03.826453+00:00"
    }
}
Update Auto-Response Setting
SecuritybearerAuth 
Request 
path Parameters
profile_id
required
string <uuid>  (Profile Id) 
 
autoresp_cfg_id
required
string <uuid>  (Autoresp Cfg Id) 
 
Request Body schema: application/json
required
country_code
required
string (Country Code) 
 
keywords
required
Array of strings (Keywords) 
 
op
required
string (Op) 
 Enum: "start" "stop" "info"  
resp_text
string (Resp Text) 
 
Responses 
200
Successful Response


Response Schema: application/json
required
object (AutorespConfigSchema) 
 
country_code
required
string (Country Code) 
 
created_at
required
string <date-time>  (Created At) 
 
id
required
string (Id) 
 
keywords
required
Array of strings (Keywords) 
 
op
required
string (Op) 
 Enum: "start" "stop" "info"  
resp_text
string (Resp Text) 
 
updated_at
required
string <date-time>  (Updated At) 
 
default
Unexpected error


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
put/messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id}
Request samples 
application/json
{
  • "country_code": "US",
  • "keywords": [
    • "keyword1",
    • "keyword2"
    ],
  • "op": "start",
  • "resp_text": "Thank you for your message"
}
Response samples 
application/json
{
  • "data": {
    • "country_code": "*",
    • "created_at": "2023-03-10T21:54:46.293380+00:00",
    • "id": "54b7e19f-98a8-416f-81d1-a2782eade48b",
    • "keywords": [
      • "START",
      • "BEGIN"
      ],
    • "op": "start",
    • "resp_text": "Hello there!",
    • "updated_at": "2023-03-10T21:54:46.293380+00:00"
    }
}