Skip to content
Tallyraydocs

Rename your workspace: its owner; its slug never changes

PATCH
/v1/buyer/workspace
curl --request PATCH \
  --url https://example.com/v1/buyer/workspace \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example" }'

Who: a workspace’s owner. Not for API keys.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
string | null

Example generated

{
  "name": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
created_at
required
string format: date-time
created_by
required
Any of:
object
account
string
id
string
kind
required
string | null
Allowed values: user api_key service system postback rule tuner schedule
name
string
entitlement
required
object
ends_at
required
string | null format: date-time
hold
required
string | null
Allowed values: staff billing expired
limits
required
object
connections
required
integer format: int32
custom_domains
required
integer format: int32
members
required
integer format: int32
private_templates
required
boolean
retention
string
Allowed values: days_90 days_180 days_400
visits_per_month
required
integer format: int64
plan
required
string
product
required
string | null
Allowed values: buyer_tracker
source
required
string | null
Allowed values: grant billing
starts_at
required
string | null format: date-time
status
required
string | null
Allowed values: active suspended ended pending
status_reason
required
string
suspended_at
required
string | null format: date-time
updated_at
required
string | null format: date-time
updated_by
required
Any of:
object
account
string
id
string
kind
required
string | null
Allowed values: user api_key service system postback rule tuner schedule
name
string
id
required
integer format: int64
name
required
string
sequence
required
integer format: int64
slug
required
string
updated_at
required
string format: date-time

Example 

{
  "created_by": {
    "kind": "user"
  },
  "entitlement": {
    "hold": "staff",
    "limits": {
      "retention": "days_90"
    },
    "product": "buyer_tracker",
    "source": "grant",
    "status": "active",
    "updated_by": {
      "kind": "user"
    }
  }
}

default

Section titled “default”

An error, as go-commons apperr maps it

Media typeapplication/json
object
error
required
object
code
required
string
fields
object
key
additional properties
string
message
required
string

Example generated

{
  "error": {
    "code": "example",
    "fields": {
      "additionalProperty": "example"
    },
    "message": "example"
  }
}