4.18h

TextMarks API V2 - AutoDoc: TextMarkManager / set_pro_config()

Method: set_pro_config() (POST) - Set Pro Service (ad-free) settings

Package: TextMarkManager - Manage a TextMark owned by authenticated user (... View package)

Args:

Req? Name Type Description Test
REQ auth_user User User account / phone# used for login
REQ auth_pass Password Password
REQ tm TextMark TextMark keyword/TRI owned by auth_user
OPT api_key API Key API Key (Register here)
OPT ad_free Bool (0/1) Ad-free mode enabled on this TextMark?
OPT default_to_ads Bool (0/1) Send with ads when credits empty (else block)?

Test:


Docs:

  • Set Pro Service configuration of the TextMark tm, determining if associated messages will include footer ads (no charge) or be ad free (requiring a Pro Service subscription).
  • TextMark manager must have active Pro Service subscriptions with remaining credits, or else:
    • messages will include ads (if default_to_ads)
    • messages will be blocked (if not default_to_ads)
  • Only options specified will be changed:
    ad_free:
    Primary switch to enable/disable ad-free messaging on the TextMark.
    default_to_ads:
    If ad_free and credits are empty, should messages be sent with ads (true) or blocked (false)?
  • See pro_config() to read the current settings.
  • See RegisteredUser.pro_subscriptions() to check active subscriptions and remaining credits.

Resp:

JSON response.head.rescode==0 for success, or error code otherwise.
JSON-P callback: (as 'jsonp' param, optional) (blank for none)

HTTP:

POST https://api2ssl.textmarks.com//TextMarkManager/set_pro_config/

More:

This page documents a single API function set_pro_config() within the TextMarkManager package of the TextMarks Text Message API.
You may use the interactive form above to invoke this function and observe its actual JSON response.

More resources: