sketchboard blog

Sketchboard API

By Saiki Tanabe Aug 15, 2014

Create Board

Creates a board and shares the board on a default team of the user.

POST https://sketchboard.me/api/v1/board/new/:application_secret_key

Content-Type: application/json

Parameters

NameDescription
user_email Required User in Sketchboard.io service. Board will be created on a user_email default team and always shared between team members even if board_password is given.
board_name Name of the board to be created.
add_users Users to be added on user_email default team. user_email needs to be admin of the team.
board_password Sets password to the board to allow anonymous access.
{
  "user_email" : "test.dude@company.com",
  "board_name" : "Hello Sketch",
  "board_password" : "this is a secret",
  "add_users" : ["team.member1@company.com", "team.member2@company.com"]
}

Response

NameDescription
url Sketchboard.io service URL. Either a direct board URL or next step to be done, like sign up at Sketchboard.io.
status

Status values above 0 means, board was created, but there was some error.
Status value 0 mean, request was successful
Status values below 0 means, board was not created.

Status values:
2: Board created, but you are not admin of the team and cannot add new users.
1: Board created, but members not added. Current plan doesn't support this many members.
0: Board created
-1: User not found
-2: Trial expired
-3: Subscription expired
-5: Unknown error
msg Human readable status message. See mapped status messages.
board_name Optional If board name is given in the request.
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

Example: Successful Response

{
	"url":"https://sketchboard.me/<created board id>",
	"status":0,
	"board_name":"Hello Project",
	"msg":"Board created"
}

Example: Failure Response

{
	"url":"https://sketchboard.me/service/signup",
	"status":-1,
	"msg":"User not found"
}

Example: Create Board Request

curl -H "Content-Type: application/json" -XPOST 
	'https://sketchboard.me/api/v1/board/new/:application_key' -d '
{
  "user_email" : "test.dude@company.com",
  "board_name" : "Hello Sketch",
  "board_password" : "this is a secret",
  "add_users" : ["team.member1@company.com", "team.member2@company.com"]
}'