Request Contact Info

Creates the template on the given app and submits it to Meta for approval

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Rate limit:

10 requests per 60 seconds.

Note:

Templates that carry a REQUEST_CONTACT_INFO button can only be of the marketing or utility category.

Button constraints


  1. Only one button is allowed — it cannot be combined with URL, QUICK_REPLY, or any other button type.
  2. Button text is fixed per language and cannot be customised; Meta enforces a localised string per language code.
  3. Do not include parameter values when sending the template — the button text is not a variable.

Localised button text by language


The button text is auto-localised by Meta based on the template language code. The en string differs from en_GB (lowercase), so always send the value Meta expects for the chosen locale.

Language codeRequired button textStatus
enShare Contact InfoWorks
en_USShare Contact InfoWorks
en_GBShare contact info (lowercase c, i)Works
hiकॉन्टैक्ट जानकारी शेयर करेंWorks
esCompartir información de contactoWorks

Sample Request (Marketing):

curl --location 'https://qa-partner-api.smsgupshup.dev/partner/app/{{APP_ID}}/templates' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'elementName=safari_req_contact_info_mm' \
--data-urlencode 'languageCode=en' \
--data-urlencode 'content=Hello! We have an update regarding your transaction. Could you please share your contact details?' \
--data-urlencode 'category=MARKETING' \
--data-urlencode 'vertical=AAA' \
--data-urlencode 'templateType=TEXT' \
--data-urlencode 'example=Hello! We have an update regarding your transaction. Could you please share your contact details?' \
--data-urlencode 'allowTemplateCategoryChange=false' \
--data-urlencode 'checkerApprovalRequired=false' \
--data-urlencode 'enableSample=false' \
--data-urlencode 'buttons=[{"type":"REQUEST_CONTACT_INFO","text":"Share Contact Info"}]'

Sample Request (Utility):

curl --location 'https://qa-partner-api.smsgupshup.dev/partner/app/{{APP_ID}}/templates' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'elementName=safari_req_contact_info_ut' \
--data-urlencode 'languageCode=en' \
--data-urlencode 'content=Your order {{1}} is out for delivery. Please share your contact so the courier can reach you.' \
--data-urlencode 'category=UTILITY' \
--data-urlencode 'vertical=AAA' \
--data-urlencode 'templateType=TEXT' \
--data-urlencode 'example=Your order [A-10293] is out for delivery. Please share your contact so the courier can reach you.' \
--data-urlencode 'allowTemplateCategoryChange=false' \
--data-urlencode 'enableSample=true' \
--data-urlencode 'buttons=[{"type":"REQUEST_CONTACT_INFO","text":"Share Contact Info"}]'
Path Params
uuid
required

Partner app id (UUID).

Form Data

Form-encoded create-template body. Unlisted fields are forwarded upstream as-is.

string
required

Unique template name on the app. Lowercase letters, digits and underscores.

string
required

Meta language code. Case matters for regional variants (en_GB, not en_gb) and it
determines the required REQUEST_CONTACT_INFO caption.

string
required

Template body / HSM content. Variables use {{1}}, {{2}}, … .

string
enum
required

Template category. REQUEST_CONTACT_INFO is accepted on MARKETING and UTILITY
only; AUTHENTICATION is rejected.

Allowed:
string

Internal label / use-case tag for the template.

string
enum

Media type of the template.

Allowed:
string

Sample rendering of content with variables filled in. Required by Meta when
content has variables — Your order {{1}} …Your order [A-10293] ….

string
required

JSON array carrying exactly one REQUEST_CONTACT_INFO object — see TemplateButton.
Serialized into a single form field; send it with --data-urlencode.

string

Header text, when the template has one.

string

Sample header used for approval, when header has variables.

string
string
enum
Defaults to false

Allow Meta to reassign the category during approval.

Allowed:
string
enum
Defaults to false

Route the template through the maker–checker flow before submission.

Allowed:
string
enum
Defaults to false

Send the example value to Meta as the template sample. Note that the stored
containerMeta.enableSample comes back true whenever example was supplied, even
when the request sent false.

Allowed:
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json