Saltar a contenido

Mover timbres

Mueve timbres libres entre la cuenta del distribuidor (own) y sus clientes, en cualquier sentido; los reservados no se mueven. Cada llamada mueve timbres. Devuelve el id del movimiento, las dos cuentas, la cantidad y los timbres libres de cada una después. Errores: invalid_input, y con más de los libres de la cuenta de origen data.free dice cuántos hay; not_found, invalid_state si una cuenta está cerrada, workspace_suspended, forbidden.

Alcance (scope): cefidia:write · Características: —

Parámetros

Parámetro Tipo Obligatorio Descripción
from texto Sí Cuenta de la que salen los timbres: id o nombre de un cliente, o own.
to texto Sí Cuenta que los recibe: id o nombre de un cliente, o own.
count entero Sí Cantidad de timbres libres a mover.
note texto No Nota del movimiento.

Esquema de entrada (JSON Schema)

{
  "additionalProperties": false,
  "properties": {
    "from": {
      "description": "Cuenta de la que salen los timbres: id o nombre de un cliente, o own.",
      "maxLength": 300,
      "title": "From",
      "type": "string"
    },
    "to": {
      "description": "Cuenta que los recibe: id o nombre de un cliente, o own.",
      "maxLength": 300,
      "title": "To",
      "type": "string"
    },
    "count": {
      "description": "Cantidad de timbres libres a mover.",
      "minimum": 1,
      "title": "Count",
      "type": "integer"
    },
    "note": {
      "anyOf": [
        {
          "maxLength": 200,
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "default": null,
      "description": "Nota del movimiento.",
      "title": "Note"
    }
  },
  "required": [
    "from",
    "to",
    "count"
  ],
  "title": "MoveStampsInput",
  "type": "object"
}