📘
Requisição para excluir múltiplos requisitos em um envelope na plataforma Clicksign. Essa é uma requisição POST para /envelopes/{{envelopeid}}/bulk_requirements, sendo {{envelopeid}}a variável id gerada na criação do envelope. Em Authorization adicione o access token de sua conta. No body, deverão ser enviados os atributos listados abaixo.

POST /api/v3/envelopes/{{envelopeid}}/bulk_requirements HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token

Atributo de operação

Atributo	Descrição	Obrigatório
`op`	A operação a ser realizada. Para remover requisitos, o valor deve ser `remove`. Esse atributo deve estar incluso no array `atomic:operations`, conforme o exemplo da request.	Sim
`ref`	Objeto que contém as informações do requisito a ser removido. Deve conter os atributos listados abaixo, em tipo de dados.	Sim

Tipo de dados

Atributo	Descrição	Obrigatório
`type`	Determina o tipo de dados, que aqui deve ser `requirements`.	Sim
`id`	A variável que identifica o requisito a ser excluído. Pode ser encontrada na response gerada ao criar um requisito.	Sim

❗️
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 completo

Request

POST /api/v3/envelopes/{{envelopeid}}/bulk_requirements HTTP/1.1
Host: sandbox.clicksign.com
Content-Type: application/vnd.api+json
Accept: application/vnd.api+json
Authorization: access token

{
  "atomic:operations": [
    {
      "op": "remove",
      "ref": {
        "type": "requirements",
        "id": "4ba04cd3-effc-42f2-98c6-8ccfb038be83"
      }
    },
    {
      "op": "remove",
      "ref": {
        "type": "requirements",
        "id": "16e34166-9652-436d-b56f-1a56163128b8"
      }
    }
  ]
}

Response

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

{
    "atomic:results": [
        {
            "data": {}
        }
    ]
}