> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.erp.olist.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Alterar Tag

> Serviço destinado a fazer alteração de Tags.

## Endpoint

```
POST https://api.tiny.com.br/api2/tag.alterar.php
```

## Parâmetros

| Parâmetro | Tipo   | Ocorrência  | Descrição                 |
| --------- | ------ | ----------- | ------------------------- |
| token     | string | obrigatório | Chave de autenticação     |
| tag       | object | obrigatório | Dados com tags a alterar  |
| formato   | string | obrigatório | Formato do retorno (json) |

### Estrutura do parâmetro "tag"

| Campo                 | Tipo    | Tamanho | Ocorrência  | Descrição                |
| --------------------- | ------- | ------- | ----------- | ------------------------ |
| tags\[].tag.sequencia | inteiro | -       | obrigatório | Identificador sequencial |
| tags\[].tag.id        | inteiro | -       | obrigatório | ID da tag a localizar    |
| tags\[].tag.nome      | string  | 50      | obrigatório | Nome da tag              |
| tags\[].tag.id\_grupo | inteiro | -       | obrigatório | ID do grupo de tags      |

## Retorno

| Campo                                   | Tipo   | Ocorrência  | Descrição              |
| --------------------------------------- | ------ | ----------- | ---------------------- |
| retorno.status\_processamento           | int    | obrigatório | Código de status       |
| retorno.status                          | string | obrigatório | "OK" ou "Erro"         |
| retorno.codigo\_erro                    | int    | condicional | Código conforme tabela |
| retorno.registros\[].registro.sequencia | int    | condicional | Sequencial             |
| retorno.registros\[].registro.status    | string | condicional | "OK" ou "Erro"         |
| retorno.registros\[].registro.id        | int    | condicional | ID da tag              |

## Exemplo de chamada

```php theme={null}
$url = 'https://api.tiny.com.br/api2/tag.alterar.php';
$data = "token=$token&tag=$tag&formato=JSON";
```

## Exemplos de retorno

### Sucesso

```json theme={null}
{
  "retorno": {
    "status_processamento": 3,
    "status": "OK",
    "registros": [
      {
        "registro": {
          "sequencia": "1",
          "status": "OK",
          "id": "37644544"
        }
      }
    ]
  }
}
```

### Erro

```json theme={null}
{
  "retorno": {
    "status_processamento": 1,
    "status": "Erro",
    "codigo_erro": 2,
    "erros": [{"erro": "token invalido"}]
  }
}
```
