MagicCrates
  • Welcome!
  • Quick Start
  • Getting Started
    • Default Crate
  • Editor In-Game
    • Creating a crate
    • Rewards Preview
  • 🎮Commands
  • Reference
    • API Reference
      • Pets
      • Users
Powered by GitBook
On this page
  1. Reference
  2. API Reference

Pets

Creating a new pet

Create pet.

POST https://api.myapi.com/v1/pet

Creates a new pet.

Request Body

Name
Type
Description

name*

string

The name of the pet

owner_id

string

The id of the user who owns the pet

species

string

The species of the pet

breed

string

The breed of the pet

{
    "name"="Wilson",
    "owner": {
        "id": "sha7891bikojbkreuy",
        "name": "Samuel Passet",
    "species": "Dog",}
    "breed": "Golden Retriever",
}

Good to know: This API method was created using the API Method block, it's how you can build out an API method documentation from scratch. Have a play with the block and you'll see you can do some nifty things like add and reorder parameters, document responses, and give your methods detailed descriptions.

Updating a pet

Good to know: This API method was auto-generated from an example Swagger file. You'll see that it's not editable – that's because the contents are synced to an URL! Any time the linked file changes, the documentation will change too.

PreviousAPI ReferenceNextUsers

Last updated 2 years ago

  • Creating a new pet
  • Create pet.
  • Updating a pet
  • PUTUpdate an existing pet

Update an existing pet

put
Authorizations
Body
idinteger · int64Optional
namestringRequiredExample: doggie
photoUrlsstring[]Required
statusstring · enumOptional

pet status in the store

Possible values:
Responses
400
Invalid ID supplied
404
Pet not found
405
Validation exception
put
PUT /v2/pet HTTP/1.1
Host: petstore.swagger.io
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "id": 1,
  "category": {
    "id": 1,
    "name": "text"
  },
  "name": "doggie",
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}

No content