PUT
/
v1
/
accounts
/
{accountId}
/
dripcampaigns
/
{dripCampaignId}
Edit a Drip Campaign
curl --request PUT \
  --url https://api.sakari.io/v1/accounts/{accountId}/dripcampaigns/{dripCampaignId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "trigger": {
    "type": "<string>",
    "message": "<string>",
    "groups": [
      {
        "id": "<string>",
        "name": "<string>",
        "phoneNumbers?": [
          {
            "id": "<string>",
            "name": "<string>",
            "status": "<string>",
            "number": "<string>",
            "country": "<string>",
            "type": "<string>",
            "verified": true,
            "provider": "<string>",
            "supportedDestinations": [
              "<any>"
            ],
            "forwardTo": {},
            "universalReply": true,
            "channels": {
              "sms": "<any>",
              "voice": "<any>",
              "whatsapp": "<any>"
            },
            "groups": [
              "<any>"
            ],
            "hosted": true
          }
        ],
        "notifications": [
          {
            "destination": {
              "id": "<any>",
              "name": "<any>"
            },
            "integration": "<string>",
            "group": {
              "id": "<any>",
              "name": "<any>"
            }
          }
        ],
        "tags": [
          "<string>"
        ],
        "users": [
          {
            "firstName": "<string>",
            "lastName": "<string>",
            "email": "<string>",
            "mobile": {
              "country": "<any>",
              "number": "<any>",
              "verified": "<any>",
              "valid": "<any>",
              "lineType": "<any>"
            },
            "role": "Administrator"
          }
        ],
        "senders": [
          {
            "id": "<string>",
            "type": "phonenumber",
            "subType": "<string>",
            "status": "<string>",
            "identifier": "<string>",
            "channels": {
              "sms": "<any>",
              "voice": "<any>",
              "whatsapp": "<any>"
            },
            "groups": [
              "<any>"
            ]
          }
        ],
        "officeHours": {
          "active": true,
          "timezone": "<string>",
          "times": {
            "sun": [
              "<any>"
            ],
            "mon": [
              "<any>"
            ],
            "tue": [
              "<any>"
            ],
            "wed": [
              "<any>"
            ],
            "thu": [
              "<any>"
            ],
            "fri": [
              "<any>"
            ],
            "sat": [
              "<any>"
            ]
          }
        },
        "isDefault": true,
        "useSharedPool": true
      }
    ],
    "list": {
      "name": "<string>",
      "source": {
        "id": "<string>",
        "integration": "<string>",
        "lastSynced": "<string>"
      },
      "keyword": "<string>",
      "doubleOptIn": {
        "enabled": true,
        "prompt": "<string>"
      },
      "filter": {
        "q": "<string>",
        "attributes": [
          {
            "attribute": "<string>",
            "comparator": "<string>",
            "value": [
              "<string>"
            ]
          }
        ],
        "list": "<string>",
        "valid": true,
        "invalid": true,
        "blocked": true,
        "unblocked": true,
        "optIn": true
      },
      "optInConfirmation": "<string>"
    },
    "group": {
      "id": "<string>",
      "name": "<string>",
      "phoneNumbers?": [
        {
          "id": "<string>",
          "name": "<string>",
          "status": "<string>",
          "number": "<string>",
          "country": "<string>",
          "type": "<string>",
          "verified": true,
          "provider": "<string>",
          "supportedDestinations": [
            "<any>"
          ],
          "forwardTo": {},
          "universalReply": true,
          "channels": {
            "sms": "<any>",
            "voice": "<any>",
            "whatsapp": "<any>"
          },
          "groups": [
            "<any>"
          ],
          "hosted": true
        }
      ],
      "notifications": [
        {
          "destination": {
            "id": "<any>",
            "name": "<any>"
          },
          "integration": "<string>",
          "group": {
            "id": "<any>",
            "name": "<any>"
          }
        }
      ],
      "tags": [
        "<string>"
      ],
      "users": [
        {
          "firstName": "<string>",
          "lastName": "<string>",
          "email": "<string>",
          "mobile": {
            "country": "<any>",
            "number": "<any>",
            "verified": "<any>",
            "valid": "<any>",
            "lineType": "<any>"
          },
          "role": "Administrator"
        }
      ],
      "senders": [
        {
          "id": "<string>",
          "type": "phonenumber",
          "subType": "<string>",
          "status": "<string>",
          "identifier": "<string>",
          "channels": {
            "sms": "<any>",
            "voice": "<any>",
            "whatsapp": "<any>"
          },
          "groups": [
            "<any>"
          ]
        }
      ],
      "officeHours": {
        "active": true,
        "timezone": "<string>",
        "times": {
          "sun": [
            "<any>"
          ],
          "mon": [
            "<any>"
          ],
          "tue": [
            "<any>"
          ],
          "wed": [
            "<any>"
          ],
          "thu": [
            "<any>"
          ],
          "fri": [
            "<any>"
          ],
          "sat": [
            "<any>"
          ]
        }
      },
      "isDefault": true,
      "useSharedPool": true
    },
    "delay": {
      "days": 123,
      "hours": 123,
      "minutes": 123
    }
  },
  "messages": [
    {
      "message": "<string>",
      "media": [
        {
          "url": "<string>",
          "type": "<string>",
          "name": "<string>",
          "filename": "<string>"
        }
      ],
      "delay": {
        "days": 123,
        "hours": 123,
        "minutes": 123
      },
      "stats": {
        "entered": 123,
        "active": 123,
        "errored": 123,
        "noAction": 123,
        "optOut": 123,
        "engaged": 123
      }
    }
  ],
  "stats": {
    "entered": 123,
    "active": 123,
    "errored": 123,
    "noAction": 123,
    "optOut": 123,
    "engaged": 123
  },
  "activate": true
}'
{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "trigger": {
      "type": "<string>",
      "message": "<string>",
      "groups": [
        {
          "id": "<string>",
          "name": "<string>",
          "phoneNumbers?": [
            {
              "id": "<string>",
              "name": "<string>",
              "status": "<string>",
              "number": "<string>",
              "country": "<string>",
              "type": "<string>",
              "verified": true,
              "provider": "<string>",
              "supportedDestinations": [
                "<any>"
              ],
              "forwardTo": {},
              "universalReply": true,
              "channels": {},
              "groups": [
                "<any>"
              ],
              "hosted": true
            }
          ],
          "notifications": [
            {
              "destination": {},
              "integration": "<string>",
              "group": {}
            }
          ],
          "tags": [
            "<string>"
          ],
          "users": [
            {
              "id": "<string>",
              "firstName": "<string>",
              "lastName": "<string>",
              "email": "<string>",
              "mobile": {},
              "role": "Administrator"
            }
          ],
          "senders": [
            {
              "id": "<string>",
              "type": "phonenumber",
              "subType": "<string>",
              "status": "<string>",
              "identifier": "<string>",
              "channels": {},
              "groups": [
                "<any>"
              ],
              "created": {},
              "updated": {}
            }
          ],
          "officeHours": {
            "active": true,
            "timezone": "<string>",
            "times": {
              "sun": [
                "<any>"
              ],
              "mon": [
                "<any>"
              ],
              "tue": [
                "<any>"
              ],
              "wed": [
                "<any>"
              ],
              "thu": [
                "<any>"
              ],
              "fri": [
                "<any>"
              ],
              "sat": [
                "<any>"
              ]
            }
          },
          "isDefault": true,
          "useSharedPool": true
        }
      ],
      "list": {
        "id": "<string>",
        "name": "<string>",
        "source": {
          "id": "<string>",
          "integration": "<string>",
          "lastSynced": "<string>"
        },
        "keyword": "<string>",
        "doubleOptIn": {
          "enabled": true,
          "prompt": "<string>"
        },
        "filter": {
          "q": "<string>",
          "attributes": [
            {
              "attribute": "<string>",
              "comparator": "<string>",
              "value": [
                "<string>"
              ]
            }
          ],
          "list": "<string>",
          "valid": true,
          "invalid": true,
          "blocked": true,
          "unblocked": true,
          "optIn": true
        },
        "optInConfirmation": "<string>"
      },
      "group": {
        "id": "<string>",
        "name": "<string>",
        "phoneNumbers?": [
          {
            "id": "<string>",
            "name": "<string>",
            "status": "<string>",
            "number": "<string>",
            "country": "<string>",
            "type": "<string>",
            "verified": true,
            "provider": "<string>",
            "supportedDestinations": [
              "<any>"
            ],
            "forwardTo": {},
            "universalReply": true,
            "channels": {},
            "groups": [
              "<any>"
            ],
            "hosted": true
          }
        ],
        "notifications": [
          {
            "destination": {},
            "integration": "<string>",
            "group": {}
          }
        ],
        "tags": [
          "<string>"
        ],
        "users": [
          {
            "id": "<string>",
            "firstName": "<string>",
            "lastName": "<string>",
            "email": "<string>",
            "mobile": {},
            "role": "Administrator"
          }
        ],
        "senders": [
          {
            "id": "<string>",
            "type": "phonenumber",
            "subType": "<string>",
            "status": "<string>",
            "identifier": "<string>",
            "channels": {},
            "groups": [
              "<any>"
            ],
            "created": {},
            "updated": {}
          }
        ],
        "officeHours": {
          "active": true,
          "timezone": "<string>",
          "times": {
            "sun": [
              "<any>"
            ],
            "mon": [
              "<any>"
            ],
            "tue": [
              "<any>"
            ],
            "wed": [
              "<any>"
            ],
            "thu": [
              "<any>"
            ],
            "fri": [
              "<any>"
            ],
            "sat": [
              "<any>"
            ]
          }
        },
        "isDefault": true,
        "useSharedPool": true
      },
      "delay": {
        "days": 123,
        "hours": 123,
        "minutes": 123
      }
    },
    "messages": [
      {
        "id": "<string>",
        "message": "<string>",
        "media": [
          {
            "url": "<string>",
            "type": "<string>",
            "name": "<string>",
            "filename": "<string>"
          }
        ],
        "delay": {
          "days": 123,
          "hours": 123,
          "minutes": 123
        },
        "stats": {
          "entered": 123,
          "active": 123,
          "errored": 123,
          "noAction": 123,
          "optOut": 123,
          "engaged": 123
        }
      }
    ],
    "active": true,
    "maxDuration": 123,
    "stats": {
      "entered": 123,
      "active": 123,
      "errored": 123,
      "noAction": 123,
      "optOut": 123,
      "engaged": 123
    },
    "created": {
      "at": "2023-11-07T05:31:56Z",
      "by": {}
    },
    "updated": {
      "at": "2023-11-07T05:31:56Z",
      "by": {}
    }
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
accountId
string
required

Account to apply operations to

​
dripCampaignId
string
required

Drip Campaign to apply operations to

Body

application/json

Response

200
application/json

successful operation

The response is of type object.