👍
Estrutura de Pastas
Com esta funcionalidade, você poderá gerenciar as pastas do seu sistema de arquivo na Clicksign.

📘
Requisição para a criação de Pastas na Clicksign. Esta é uma requisição POST para /api/v3/folders. No body, deverão ser enviados os atributos da pasta.

POST /api/v3/folders HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token

Tipo de dados

Atributo	Descrição	Obrigatório
`type`	Determina o tipo de dados, que aqui deve ser `folders`.	Sim

Atributos para criação da Pasta

Atributo	Descrição	Obrigatório	Padrão
`name`	Nome da Pasta a ser criada.	Sim	Sem valor padrão

Relações da Pasta [OPCIONAL]

Para definir uma Pasta Origem em relationships deve ser indicado o folder, descritos a seguir:

Atributo	Descrição	Obrigatório	Padrão
relationships	Um objeto com as relações do requisito com outros recursos. Em `\"type\": \"folders\", \"id\": \"{{folder_id}}\"` adicione o `id` gerado ao criar uma pasta."	Não	Sem valor padrão

❗️
Se a requisição para a Clicksign falhar
Sempre verifique o BODY da resposta. O retorno da requisição mostrará o motivo pelo qual a requisição não foi aceita pelos servidores da Clicksign. Confira mais detalhes em Mensagens de erro.

Exemplo de Criação de Pasta na Pasta Raiz

Request

POST /api/v3/folders HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token

{
  "data": {
    "type": "folders",
    "attributes": {
      "name": "Pasta 1"
    }
  }
}

Response

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json; charset=utf-8

{
  "data": {
    "id": "2e600d78-cf8a-4856-9b9a-3d90ae44563c",
    "type": "folders",
    "links": {
      "self": "https://sandbox.clicksign.com/api/v3/folders/2e600d78-cf8a-4856-9b9a-3d90ae44563c"
    },
    "attributes": {
      "name": "Pasta 1",
      "path": "",
      "in_root": true,
      "created": "2024-06-28T17:56:22.910-03:00",
      "modified": "2024-06-28T17:56:22.915-03:00"
    }
  }
}

Exemplo de Criação com Pasta Origem

Request

POST api/v3/folders HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json

{
  "data": {
    "type": "folders",
    "attributes": {
      "name": "Pasta 1.1"
    },
    "relationships": {
      "folder": {
        "data": {
          "id": "2e600d78-cf8a-4856-9b9a-3d90ae44563c",
          "type": "folders"
        }
      }
    }
  }
}

Response

HTTP/1.1 201 Created
Content-Type: application/vnd.api+json; charset=utf-8

{
  "data": {
    "id": "17790e58-132d-4a3b-b602-1cf0320370c6",
    "type": "folders",
    "links": {
      "self": "https://sandbox.clicksign.com/api/v3/folders/17790e58-132d-4a3b-b602-1cf0320370c6"
    },
    "attributes": {
      "name": "Pasta 1.1",
      "path": "/Pasta 1",
      "in_root": false,
      "created": "2024-06-28T17:56:22.910-03:00",
      "modified": "2024-06-28T17:56:22.915-03:00"
    }
  }
}