Contents

POST [/instances/$INSTANCES]/private/pots#

This is used to create a pot.

Required permission: pots-write

Request:

The request must be a PotAddRequest.

Response:

200 OK:

The backend has successfully added a new pot. Returns a PotAddedResponse.

404 Not found:

The merchant instance is unknown.

Details:

interface PotAddRequest {

  // Description of the pot. Possibly included
  // in the pot message.
  description: string;

  // Name of the pot. Must be unique per instance.
  pot_name: string;

}
interface PotAddedResponse {

  // Unique ID for the pot.
  pot_serial_id: Integer;

}