Request Contact Info

post

https://partner.gupshup.io/partner/app/{appId}/template/msg

Use this API to send messages using the Request Contact Info template.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Note:

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

Sample Request:

curl --location 'https://qa-partner-api.smsgupshup.dev/partner/app/{{APP_ID}}/template/msg' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'source={source}' \
--data-urlencode 'sandbox=false' \
--data-urlencode 'template={"id": "79f682a1-3367-4f1e-9e79-c972b60ca339","params": ["A-10293"]}' \
--data-urlencode 'src.name=safari' \
--data-urlencode 'userId=USERID'

Sample Response:

{
    "status": "submitted",
    "messageId": "8893bef1-9abf-4539-89d6-6293fe4c7785"
}

Path Params

appId

uuid

required

Partner app id (UUID).

Form Data

Form-encoded template-send body. Mirrors WhatsappSendTemplateMessageFormSchema, plus the
userId field the route forwards but does not declare. Unlisted fields are passed through
to WASS as-is.

source

string

required

Sender phone in E.164 without +. Must be a number registered on the app.

template

string

required

Template payload as a JSON string — see TemplatePayload. Carries the approved
template id and the positional params for its body variables.

destination

string

Recipient phone in E.164 without +. Required unless the recipient is addressed by
userId. Do not put an MSISDN in userId — the send is accepted, then fails with
code: 100 and an empty recipient_id.

userId

string

Recipient BSUID, an alternative to destination on WABAs enabled for BSUID
addressing. Not declared on WhatsappSendTemplateMessageFormSchema, but the route
binds a MultiValueMap and forwards it upstream.

src.name

string

Sender display name (app name) shown on the message.

sandbox

string

enum

Defaults to false

Whether to use the sandbox route.

Allowed:

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Note:

Sample Request:

Sample Response:

200Accepted by WASS for delivery. status is submitted; delivery is confirmed later on the status webhook, keyed by messageId.

400Rejected by Partner Portal or by WASS — unknown or unapproved template id, a params count that does not match the template's variables, a missing addressee, or a malformed template JSON.

401Unauthorized — missing or invalid app API key.

403Forbidden — the key has no permission on this app.

404App or template not found.

500Internal server error.