Create a script

Parameters

Body

application/json

• collection_idstringrequired

  Collection the script goes in (see list_script_collections). It decides the creator.

  format uuid
• namestringrequired

  Name of the script, shown to chatters (1 to 30 characters).

  min length 1max length 30
• context_notestring | null

  Note for the chatters: when and why to send it (1000 characters max).

  max length 1000
• messagesarray of objectsrequired

  The messages of the script, in sending order: 1 to 5.

  min items 1max items 5
  Show fields (4)

  • contentstringrequired

    Text of the message (1 to 500 characters).

    min length 1max length 500
  • price_centsinteger

    Price in euro cents to unlock the media of the message: 0 (free) or 500 to 100000. A paid message needs at least one media. Defaults to 0.

    Default 0min 0max 100000
  • media_idsarray of strings

    MYM media uuids of the creator's vault, in order (20 max). Reuse the media_ids read on the scripts of the same creator.

    Default []format uuidmax items 20
  • is_voiceboolean

    A voice message: media_ids holds exactly one audio of the vault, and nothing else.

    Default false

Response

Created, application/json

• idstringrequired

  Fansquare script id. Path parameter of the /v1/scripts/{script_id} routes, and the script_id of a sequence option.

• creator_idstringrequired

  Fansquare creator id (see GET /v1/creators).

• collection_idstring | nullrequired

  Collection the script belongs to.

• namestringrequired

  Name of the script, as chatters see it in the script panel of the conversation.

• positionintegerrequired

  Order of the script in its collection (0 first).

• context_notestring | nullrequired

  Note for the chatters: when and why to send this script. Never sent to the fan. null without one.

• messagesarray of objectsrequired

  The messages a chatter sends, one after the other, when they pick the script: the first, then up to 4 more.

  Show fields (6)

  • idstringrequired

    Id of this message. The first message has the id of the script itself.

  • contentstringrequired

    Text of the message, sent as written.

  • price_centsintegerrequired

    Price in euro cents to unlock the media of the message (0 = free).

  • media_idsarray of stringsrequired

    MYM media uuids attached to the message, in order.

  • is_voicebooleanrequired

    The message is a voice message: its only media is an audio of the vault.

  • unresolved_media_countintegerrequired

    Media of the message stored under a former MYM id the API cannot serve, left out of media_ids (almost always 0). Above 0, the messages of this script are edited in the app (script_media_unresolved).

• created_atstringrequired

  When the script was created (ISO 8601).

  format date-time
• updated_atstringrequired

  When the script was last changed (ISO 8601).

  format date-time