Update Automation

किसी मौजूदा automation को अद्यतन करें

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. पूर्ण फ़ीचर विवरण के लिए Automations Overview देखें।

आंशिक अद्यतन। केवल सूचीबद्ध fields संपादन योग्य हैं; किसी अन्य को भेजना (जैसे platform, accountId) एक validation error के रूप में अस्वीकार किया जाता है।

triggers या actions भेजना मौजूदा children को atomically प्रतिस्थापित करता है: पुराना set हटा दिया जाता है और नया set एक ही Firestore transaction में लिखा जाता है। केवल एक trigger बदलने के लिए, पूर्ण नई array भेजें।

पहले से inactive automation को पुनः सक्रिय करना (active: true) active-cap की पुनः जाँच करता है। यदि cap पहले से सीमा पर है, तो अद्यतन code 470 के साथ विफल हो जाता है और कोई परिवर्तन नहीं किया जाता।

​

Header Parameters

​

Path Parameters

id · string · आवश्यक

POST /automations से लौटाया गया automation ID।

​

Body Parameters

name · string

नया नाम।

description · string

नया विवरण।

active · boolean

automation को on या off toggle करें। इसे false से true पर सेट करने पर active automation cap की पुनः जाँच होती है।

triggers · array

triggers का पूर्ण प्रतिस्थापन set (1–50)। create endpoint के समान आकार।

actions · array

actions का पूर्ण प्रतिस्थापन set (1–50)। create endpoint के समान आकार।

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"
}