Create

API Reference

Vals

Create

client.vals.create(ValCreateParamsbody, RequestOptionsoptions?): idstringauthorAuthorcreatedAtstringdescriptionunionimageUrlunionlinksLinksnamestringprivacyunionVal

post/v2/vals

Create a new val

Parameters

bodynamestringprivacyuniondescriptionstringValCreateParams

Hide ParametersShow Parameters

namestring

minLength1

maxLength48

privacyunion

"public" | "unlisted" | "private"

Hide ParametersShow Parameters

"public"

"unlisted"

"private"

descriptionstring

optional

maxLength64

Returns

idstringauthorAuthorcreatedAtstringdescriptionunionimageUrlunionlinksLinksnamestringprivacyunionVal

HTTPTypeScript

import ValTown from '@valtown/sdk';

const client = new ValTown();

const val = await client.vals.create({ name: 'myVal', privacy: 'public', description: 'My val' });

console.log(val.id);

200 Example

{
  "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
  "author": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "username": "username"
  },
  "createdAt": "2019-12-27T18:11:19.117Z",
  "description": "description",
  "imageUrl": "imageUrl",
  "links": {
    "html": "https://example.com",
    "self": "https://example.com"
  },
  "name": "name",
  "privacy": "public"
}