curl -sS -X PATCH "https://gateway.orbit/api/v1/conn/profiles/1/settings" \
--cacert /path/to/orbit-root-ca.pem \
-H 'Accept: application/json' \
-H 'X-Orbit-Request-Id: 9d6b1e5c-4a3f-4a1b-9f0e-6d2c3f5a7b81' \
-H 'Content-Type: application/json' \
-d '{"sections": {}}'{
"data": {
"profile_id": 123,
"version": 123,
"settings": {},
"sections": {},
"updated_at": "<string>"
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Patch profile settings sections
Changes sections of the settings document, each with the version the client last read: {"sections": {"appearance": {"version": 3, "value": {...}}, "devices.iphone": {"version": 0, "value": null}}}. A section is workspaces, appearance, or devices.<type>; an unknown name returns validation.failed (422). A section with no recorded version reads as 0, including one written before sections had versions. A null value removes appearance or a device section; an empty string returns validation.failed (422). The request is all or nothing: if any section is at another version it returns conn.settings_version_conflict (409) with details.current_version and details.sections, the current version of each section sent, and writes nothing. A write adds 1 to each section version and to the document version.
curl -sS -X PATCH "https://gateway.orbit/api/v1/conn/profiles/1/settings" \
--cacert /path/to/orbit-root-ca.pem \
-H 'Accept: application/json' \
-H 'X-Orbit-Request-Id: 9d6b1e5c-4a3f-4a1b-9f0e-6d2c3f5a7b81' \
-H 'Content-Type: application/json' \
-d '{"sections": {}}'{
"data": {
"profile_id": 123,
"version": 123,
"settings": {},
"sections": {},
"updated_at": "<string>"
},
"meta": {
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": {},
"request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Path Parameters
Body
The sections to change by name. At most 8 device types may exist after the change, and the whole document is at most 4 MB.
Show child attributes
Show child attributes