UPupsmith
authenticated
setup

Write Sms Opt In

put/setup/sms-opt-in

Request

  • Base URL
    https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Headers

organization-idstring nullable
x-user-idstring nullable
timezonestring
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Request body

method'existing_website_form' | 'upsmith_web_embed' required
flow_descriptionstring nullable
additional_consent_copystring nullable
evidence_urlsstring[]
message_frequencystring nullable
help_messagestring nullable
stop_messagestring nullable
terms_urlstring nullable
privacy_urlstring nullable

Response

Successful Response

methodstring nullable
flow_descriptionstring nullable
additional_consent_copystring nullable
consent_languagestring nullable
required_disclosurestring required
evidence_urlsstring[]
message_frequencystring nullable
help_messagestring nullable
stop_messagestring nullable
terms_urlstring nullable
privacy_urlstring nullable
ready_for_submissionboolean required
blockersstring[]

Changes

No recorded changes to this operation across all 1 revision of this API.