Incluir a carteirinha no Network do Vimine ou retirá-la dele

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

Autorizações

• BearerToken
  network:manage

Corpo da requisição^obrigatório

Tipo de mídiaapplication/json

object

opt_in

obrigatório

boolean

Exemplo^gerado

{
  "opt_in": true
}

Respostas

200

O novo estado

Tipo de mídiaapplication/json

object

network_opt_in

boolean

network_opt_in_at

string formato: date-time

nullable

Exemplo^gerado

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

400

Requisição inválida

Tipo de mídiaapplication/problem+json

object

type

obrigatório

string formato: uri

title

obrigatório

string

status

obrigatório

integer

detail

string

code

obrigatório

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Exemplo^gerado

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

401

Credenciais ausentes ou inválidas

Tipo de mídiaapplication/problem+json

object

type

obrigatório

string formato: uri

title

obrigatório

string

status

obrigatório

integer

detail

string

code

obrigatório

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Exemplo^gerado

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

403

Não permitido

Tipo de mídiaapplication/problem+json

object

type

obrigatório

string formato: uri

title

obrigatório

string

status

obrigatório

integer

detail

string

code

obrigatório

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Exemplo^gerado

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

404

Não encontrado

Tipo de mídiaapplication/problem+json

object

type

obrigatório

string formato: uri

title

obrigatório

string

status

obrigatório

integer

detail

string

code

obrigatório

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Exemplo^gerado

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

409

O tipo de carteirinha não é elegível para o Network (not_eligible)

429

Limite de requisições excedido

Tipo de mídiaapplication/problem+json

object

type

obrigatório

string formato: uri

title

obrigatório

string

status

obrigatório

integer

detail

string

code

obrigatório

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Exemplo^gerado

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

500

Erro interno

Tipo de mídiaapplication/problem+json

object

type

obrigatório

string formato: uri

title

obrigatório

string

status

obrigatório

integer

detail

string

code

obrigatório

string

request_id

string

errors

Array<object>

object

field

string

code

string

message

string

Exemplo^gerado

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