Atualizar uma tag de contato

PATCH

api

contact-tags

{tagId}

Update a contact tag

curl --request PATCH \
  --url https://levios.app/api/v1/contact-tags/{tagId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<unknown>"
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', name: '<unknown>'})
};

fetch('https://levios.app/api/v1/contact-tags/{tagId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://levios.app/api/v1/contact-tags/{tagId}"

payload = {
    "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<unknown>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "error": {
    "code": "api_invalid_content_length",
    "message": "Invalid Content-Length.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_unauthorized",
    "message": "Authentication required.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_account_not_granted",
    "message": "This credential is not authorized for the request.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_contact_tag_not_found",
    "message": "The requested contact tag was not found.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_contact_tag_conflict",
    "message": "A contact tag with that name already exists.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_body_too_large",
    "message": "The JSON request body exceeds 1 MiB.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_unsupported_media_type",
    "message": "Content-Type must be application/json.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_contact_tag_invalid",
    "message": "The contact tag is invalid.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_contact_tag_response_unavailable",
    "message": "The contact tag changed, but its response could not be verified. Do not retry automatically.",
    "correlation_id": "<string>",
    "details": {
      "committed": true,
      "retryable": false
    }
  }
}

{
  "error": {
    "code": "api_account_resolution_unavailable",
    "message": "The reachable account set could not be read.",
    "correlation_id": "<string>"
  }
}

Renomeie a tag identificada por tagId. A levios também atualiza o nome da tag nas atribuições atuais dos contatos. Sua chave de API precisa do escopo contacts:write. A tag e o account_id devem pertencer a uma conta do Instagram que a chave possa acessar.

Corpo da requisição

Envie exatamente estes campos:

account_id: o UUID da conta do Instagram.
name: o novo nome da tag.

A levios remove os espaços nas extremidades de name e reduz sequências de espaços em branco a um único espaço. O nome normalizado deve ter de 1 a 50 caracteres. A entrada bruta pode ter no máximo 200 caracteres, e o resultado normalizado não pode conter caracteres de controle.

curl --request PATCH \
  --url "https://levios.app/api/v1/contact-tags/${LEVIOS_TAG_ID}" \
  --header "Authorization: Bearer ${LEVIOS_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data @- <<JSON
{
  "account_id": "${LEVIOS_ACCOUNT_ID}",
  "name": "Qualified Lead"
}
JSON

Restrições para renomear

A API retorna api_contact_tag_conflict quando outra tag já usa o nome normalizado. Ela retorna api_contact_tag_in_use quando uma configuração de automação faz referência ao nome atual. Atualize essas configurações antes de renomear a tag. Enviar o nome normalizado atual da tag não a altera e retorna a tag atual. A operação é idempotente.

Se a API retornar api_contact_tag_response_unavailable com committed: true e retryable: false, a tag mudou, mas não foi possível verificar a resposta. Não tente novamente de forma automática. Leia o catálogo de tags atual antes de decidir se deve enviar outra requisição.

Autorizações

Authorization

string

header

obrigatório

Levios API key sent as a Bearer token.

Parâmetros de caminho

tagId

string<uuid>

obrigatório

Corpo

application/json

account_id

string<uuid>

obrigatório

name

any

obrigatório

Resposta

Successful response.

Update a contact tag

curl --request PATCH \
  --url https://levios.app/api/v1/contact-tags/{tagId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<unknown>"
}
'

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({account_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a', name: '<unknown>'})
};

fetch('https://levios.app/api/v1/contact-tags/{tagId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://levios.app/api/v1/contact-tags/{tagId}"

payload = {
    "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<unknown>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

{
  "error": {
    "code": "api_invalid_content_length",
    "message": "Invalid Content-Length.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_unauthorized",
    "message": "Authentication required.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_account_not_granted",
    "message": "This credential is not authorized for the request.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_contact_tag_not_found",
    "message": "The requested contact tag was not found.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_contact_tag_conflict",
    "message": "A contact tag with that name already exists.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_body_too_large",
    "message": "The JSON request body exceeds 1 MiB.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_unsupported_media_type",
    "message": "Content-Type must be application/json.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_contact_tag_invalid",
    "message": "The contact tag is invalid.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded.",
    "correlation_id": "<string>"
  }
}

{
  "error": {
    "code": "api_contact_tag_response_unavailable",
    "message": "The contact tag changed, but its response could not be verified. Do not retry automatically.",
    "correlation_id": "<string>",
    "details": {
      "committed": true,
      "retryable": false
    }
  }
}

{
  "error": {
    "code": "api_account_resolution_unavailable",
    "message": "The reachable account set could not be read.",
    "correlation_id": "<string>"
  }
}

Referência

Automações

Contas

Contatos

Tags de contato

Métricas

Atualizar uma tag de contato

Corpo da requisição

Restrições para renomear

Autorizações

Parâmetros de caminho

Corpo

Resposta

​Corpo da requisição

​Restrições para renomear

Autorizações

Parâmetros de caminho

Corpo

Resposta

Corpo da requisição

Restrições para renomear