Sign in
latestOpenAPI 3.1.02026-08-18893023.3 MB

c78a716de420

WhatsApp Templates

Update a template in project

Updates a template DRAFT.

Note that it is not possible to update all fields for a template,
if you want to update a field that is not supported you will need to delete the draft and create a new one.

Update a template REJECTED / APPROVED / PAUSED / DISABLED

It is possible to update templates that have been rejected, approved, paused or disabled, we will automatically set the status to draft when update a rejected template.
patch/v1/projects/{projectId}/whatsapp/templates/{templateName}/languages/{languageCode}

Path parameters

projectIdstring required

The unique ID of the project. You can find this on the <a href="https://dashboard.sinch.com/">Sinch Dashboard</a>.

templateNamestring required

The unique name of the template.

languageCode'AF' | 'AR' | 'AZ' | 'BG' | 'BN' | 'CA' | 'CS' | 'DA' | 'DE' | 'EL' | 'EN' | 'EN_GB' | 'EN_US' | 'ES' | 'ES_AR' | 'ES_ES' | 'ES_MX' | 'ES_UY' | 'ET' | 'FA' | 'FI' | 'FIL' | 'FR' | 'GA' | 'GU' | 'HA' | 'HE' | 'HI' | 'HR' | 'HU' | 'ID' | 'IT' | 'JA' | 'KA' | 'KK' | 'KN' | 'KO' | 'KY_KG' | 'LO' | 'LT' | 'LV' | 'MK' | 'ML' | 'MR' | 'MS' | 'NB' | 'NL' | 'PA' | 'PL' | 'PT_BR' | 'PT_PT' | 'RO' | 'RU' | 'RW_RW' | 'SK' | 'SL' | 'SQ' | 'SR' | 'SV' | 'SW' | 'TA' | 'TE' | 'TH' | 'TR' | 'UK' | 'UR' | 'UZ' | 'VI' | 'ZH_CN' | 'ZH_HK' | 'ZH_TW' | 'ZU' | 'UNRECOGNIZED' required

The language code of the specific template.

Request body

status'DRAFT' | 'SUBMIT'

Create as draft or submit. Defaults to draft.

category'AUTHENTICATION' | 'MARKETING' | 'UTILITY'

Works if status template is DRAFT or it was rejected with INCORRECT_CATEGORY.

allowCategoryChangeboolean

Works if status template is DRAFT or it was rejected with INCORRECT_CATEGORY True if Meta should be allowed to change the category if they determine the category is wrong. If false, Meta might reject the template if they determine the category is wrong based on the template contents. Defaults to false.

Response

Updated template draft

whatsappIdstring
state'APPROVED' | 'DISABLED' | 'PAUSED' | 'PENDING' | 'REJECTED'
namestring required
language'AF' | 'AR' | 'AZ' | 'BG' | 'BN' | 'CA' | 'CS' | 'DA' | 'DE' | 'EL' | 'EN' | 'EN_GB' | 'EN_US' | 'ES' | 'ES_AR' | 'ES_ES' | 'ES_MX' | 'ES_UY' | 'ET' | 'FA' | 'FI' | 'FIL' | 'FR' | 'GA' | 'GU' | 'HA' | 'HE' | 'HI' | 'HR' | 'HU' | 'ID' | 'IT' | 'JA' | 'KA' | 'KK' | 'KN' | 'KO' | 'KY_KG' | 'LO' | 'LT' | 'LV' | 'MK' | 'ML' | 'MR' | 'MS' | 'NB' | 'NL' | 'PA' | 'PL' | 'PT_BR' | 'PT_PT' | 'RO' | 'RU' | 'RW_RW' | 'SK' | 'SL' | 'SQ' | 'SR' | 'SV' | 'SW' | 'TA' | 'TE' | 'TH' | 'TR' | 'UK' | 'UR' | 'UZ' | 'VI' | 'ZH_CN' | 'ZH_HK' | 'ZH_TW' | 'ZU' | 'UNRECOGNIZED' required
category'AUTHENTICATION' | 'MARKETING' | 'UTILITY' | 'UNRECOGNIZED' required
rejectionCode'ABUSIVE_CONTENT' | 'INCORRECT_CATEGORY' | 'INVALID_FORMAT' | 'NONE' | 'SCAM' | 'UNRECOGNIZED'

Rejection code if template is in status 'REJECTED'

qualityScore'QUALITY_SCORE_GREEN' | 'QUALITY_SCORE_RED' | 'QUALITY_SCORE_YELLOW' | 'QUALITY_SCORE_UNKNOWN' | 'UNRECOGNIZED'

Quality score of the HSM.

isMetaGeneratedboolean required

Indicates if the template was auto-generated by Meta.