Skip to content
Tallyraydocs

Change a member's role, or hand the account's ownership to them; a change that lowers it ends its sessions

PATCH
/v1/memberships/{id}
curl --request PATCH \
  --url https://example.com/v1/memberships/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "owner": true, "role": "admin" }'

Who: a signed-in user, not an API key. Not for API keys.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
owner
boolean | null
role
string | null
Allowed values: admin manager affiliate advertiser buyer viewer support

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
account
required
object
id
integer format: int64
kind
required
string | null
Allowed values: network affiliate advertiser service workspace
account_name
required
string
created_at
required
string | null 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
id
string
owner
required
boolean
role
required
string | null
Allowed values: admin manager affiliate advertiser buyer viewer support
status
required
string | null
Allowed values: invited active
updated_at
required
string | null format: date-time
user
Any of:
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
email
required
string
email_verified_at
required
string | null format: date-time
id
required
string
last_signed_in_at
required
string | null format: date-time
name
required
string
status
required
string | null
Allowed values: invited unverified active disabled
time_zone
required
string
updated_at
required
string format: date-time
user_id
required
string

Example 

{
  "account": {
    "kind": "network"
  },
  "created_by": {
    "kind": "user"
  },
  "role": "admin",
  "status": "invited",
  "user": {
    "created_by": {
      "kind": "user"
    },
    "status": "invited"
  }
}

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"
  }
}