UpdateBrand - Upbooks API

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

id

string

required

Header Params

ORGANIZATION-ID

string

optional

OrganizationId of your registered business on upbooks

Example:

00000

Body Params application/json

name

string | null

required

description

string | null

required

slug

string | null

optional

picture

array[string] | null

optional

Example

{
    "name": "string",
    "description": "string",
    "slug": "string",
    "picture": [
        "string"
    ]
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request PUT 'https://api.upbooks.io/api/v1/brand/' \
--header 'ORGANIZATION-ID: 00000' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "description": "string",
    "slug": "string",
    "picture": [
        "string"
    ]
}'

Responses

🟢200Ok

application/json

Body

data

object (IBrandDocumentJSON)

required

createdAt

string <date-time>

required

updatedAt

string <date-time>

required

__v

number <double>

optional

_id

string

required

organizationId

string | null

required

name

string | null

required

description

string | null

required

picture

array[string] | null

optional

slug

string | null

optional

count

number <double> | null

optional

message

string

optional

Example

{
    "data": {
        "createdAt": "2019-08-24T14:15:22Z",
        "updatedAt": "2019-08-24T14:15:22Z",
        "__v": 0,
        "_id": "string",
        "organizationId": "string",
        "name": "string",
        "description": "string",
        "picture": [
            "string"
        ],
        "slug": "string",
        "count": 0
    },
    "message": "string"
}

🟢200Success