Deployment APIs

24 min

deployments api overview the deployments api allows you to manage deployments using cadent’s secure external interface these endpoints use an x api key , which is account based for the environment the system automatically resolves the client group from the provided api key note a deployment cannot be scheduled to start more than a year in advance target audiences cadent's strategic partners who require programmatic access to deployment capabilities for data onboarding and workflow automation technical teams and developers within partner organizations responsible for integrating with cadent's systems incremental deployment partners the following deployment partners support diff or incremental deployments incremental deployments provide the ability to deploy only the new device ids in a segment, rather than deploying the full device list (edited) \id\ \name\ 36 cadent tv dsp diff deployment 45 cadent ad manager 47 google ga deployment api capabilities the deployments api provides the following options retrieve a comprehensive list of supported delivery partners access crosswalk details associated with specific partners create new deployments for audiences and datasets, supporting both immediate and scheduled deployments monitor the status of existing deployments modify existing deployment schedules authentication and authorization the api enforces authentication using access keys that clients transmit through the x api key http header authentication and access to the api will be managed through cadent's api gateway authorization controls based on the provided access key, ensure clients can only access and manage deployments pertaining to their authorized resources and groups headers following is the required api key for authentication key = x api key example value = \<environment specific api key> base urls by environment \environment\ \base url\ production https //api cadent tv https //api cadent tv key management at cadent, api key management is a well defined process integrated into our api gateway architecture we use a centralized system for creating and managing api keys, which are then associated with specific roles and permissions to control access to resources our api gateway handles the authentication process by exchanging api keys for a secure jwt (json web token), which is then used to authorize requests to internal systems the following list provides details on managing the lifecycle of the deployments api keys which ensures secure and authorized access to your service environment specific each environment has a unique key, which cannot be reused across environments group specific each key is linked to a specific group so that requests automatically resolve group context managed by key provisioning and lifecycle are accessed in the cadent platform if you need access to this information, contact cadent support get supported delivery partners { "name" "get supported delivery partners", "method" "get", "url" "/v1/as/delivery partners", "description" "this api retrieves a list of delivery partners that have been enabled for the authenticated client group \n\nyou enter a groupid as a query parameter to identify the relevant group the system fetches all delivery partners associated with the group and filters them based on their configuration settings ", "tab" "examples", "examples" { "languages" \[ { "id" "ic9h9bidsggx63yv3m0mz", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\n\nvar raw = json stringify({\n \\"id\\" \\"string\\"\n});\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //api cakes com\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" } ], "selectedlanguageid" "ic9h9bidsggx63yv3m0mz" }, "results" { "languages" \[ { "id" "jrydklazaocw5akxyj5hl", "language" "200", "code" "{\n \\"name\\" \\"delivery partner names\\",\n}", "customlabel" "" }, { "id" "xfsrkdkleecsrt4zlwrwz", "language" "404", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n}", "customlabel" "" } ], "selectedlanguageid" "jrydklazaocw5akxyj5hl" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "groupid", "kind" "required", "type" "integer", "description" "the unique identifier for the client group ", "" "the unique identifier for the client group " } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" }, "hastryitout" false, "response" \[ { "name" "id", "kind" "optional", "type" "string", "description" "the unique identifier for the client group " }, { "name" "name", "kind" "optional", "type" "string", "description" "the name for the client group ", "children" \[] } ], "autogeneratedanchorslug" "get supported delivery partners 1", "legacyhash" "y s83sbedodxajywyu4ur" } curl example curl x get \\ "https //api cadent tv/v1/as/delivery partners" \\ h "x api key \<your api key>" sample response { "success" true, "list" \[ { "id" 12, "name" "partner a" }, { "id" 14, "name" "partner b" } ], "transaction id" "a134a6a7 a4a3 4b7f 938a ee8a139b53f5" } get partner crosswalk details { "name" "get partner crosswalk details", "method" "get", "url" "/v1/as/delivery partners/crosswalks/household", "description" "this endpoint returns household crosswalks for delivery partners within a specified client group crosswalks are filtered based on partner configuration ", "tab" "examples", "examples" { "languages" \[ { "id" "vr oz4owx3btuysfvrert", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\n\nvar raw = json stringify({\n \\"id\\" \\"string\\"\n});\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //api cakes com\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "3g49vzpueikzmjcaaubyu", "language" "curl", "code" "curl location request get '/v1/sdk/as/delivery partners/crosswalks/household' \\\\\n header 'accept application/json' \\\\\n header 'content type application/json' \\\\\n data '{\n \\"groupid\\" \\"number\\",\n \\"deliverypartnerid\\" \\"number\\"\n}'", "customlabel" "" }, { "id" "el aitr2tfrpzzpl utyp", "language" "nodejs", "code" "var request = require('request');\nvar options = {\n 'method' 'get',\n 'url' '/v1/sdk/as/delivery partners/crosswalks/household',\n 'headers' {\n 'accept' 'application/json',\n 'content type' 'application/json'\n },\n body json stringify({\n \\"groupid\\" \\"number\\",\n \\"deliverypartnerid\\" \\"number\\"\n })\n\n};\nrequest(options, function (error, response) {\n if (error) throw new error(error);\n console log(response body);\n});\n", "customlabel" "" }, { "id" "wwon3tlgo2bfwqawqfri3", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\n\nvar raw = json stringify({\n \\"groupid\\" \\"number\\",\n \\"deliverypartnerid\\" \\"number\\"\n});\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"/v1/sdk/as/delivery partners/crosswalks/household\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" }, { "id" "hjop7y j4na1nfyaslayt", "language" "python", "code" "import requests\nimport json\n\nurl = \\"/v1/sdk/as/delivery partners/crosswalks/household\\"\n\npayload = json dumps({\n \\"groupid\\" \\"number\\",\n \\"deliverypartnerid\\" \\"number\\"\n})\nheaders = {\n 'accept' 'application/json',\n 'content type' 'application/json'\n}\n\nresponse = requests request(\\"get\\", url, headers=headers, data=payload)\n\nprint(response text)\n", "customlabel" "" }, { "id" "6bijpw qxforegplg4llg", "language" "ruby", "code" "require \\"uri\\"\nrequire \\"json\\"\nrequire \\"net/http\"\n\nurl = uri(\\"/v1/sdk/as/delivery partners/crosswalks/household\\")\n\nhttp = net http new(url host, url port);\nrequest = net http get new(url)\nrequest\[\\"accept\\"] = \\"application/json\\"\nrequest\[\\"content type\\"] = \\"application/json\\"\nrequest body = json dump({\n \\"groupid\\" \\"number\\",\n \\"deliverypartnerid\\" \\"number\\"\n})\n\nresponse = http request(request)\nputs response read body\n", "customlabel" "" } ], "selectedlanguageid" "vr oz4owx3btuysfvrert" }, "results" { "languages" \[ { "id" "s3d7pvedcnmturhfrxjfh", "language" "200", "code" "{\n \\"name\\" \\"delivery partner names\\",\n}", "customlabel" "" }, { "id" "ti0w6iiszvjo19 tta0au", "language" "404", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n}", "customlabel" "" } ], "selectedlanguageid" "s3d7pvedcnmturhfrxjfh" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "deliverypartnerid", "kind" "required", "type" "integer", "description" "the unique identifier for the specific delivery partner whose crosswalk details are being requested ", "" "the unique identifier for the specific delivery partner whose crosswalk details are being requested " } ], "headerparameters" \[], "bodydataparameters" \[], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" }, "hastryitout" false, "response" \[ { "name" "id", "kind" "optional", "type" "string", "description" "the unique identifier for the specific delivery partner whose crosswalk details are being requested " }, { "name" "name", "kind" "optional", "type" "string", "description" "crosswalks permitted for uab enabled partners", "children" \[] } ], "autogeneratedanchorslug" "get partner crosswalk details 1", "legacyhash" "vka6pbkt3kvc5rj xup 2" } curl example curl x get \\ "https //api cadent tv/v1/as/delivery partners/crosswalks/household?deliverypartnerid=12" \\ h "x api key \<your api key>" sample response { "success" true, "partnercrosswalks" { "19" \[ { "id" 1, "name" "legacy cadent crosswalk id" } ] }, "transaction id" "5bccb123 ac42 4ca6 97eb 28fb1d60cba7" } error message if the specified delivery partner is not supported, the api returns the following error response, delivery partner not supported post create deployment { "name" "post create deployment details", "method" "post", "url" "/v1/as/deployments", "description" "use this endpoint to create a new deployment for a client group and delivery partner \n\nit supports deploying audiences, audience bundles, or datasets, and includes optional scheduling features \n\nthe system validates the delivery partner’s configuration, ensures the audience builder is enabled, and verifies that the entity is eligible for deployment the request undergoes validation for scheduling rules, supported output types, and required fields based on the entity type and partner configuration \n\nif you do not enter a deployment name, the system auto generates one using the entity’s name and timestamp it also ensures the name is unique to the client group \n\nif a duplicate deployment is detected, the system re runs the existing deployment the response includes the unique id and name of the successfully created deployment, or error details if validation fails ", "tab" "examples", "examples" { "languages" \[ { "id" "v2l6q0y tjzzfcodpqpuw", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\n\nvar raw = json stringify({\n \\"id\\" \\"string\\"\n});\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //api cakes com\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" } ], "selectedlanguageid" "v2l6q0y tjzzfcodpqpuw" }, "results" { "languages" \[ { "id" "zndlog5bvckdjidexv6jr", "language" "200", "code" "{\n \\"name\\" \\"cake's name\\",\n}", "customlabel" "" }, { "id" "sctgkp nojadg6mdtmtei", "language" "404", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n}", "customlabel" "" }, { "id" "065mkj7qhcsmigg2vcirc", "language" "100", "code" "", "customlabel" "" } ], "selectedlanguageid" "065mkj7qhcsmigg2vcirc" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "groupid", "kind" "required", "type" "integer", "description" "the unique identifier for the client group ", "" "the unique identifier for the client group " }, { "name" "username", "kind" "required", "type" "string", "description" "the username of the client initiating the deployment ", "" "the username of the client initiating the deployment " }, { "name" "rerunonuniquenessvalidationerror", "kind" "optional", "type" "boolean", "description" "if this parameter is set to true, it triggers a re run of an existing deployment when a duplicate request is submitted default = false ", "" "if this parameter is set to true, it triggers a re run of an existing deployment when a duplicate request is submitted default = false " } ], "headerparameters" \[], "bodydataparameters" \[ { "name" "entityid", "kind" "required", "type" "integer", "description" "the identifier of the audience, audience bundle, or dataset to be deployed ", "" "the identifier of the audience, audience bundle, or dataset to be deployed " }, { "name" "entitytype", "kind" "required", "type" "string", "description" "specifies the type of entity being deployed follownig art valid values audience, audience bundle, dataset ", "" "specifies the type of entity being deployed follownig art valid values audience, audience bundle, dataset " }, { "name" "dpid", "kind" "required", "type" "integer", "description" "the identifier of the target delivery partner ", "" "the identifier of the target delivery partner " }, { "name" "name", "kind" "required", "type" "string", "description" "a unique name for the deployment ", "" "a unique name for the deployment " }, { "name" "scheduled", "kind" "optional", "type" "boolean", "description" "a flag indicating if the deployment is scheduled for a future time default = false ", "" "a flag indicating if the deployment is scheduled for a future time default = false " }, { "name" "repeat", "kind" "optional", "type" "string", "description" "defines the schedule type this parameter is required if scheduled=true, following are valid values once, repeated ", "" "defines the schedule type this parameter is required if scheduled=true, following are valid values once, repeated " }, { "name" "weeksinterval", "kind" "optional", "type" "integer", "description" "indicates the interval in weeks for recurring deployments this parameter is required if repeat=repeated default = 4 ", "" "indicates the interval in weeks for recurring deployments this parameter is required if repeat=repeated default = 4 " }, { "name" "daysofweek", "kind" "optional", "type" "array", "description" "specifies the days of the week for recurring deployments following are valid values mon, tue, wed, thu, fri, sat, sun this parameter is required if repeat=repeated ", "" "specifies the days of the week for recurring deployments following are valid values mon, tue, wed, thu, fri, sat, sun this parameter is required if repeat=repeated " }, { "name" "startdate", "kind" "optional", "type" "string", "description" "the start date of the deployment schedule follows the iso 8601 date format default = the current date this parameter is required if scheduled=true cannot be more than one year in the future ", "" "the start date of the deployment schedule follows the iso 8601 date format default = the current date this parameter is required if scheduled=true cannot be more than one year in the future " }, { "name" "enddate", "kind" "optional", "type" "string", "description" "the end date of the reoccurring deployment schedule this parameter is required if scheduled=true follow the iso 8601 date format ", "" "the end date of the reoccurring deployment schedule this parameter is required if scheduled=true follow the iso 8601 date format " }, { "name" "customsegname", "kind" "optional", "type" "string", "description" "a custom segment name, required for specific delivery partners, for example, comcast, directv, dish, sling, and cadent dsp diff ", "" "a custom segment name, required for specific delivery partners, for example, comcast, directv, dish, sling, and cadent dsp diff " }, { "name" "hhcrosswalkid", "kind" "optional", "type" "integer", "description" "a household crosswalk id, required for certain delivery partners, for examplle, directv, directv byod ", "" "a household crosswalk id, required for certain delivery partners, for examplle, directv, directv byod " }, { "name" "audiencetocustomsegname", "kind" "optional", "type" "object", "description" "for audience bundle deployments, this field maps audience ids within the bundle to custom segment names ", "" "for audience bundle deployments, this field maps audience ids within the bundle to custom segment names ", "children" \[], "schema" \[] } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" false, "response" \[ { "name" "id", "kind" "optional", "type" "string", "description" "\n" }, { "name" "name", "kind" "optional", "type" "string", "description" "", "children" \[] } ], "autogeneratedanchorslug" "post create deployment details", "legacyhash" "xi53 81z6yoccbculwxjc" } curl request curl x post \\ "https //api cadent tv/v1/as/deployments?rerunonuniquenessvalidationerror=false" \\ h "x api key \<your api key>" \\ d '{ "entityid" 7721, "entitytype" "audience", "dpid" 12, "name" "test deployment" }' sample request body (json) this example applies to an audience deployment { "entityid" 7721, "entitytype" "audience", "dpid" 12, "name" "test deployment555" } this example applies to an audience bundle deployment { "entityid" 1929, "entitytype" "audience bundle", "dpid" 15, "name" "test deployment555", "audiencetocustomsegname" { "14049" "segment a", "14048" "segment b" } } sample response { "success" true, "deployment" { "id" 15010, "name" "dsp deployment555" }, "transaction id" "e7d98fee a46a 430d a3e7 61aca3138671" } get deployment status { "name" "get deployment status", "method" "get", "url" "/v1/as/deployments", "description" "this api retrieves detailed information about one or more deployments based on the client group and a list of deployment ids \n\nit returns a summary of each deployment, including its name, current status, job progress (for example, pending, running, and completed), and the last deployment date for scheduled deployments, the response includes timing details such as whether it is recurring, the repeat frequency, specific days of the week, and the start and end dates \n\nall information is provided in a standardized iso format ", "tab" "examples", "examples" { "languages" \[ { "id" "8t8ldapse9bcltxnkpxqe", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\n\nvar raw = json stringify({\n \\"id\\" \\"string\\"\n});\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //api cakes com\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" } ], "selectedlanguageid" "8t8ldapse9bcltxnkpxqe" }, "results" { "languages" \[ { "id" "ki3qfmd26snnwowpnrqcf", "language" "200", "code" "{\n \\"name\\" \\"deployment id\\",\n}", "customlabel" "" }, { "id" "4vaxv4aizwjszvtoypjid", "language" "404", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n}", "customlabel" "" } ], "selectedlanguageid" "ki3qfmd26snnwowpnrqcf" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "groupid", "kind" "required", "type" "integer", "description" "the unique identifier for the client group ", "" "the unique identifier for the client group " } ], "headerparameters" \[], "bodydataparameters" \[ { "name" "deploymentids", "kind" "required", "type" "string", "description" "a list of deployment identifiers to retrieve ", "" "a list of deployment identifiers to retrieve " } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "query parameter", "value" "queryparameters" }, "hastryitout" false, "response" \[ { "name" "success", "kind" "optional", "type" "string", "description" "true indicates successful transaction false indicates a failure " }, { "name" "id", "kind" "optional", "type" "string", "description" "alphanumeric identifier for the transaction ", "children" \[] }, { "name" "name", "kind" "optional", "type" "string", "description" "deployment name ", "children" \[] }, { "name" "status", "kind" "optional", "type" "string", "description" "status of the deployment ", "children" \[] }, { "name" "jobstatus", "kind" "optional", "type" "string", "description" "indicates the success or failure of the current transaction ", "children" \[] }, { "name" "scheduled", "kind" "optional", "type" "boolean", "description" "true indicates the deployment is scheduled false indicates that it is not ", "children" \[] }, { "name" "repeat", "kind" "optional", "type" "string", "description" "defines the schedule type this parameter is required if scheduled=true, following are valid values once, repeated ", "children" \[] }, { "name" "weeksinterval", "kind" "optional", "type" "number", "description" "", "children" \[] }, { "name" "daysofweek", "kind" "optional", "type" "string", "description" "the following are valid values sun, mon, tue, wed, thr, fri, sat", "children" \[] }, { "name" "lastdeployed", "kind" "optional", "type" "number", "description" "the date of the last deployment", "children" \[] }, { "name" "entitytype", "kind" "optional", "type" "string", "description" "specifies the type of entity being deployed follownig art valid values audience, audience bundle, dataset ", "children" \[] }, { "name" "startdate", "kind" "optional", "type" "number", "description" "the start date of the deployment schedule follows the iso 8601 date format default = the current date this parameter is required if scheduled=true cannot be more than one year in the future ", "children" \[] }, { "name" "enddate", "kind" "optional", "type" "string", "description" "the end date of the reoccurring deployment schedule this parameter is required if scheduled=true follow the iso 8601 date format ", "children" \[] } ], "autogeneratedanchorslug" "get deployment status 1", "legacyhash" "2j5rknn5f73dk9vdq5q9a" } curl example curl x get \\ "https //api cadent tv/v1/as/deployments?deploymentids=51256\&deploymentids=51257" \\ h "x api key \<your api key>" sample response { "success" true, "deployments" \[ { "id" 14987, "name" "lk fw", "status" "active", "jobstatus" "done", "scheduled" true, "repeat" "repeated", "weeksinterval" 1, "daysofweek" \[ "sun", "tue", "fri" ], "lastdeployed" "2025 09 28", "entitytype" "audience", "startdate" "2025 09 22", "enddate" "2025 10 20" } ], "transaction id" "180d63aa ddf2 49a5 8ae3 87353f418725" } update deployment schedule { "name" "update deployment schedule details", "method" "put", "url" "/v1/as/deployments/schedule", "description" "this api allows you to update the schedule of an existing deployment in a client group by providing new scheduling details, you can modify when and how often a deployment runs \n\nthe system ensures all scheduling rules are followed if the request is valid, the schedule is updated accordingly and also supports extending the end date without altering other schedule settings ", "tab" "examples", "examples" { "languages" \[ { "id" "lck5 gsc 1o2st4hdnqbn", "language" "javascript", "code" "var myheaders = new headers();\nmyheaders append(\\"accept\\", \\"application/json\\");\nmyheaders append(\\"content type\\", \\"application/json\\");\n\nvar raw = json stringify({\n \\"id\\" \\"string\\"\n});\n\nvar requestoptions = {\n method 'get',\n headers myheaders,\n body raw,\n redirect 'follow'\n};\n\nfetch(\\"https //api cakes com\\", requestoptions)\n then(response => response text())\n then(result => console log(result))\n catch(error => console log('error', error));", "customlabel" "" } ], "selectedlanguageid" "lck5 gsc 1o2st4hdnqbn" }, "results" { "languages" \[ { "id" "yi719c4bcl9eq soramwd", "language" "200", "code" "{\n \\"success\\" true,\n \\"transaction id\\" \\"118eb0e9\\"\n}", "customlabel" "" }, { "id" "rnk38om56690qzy9k5dt5", "language" "404", "code" "{\n \\"message\\" \\"ain't no cake like that \\"\n}", "customlabel" "" }, { "id" "xsnrccwygyg5f6bxdpfkq", "language" "100", "code" "", "customlabel" "" } ], "selectedlanguageid" "yi719c4bcl9eq soramwd" }, "request" { "pathparameters" \[], "queryparameters" \[ { "name" "deploymentid", "kind" "required", "type" "integer", "description" "the identifier of the deployment to update ", "" "the identifier of the deployment to update " }, { "name" "groupid", "kind" "required", "type" "integer", "description" "the unique identifier for the client group ", "" "the unique identifier for the client group " }, { "name" "username", "kind" "required", "type" "string", "description" "the username of the client performing the update ", "" "the username of the client performing the update " } ], "headerparameters" \[], "bodydataparameters" \[ { "name" "repeat", "kind" "required", "type" "string", "description" "the new schedule type for the deployment following are valid values once, repeated ", "" "the new schedule type for the deployment following are valid values once, repeated " }, { "name" "weeksinterval", "kind" "optional", "type" "integer", "description" "this parameter is required when repeat=repeated enter a new interval in weeks for recurring deployments ", "" "this parameter is required when repeat=repeated enter a new interval in weeks for recurring deployments " }, { "name" "daysofweek", "kind" "optional", "type" "string", "description" "this parameter is required when repeat=repeated enter the new days of the week for recurring deployments ", "" "this parameter is required when repeat=repeated enter the new days of the week for recurring deployments " }, { "name" "startdate", "kind" "required", "type" "string", "description" "using iso 8601 date format, enter the new start date of the deployment schedule ", "" "using iso 8601 date format, enter the new start date of the deployment schedule " }, { "name" "extendenddateonly", "kind" "optional", "type" "boolean", "description" "if if this parameter is set to true, the enddate will be updated to the maximum of its current value ", "" "if if this parameter is set to true, the enddate will be updated to the maximum of its current value " } ], "formdataparameters" \[] }, "currentnewparameter" { "label" "body parameter", "value" "bodydataparameters" }, "hastryitout" false, "response" \[ { "name" "success", "kind" "optional", "type" "string", "description" "true indicates a successful transaction " }, { "name" "transaction id", "kind" "optional", "type" "string", "description" "the alphanumeric identifier assigned for the transmission ", "children" \[] } ], "autogeneratedanchorslug" "update deployment schedule details", "legacyhash" "goyd qgvwkum qfzuuebi" } sample request body { "repeat" "repeated", "weeksinterval" 1, "daysofweek" \["mon"], "startdate" "2025 10 12", "enddate" "2025 10 20", "extendenddateonly" true } sample response { "success" true, "transaction id" "118eb0e9 b269 4237 b5ea f8e0ec1b6cf3" }