penicillin/blue.starry.penicillin.endpoints.welcomemessages/create

create

fun WelcomeMessages.create(    messageData: JsonObject,     name: String? = null,     vararg options: Option): JsonObjectApiAction<WelcomeMessage.Single>
Content copied to clipboard

Creates a new Welcome Message that will be stored and sent in the future from the authenticating user in defined circumstances. Returns the message template if successful. Supports publishing with the same elements as Direct Messages (e.g. Quick Replies, media attachments). Requires a JSON POST body and Content-Type header to be set to application/json. Setting Content-Length may also be required if it is not automatically. See the Welcome Messages overview to learn how to work with Welcome Messages.

Twitter API reference

Receiver

WelcomeMessages endpoint instance.

Return

JsonObjectApiAction for WelcomeMessage.Single model.

Parameters

messageData

The Message Data Object defining the content of the message template. See POST direct_messages/events/new (message_create) for Message Data object details.

name

A human readable name for the Welcome Message. This is not displayed to the user. Max length of 100 alpha numeric characters including hyphens, underscores, spaces, hashes and at signs.

options

Optional. Custom parameters of this request.