WhatsApp: the account, templates, consent and events

GET

/api/v1/workspaces/{workspace}/whatsapp

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/whatsapp"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/whatsapp';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/whatsapp \
  --header 'Authorization: Bearer <token>'

Permission: providers:view

Credentials are write-only: they’re never returned.

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

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

Workspace slug

Responses

200

application/json

object

account

object

businessHint

required

string

businessName

required

string

checkedAt

string format: date-time

connectedAt

required

string format: date-time

connectedBy

required

string

demo

required

boolean

displayName

required

string

held

required

Array<string>

heldCount

required

integer format: int64

required

string

lastEventAt

string format: date-time

limitChangedAt

string format: date-time

messagingLimit

required

integer format: int64

nameStatus

required

string

number

required

string

phoneStatus

required

string

previousLimit

integer format: int64

previousQuality

string

quality

required

string

Allowed values: high medium low unknown

qualityChangedAt

string format: date-time

status

required

string

Allowed values: waiting connected token_rejected

statusDetail

string

statusSince

string format: date-time

templatesSyncedAt

string format: date-time

verifiedAt

string format: date-time

verifyToken

string

webhookUrl

required

string

canManage

required

boolean

canSend

required

boolean

consent

required

integer format: int64

consentLists

required

Array<object>

object

consent

required

integer format: int64

listId

required

string

members

required

integer format: int64

name

required

string

helpers

required

Array<string>

quiet

required

boolean

ratesAsOf

required

string format: date-time

sameWindowAsSms

required

boolean

templateCounts

required

object

approved

required

integer format: int64

other

required

integer format: int64

pending

required

integer format: int64

rejected

required

integer format: int64

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

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

testNumbers

required

Array<string>

webhookUrl

required

string

window

required

string

Example

{
  "account": {
    "quality": "high",
    "status": "waiting"
  },
  "templates": [
    {
      "buttons": [
        {
          "type": "quick_reply"
        }
      ],
      "category": "marketing",
      "status": "approved"
    }
  ]
}

default

Error

application/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"
}