1. Artigos
Veploy API
  • Visão geral
  • Autenticação
  • Limites de requisição
  • Imóveis
    • Listar imóveis
    • Consultar imóvel
    • Cadastrar imóvel
    • Alterar imóvel
    • Excluir imóvel
    • Restaurar imóvel
    • Enviar foto do imóvel (Beta)
    • Remover foto do imóvel (Beta)
    • Listar tipos de imóvel
  • Proprietários
    • Listar proprietários
    • Consultar proprietário
    • Cadastrar proprietário
    • Alterar proprietário
    • Excluir proprietário
  • Leads
    • Listar leads
    • Consultar lead
    • Criar lead
    • Alterar responsável
    • Atualizar lead
    • Consultar linha do tempo do lead
  • Visitas
    • Listar visitas
    • Consultar visita
    • Agendar visita
    • Alterar visita
  • Propostas
    • Listar propostas
    • Consultar proposta
    • Registrar proposta
    • Alterar proposta
  • Portais
    • Listar portais
    • Consultar portal
    • Listar imóveis do XML
  • Usuários
    • Listar usuários
    • Consultar usuário
    • Consultar permissões do usuário
    • Convidar usuário
    • Alterar ficha do usuário
    • Desativar usuário
    • Reativar usuário
    • Remover usuário
  • Perfis de acesso
    • Listar perfis de acesso
  • Artigos
    • Listar artigos
      GET
    • Criar artigo
      POST
    • Consultar artigo
      GET
    • Alterar artigo
      PATCH
    • Enviar capa do artigo (Beta)
      POST
  • Temas
    • Tema do site
  1. Artigos

Criar artigo

POST
/v1/articles
Cria um artigo do blog do site. Nasce como rascunho, salvo status: published. O slug é derivado do título quando omitido e recebe um sufixo se já existir. Categorias são informadas pelo slug ou pelo nome e criadas quando não existem. A imagem de destaque entra por cover_image_id, o id devolvido por POST /v1/media com purpose=article; vinculada ao artigo, a mídia deixa de expirar. Aceita Idempotency-Key.
Respostas
201: artigo criado; Location aponta para ele.
400: corpo inválido, capa que não resolve (inexistente, de outra finalidade ou vencida sem uso) ou autor que não é membro.
409 ARTICLE_SLUG_TAKEN: outra gravação tomou o mesmo slug no mesmo instante; repita a chamada.

Requisição

Authorization
Bearer Token
Forneça seu token bearer no cabeçalho
Authorization
ao fazer requisições para recursos protegidos.
Exemplo:
Authorization: Bearer ********************
or
Parâmetros de Consulta

Parâmetros Header

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201
application/json
Default Response
Bodyapplication/json

🟠400
🟠401
🟠403
🟠409
🟠422
🔴500
🔴503
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api.veploy.com/v1/articles?expand=author' \
--header 'idempotency-key;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "title": "string",
    "slug": "string",
    "content": "string",
    "excerpt": "string",
    "status": "published",
    "cover_image_id": "string",
    "categories": [
        "string"
    ],
    "tags": [
        "string"
    ],
    "author_id": "78424c75-5c41-4b25-9735-3c9f7d05c59e",
    "published_at": "2019-08-24T14:15:22.123Z"
}'
Response Response Example
201 - Exemplo 1
{
    "data": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "title": "string",
        "slug": "string",
        "status": "published",
        "excerpt": null,
        "content": "string",
        "cover_image_id": null,
        "cover_image_url": null,
        "categories": [
            {
                "slug": "string",
                "name": "string"
            }
        ],
        "tags": [
            "string"
        ],
        "author_id": "78424c75-5c41-4b25-9735-3c9f7d05c59e",
        "author": {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "name": "string",
            "email": "string",
            "phone": "string",
            "cpf": "string",
            "creci": "string",
            "birth_date": "string",
            "avatar_url": "string",
            "role": "string",
            "status": "active",
            "lead_distribution_enabled": true,
            "username": "string",
            "invited_at": "2019-08-24T14:15:22.123Z",
            "email_confirmed_at": "2019-08-24T14:15:22.123Z",
            "created_at": "2019-08-24T14:15:22.123Z"
        },
        "published_at": "2019-08-24T14:15:22.123Z",
        "created_at": "2019-08-24T14:15:22.123Z",
        "updated_at": "2019-08-24T14:15:22.123Z"
    }
}
Modificado em 2026-11-12 20:13:31
Página anterior
Listar artigos
Próxima página
Consultar artigo
Built with