Atualizar automação

Atualiza uma automação existente

PUT /automations/:id

cURL

curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{
  "name": "Spring promo (updated)",
  "active": true,
  "actions": [
    {
      "type": "send_dm",
      "message": "Hey {{recipient_username}}! New link: https://example.com/spring"
    }
  ]
}' \
-X PUT https://api.ayrshare.com/api/automations/auto_9xKp2Lm4nQ

const API_KEY = "API_KEY";
const id = "auto_9xKp2Lm4nQ";

fetch(`https://api.ayrshare.com/api/automations/${id}`, {
  method: "PUT",
  headers: {
    "Authorization": `Bearer ${API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Spring promo (updated)",
    active: true,
    actions: [
      {
        type: "send_dm",
        message: "Hey {{recipient_username}}! New link: https://example.com/spring",
      },
    ],
  }),
})
  .then((res) => res.json())
  .then((json) => console.log(json))
  .catch(console.error);

import requests

headers = {
    "Authorization": "Bearer API_KEY",
    "Content-Type": "application/json",
}
automation_id = "auto_9xKp2Lm4nQ"

payload = {
    "name": "Spring promo (updated)",
    "active": True,
    "actions": [
        {
            "type": "send_dm",
            "message": "Hey {{recipient_username}}! New link: https://example.com/spring",
        }
    ],
}

r = requests.put(
    f"https://api.ayrshare.com/api/automations/{automation_id}",
    json=payload,
    headers=headers,
)

print(r.json())

$id = "auto_9xKp2Lm4nQ";

$data = [
    "name" => "Spring promo (updated)",
    "active" => true,
    "actions" => [
        [
            "type" => "send_dm",
            "message" => "Hey {{recipient_username}}! New link: https://example.com/spring",
        ],
    ],
];

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => "https://api.ayrshare.com/api/automations/" . $id,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_POSTFIELDS => json_encode($data),
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer API_KEY",
        "Content-Type: application/json",
    ],
]);

$response = curl_exec($curl);
curl_close($curl);
echo $response;

200: Success

{
  "status": "success",
  "id": "auto_9xKp2Lm4nQ"
}

{
  "action": "request",
  "status": "error",
  "code": 473,
  "message": "Validation failed. Please see: https://www.ayrshare.com/docs/introduction",
  "details": {
    "formErrors": ["Unrecognized key: \"platform\""],
    "fieldErrors": {}
  }
}

{
  "action": "automation",
  "status": "error",
  "code": 469,
  "message": "Automation not found"
}

{
  "action": "automation",
  "status": "error",
  "code": 470,
  "message": "Active automation limit reached for your plan tier"
}

Beta. Consulte a visão geral de Automations para a descrição completa do recurso.

Atualização parcial. Apenas os campos listados são editáveis; enviar qualquer outro (por exemplo, platform, accountId) é rejeitado como erro de validação.

Enviar triggers ou actions substitui os filhos existentes atomicamente: o conjunto antigo é excluído e o novo conjunto é gravado em uma única transação do Firestore. Para alterar apenas um trigger, envie o array completo novo.

Reativar uma automação anteriormente inativa (active: true) reverifica o cap de ativas. Se o cap já estiver no limite, a atualização falha com o code 470 e nenhuma alteração é feita.

​

Parâmetros de cabeçalho

​

Parâmetros de caminho

id · string · obrigatório

O ID da automação retornado por POST /automations.

​

Parâmetros do corpo

name · string

Novo nome.

description · string

Nova descrição.

active · boolean

Ativa ou desativa a automação. Alterar de false para true reverifica o cap de automações ativas.

triggers · array

Conjunto completo de substituição de triggers (1–50). Mesmo formato do endpoint de criação.

actions · array

Conjunto completo de substituição de actions (1–50). Mesmo formato do endpoint de criação.

cURL

curl \
-H "Authorization: Bearer API_KEY" \
-H 'Content-Type: application/json' \
-d '{
  "name": "Spring promo (updated)",
  "active": true,
  "actions": [
    {
      "type": "send_dm",
      "message": "Hey {{recipient_username}}! New link: https://example.com/spring"
    }
  ]
}' \
-X PUT https://api.ayrshare.com/api/automations/auto_9xKp2Lm4nQ

const API_KEY = "API_KEY";
const id = "auto_9xKp2Lm4nQ";

fetch(`https://api.ayrshare.com/api/automations/${id}`, {
  method: "PUT",
  headers: {
    "Authorization": `Bearer ${API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Spring promo (updated)",
    active: true,
    actions: [
      {
        type: "send_dm",
        message: "Hey {{recipient_username}}! New link: https://example.com/spring",
      },
    ],
  }),
})
  .then((res) => res.json())
  .then((json) => console.log(json))
  .catch(console.error);

import requests

headers = {
    "Authorization": "Bearer API_KEY",
    "Content-Type": "application/json",
}
automation_id = "auto_9xKp2Lm4nQ"

payload = {
    "name": "Spring promo (updated)",
    "active": True,
    "actions": [
        {
            "type": "send_dm",
            "message": "Hey {{recipient_username}}! New link: https://example.com/spring",
        }
    ],
}

r = requests.put(
    f"https://api.ayrshare.com/api/automations/{automation_id}",
    json=payload,
    headers=headers,
)

print(r.json())

$id = "auto_9xKp2Lm4nQ";

$data = [
    "name" => "Spring promo (updated)",
    "active" => true,
    "actions" => [
        [
            "type" => "send_dm",
            "message" => "Hey {{recipient_username}}! New link: https://example.com/spring",
        ],
    ],
];

$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => "https://api.ayrshare.com/api/automations/" . $id,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "PUT",
    CURLOPT_POSTFIELDS => json_encode($data),
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer API_KEY",
        "Content-Type: application/json",
    ],
]);

$response = curl_exec($curl);
curl_close($curl);
echo $response;

200: Success

{
  "status": "success",
  "id": "auto_9xKp2Lm4nQ"
}

{
  "action": "request",
  "status": "error",
  "code": 473,
  "message": "Validation failed. Please see: https://www.ayrshare.com/docs/introduction",
  "details": {
    "formErrors": ["Unrecognized key: \"platform\""],
    "fieldErrors": {}
  }
}

{
  "action": "automation",
  "status": "error",
  "code": 469,
  "message": "Automation not found"
}

{
  "action": "automation",
  "status": "error",
  "code": 470,
  "message": "Active automation limit reached for your plan tier"
}