story

[BETA] post a text or media status/story

Publishes a status update visible to contacts per the user's privacy settings. Provide content for a text status (with optional backgroundColor ARGB integer and fontStyle 0-7) or mediaUrl (plus optional mediaCaption) for an image/video/audio status. Note: This endpoint is currently in beta and may change without notice.

post/instances/{id}/client/action/post-status

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances/{id}/client/action/post-status
  • Auth: HTTP bearer

Path parameters

idinteger required

Instance ID

Request body

contentstring

Text content for a text status, or caption fallback for media

mediaUrlstring uri

Publicly reachable URL of image/video/audio for a media status

mediaCaptionstring

Caption for a media status (overrides content)

mediaNamestring

Optional filename for the downloaded media

backgroundColorinteger

ARGB color for text status background (e.g. 4286070949 = 0xff7acca5)

fontStyleinteger

Font style index for text status, 0 through 7

sendVideoAsGifboolean

Send the video media as a GIF

sendAudioAsVoiceboolean

Send the audio media as a voice note

Example request

{
  "content": "Hello from WaAPI!",
  "mediaUrl": "https://example.com/image.jpg",
  "backgroundColor": 4286070949
}

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation. Payload: Status posted successfully.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

{
  "status": "success",
  "data": {
    "status": "success",
    "data": {
      "posted": true
    }
  },
  "links": {
    "self": "https://waapi.app/api/v1/instances/1/client/action/post-status"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.