Opt the membership in or out of the Vimine network

PATCH

/v1/me/membership/network-opt-in

curl --request PATCH \
  --url https://api.vimine.network/v1/me/membership/network-opt-in \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "opt_in": true }'

• Vimine API

Authorizations

• BearerToken
  network:manage

Request Body^required

Media typeapplication/json

object

opt_in

required

boolean

Example^generated

{
  "opt_in": true
}

Responses

200

The new state

Media typeapplication/json

object

network_opt_in

boolean

network_opt_in_at

string format: date-time

nullable

Example^generated

{
  "network_opt_in": true,
  "network_opt_in_at": "2026-04-15T12:00:00Z"
}

400

Invalid request

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

detail

string

code

required

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Example^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

401

Missing or invalid credentials

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

detail

string

code

required

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Example^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

403

Not allowed

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

detail

string

code

required

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Example^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

404

Not found

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

detail

string

code

required

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Example^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

409

The membership type is not network-eligible (not_eligible)

429

Rate limited

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

detail

string

code

required

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Example^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}

500

Internal error

Media typeapplication/problem+json

object

type

required

string format: uri

title

required

string

status

required

integer

detail

string

code

required

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Example^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "code": "example",
  "request_id": "example",
  "errors": [
    {
      "field": "example",
      "code": "example",
      "message": "example"
    }
  ]
}