PATCH
/
inboxes
/
Update Inbox
curl --request PATCH \
  --url https://api-staging.boost.xyz/inboxes/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "config": {
    "features": [
      "boost-blitz"
    ],
    "supportedActionTypes": [
      "bridge"
    ],
    "projects": [
      {
        "ids": [
          "<string>"
        ],
        "name": "<string>"
      }
    ],
    "rewardTokenNetworks": [
      "<string>"
    ],
    "rewardTokenAddresses": [
      "<any>"
    ],
    "referrerAddress": "<any>",
    "theme": {},
    "logo": "<string>",
    "tags": [
      "<string>"
    ],
    "creatorAddresses": [
      "<any>"
    ],
    "sortBy": "<string>"
  },
  "draft": true
}'
{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "draft": true,
  "config": {
    "features": [
      "boost-blitz"
    ],
    "supportedActionTypes": [
      "bridge"
    ],
    "projects": [
      {
        "ids": [
          "<string>"
        ],
        "name": "<string>"
      }
    ],
    "rewardTokenNetworks": [
      "<string>"
    ],
    "rewardTokenAddresses": [
      "<any>"
    ],
    "referrerAddress": "<any>",
    "theme": {},
    "logo": "<string>",
    "tags": [
      "<string>"
    ],
    "creatorAddresses": [
      "<any>"
    ],
    "sortBy": "<string>"
  },
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

inboxId
string<uuid>
inboxSlug
string

Body

application/json

The base configuration required to update an Inbox. If provided, the Inbox's name will be slugified for alternative lookup.

name
string
config
object
draft
boolean

Response

Success

id
string
required
name
string
required
slug
string
required
draft
boolean
required
config
object
required
createdAt
string
required
updatedAt
string
required