Modify the configuration of a Custom Profile payload item within a profile

To modify Mac Custom Profiles payload item

Endpoints

put /api/v1/mdm/profiles/{profile_id}/payloads/maccustomprofiles/payloaditems/{payload_id}

Copy full URL

Request URL

https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/maccustomprofiles/payloaditems/{payload_id}

Scope

MDMDeviceMgmt.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/jsonCopied!

- Path Parameters

profile_idstringMandatory

Unique identifier of the profile. Obtain from the Create Profile or Get Profiles response

payload_idstringMandatory

Unique identifier of the payload item. Obtain from the Get Payload Item IDs response

- Request Body

application/json

JSON Object

Hide Sub-Attributes

custom_profile_file_idlongMandatory

File ID of the uploaded custom profile. Use the fileID from the File Upload API response

custom_profile_idlongOptional

Identifier for an existing custom profile configuration to update

allow_existing_payloadbooleanOptional

Allow existing payload types to coexist with this custom profile. true=allow, false=reject conflicts. Default: false

custom_profile_typeintegerOptional

Custom profile type. Allowed values: 1=Configuration Profile, 2=Custom command, 3=DDM Configuration

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/maccustomprofiles/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"custom_profile_type":1,"custom_profile_file_id":6967000001030034,"custom_profile_id":6967000001030045,"allow_existing_payload":false}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/maccustomprofiles/payloaditems/{payload_id}"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"custom_profile_type\":1,\"custom_profile_file_id\":6967000001030034,\"custom_profile_id\":6967000001030045,\"allow_existing_payload\":false}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"custom_profile_type\":1,\"custom_profile_file_id\":6967000001030034,\"custom_profile_id\":6967000001030045,\"allow_existing_payload\":false}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/maccustomprofiles/payloaditems/{payload_id}", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    data=Map();
    data.put("custom_profile_file_id","1");
    data.put("custom_profile_id","1");
    data.put("allow_existing_payload",true);
    data.put("custom_profile_type","1");

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/maccustomprofiles/payloaditems/{payload_id}"
        type: PUT
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/maccustomprofiles/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"custom_profile_type":1,"custom_profile_file_id":6967000001030034,"custom_profile_id":6967000001030045,"allow_existing_payload":false}'

Sample Request Body

Modify Custom Profile payload item

Copied!

  {
    "custom_profile_type": 1,
    "custom_profile_file_id": 6967000001030034,
    "custom_profile_id": 6967000001030045,
    "allow_existing_payload": false
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

payload_idlong

Unique identifier of the payload item

custom_profile_file_idlong

File ID of the uploaded custom profile. Obtained from the File Upload API response

custom_profile_idlong

Identifier for the custom profile configuration

allow_existing_payloadboolean

Whether existing payload types are allowed to coexist. Default: false

custom_profile_typestring

Custom profile type. Values: 1=Configuration Profile, 2=Custom command, 3=DDM Configuration

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Custom Profile payload item successfully modified

Copied!

  {
    "payload_id": 6967000001030056,
    "custom_profile_type": "1",
    "custom_profile_file_id": 6967000001030034,
    "custom_profile_id": 6967000001030045,
    "allow_existing_payload": false
  }

▼ Show full

Duration: 1 minute | Threshold: 60 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.