A WhatsApp step's templates, reach, estimated cost and preview

POST

/api/v1/workspaces/{workspace}/whatsapp/step-estimate

curl --request POST \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/whatsapp/step-estimate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "consentListId": "example", "fallbackTemplate": "example", "language": "example", "mode": "template", "template": "example", "variables": [ { "fallback": "example", "field": "example", "key": "example", "source": "field", "text": "example" } ] }'

• Your ReputeCast public URL

Permission: automations:view

Authorizations

• bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

Request Body^required

Media typeapplication/json

object

consentListId

string

<= 40 characters

fallbackTemplate

string

<= 512 characters

language

string

<= 16 characters

mode

string

Allowed values: template text ""

template

string

<= 512 characters

variables

Array<object>

<= 20 items

object

fallback

string

<= 500 characters

field

string

<= 64 characters

key

required

string

<= 8 characters

source

required

string

Allowed values: field text

text

string

<= 500 characters

Responses

200

OK

Media typeapplication/json

object

business

object

displayName

required

string

number

required

string

connected

required

boolean

consent

required

integer format: int64

cost

required

object

amount

required

number format: double

byCountry

required

Array<object>

object

amount

required

number format: double

country

required

string

messages

required

integer format: int64

price

required

number format: double

category

required

string

messages

required

integer format: int64

ratesAsOf

required

string format: date-time

fields

required

Array<object>

object

key

required

string

label

required

string

open

required

integer format: int64

preview

object

buttons

required

Array<object>

object

text

required

string

type

required

string

Allowed values: quick_reply url phone_number other

url

string

contact

required

string

contactId

string

fallbacks

required

Array<object>

object

fallback

required

string

field

required

string

key

required

string

firstName

string

text

required

string

quiet

required

boolean

templates

required

Array<object>

object

body

required

string

buttons

required

Array<object>

object

text

required

string

type

required

string

Allowed values: quick_reply url phone_number other

url

string

category

required

string

Allowed values: marketing utility authentication

id

required

string

language

required

string

languageLabel

required

string

name

required

string

reason

string

reasonCode

string

status

required

string

Allowed values: approved pending rejected paused disabled in_appeal other

statusSince

string format: date-time

syncedAt

required

string format: date-time

variables

required

Array<object>

object

example

string

key

required

string

label

required

string

window

required

string

windowExample

object

name

required

string

until

required

string format: date-time

Example

{
  "preview": {
    "buttons": [
      {
        "type": "quick_reply"
      }
    ]
  },
  "templates": [
    {
      "buttons": [
        {
          "type": "quick_reply"
        }
      ],
      "category": "marketing",
      "status": "approved"
    }
  ]
}

default

Error

Media typeapplication/problem+json

object

code

Stable error code, e.g. permission_denied

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object>

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

helpers

Members who hold the missing permission

Array<string>

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

meta

object

key

additional properties

permission

The missing permission key

string

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}