{"openapi":"3.2.0","info":{"title":"ChaosDesk API","description":"Public REST API (tickets, users, organizations, rules, webhooks).\n\n**Authentication.** Send `Authorization: Bearer <token>`, either a Keycloak access token (agent app) or a\npersonal API token (`desk_…`, created under Admin › API). API tokens act as their owner and are limited by\nscope: `read` allows GET only, `write` allows every method.\n\n**Rate limits.** 700 requests per minute per API token. Every response carries `X-RateLimit-Limit`,\n`X-RateLimit-Remaining` and `X-RateLimit-Reset` (seconds until the window resets); beyond the limit you get\n`429` with `Retry-After`.\n\n**Pagination.** Collections are page-based (`page`, `itemsPerPage` ≤ 100). `GET /api/tickets` also supports\ncursor pagination (`?cursor=&limit=100`): follow `links.next` until `meta.has_more` is false.\n\n**Webhooks.** Requests carry `X-Desk-Timestamp` (Unix seconds) and\n`X-Desk-Signature` = base64(HMAC-SHA256(signing secret, timestamp + \".\" + raw body)). Reject requests\nwhose timestamp is older than 5 minutes. Failed deliveries are retried after 1m, 5m, 30m, 2h, 6h and 12h.","version":"1.0.0"},"servers":[{"url":"/","description":""}],"paths":{"/api/api_tokens":{"get":{"operationId":"api_api_tokens_get_collection","tags":["ApiToken"],"responses":{"200":{"description":"ApiToken collection","content":{"application/ld+json":{"schema":{"type":"object","description":"ApiToken.jsonld-api_token.read_user.summary collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/ApiToken.jsonld-api_token.read_user.summary"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ApiToken-api_token.read_user.summary"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"List API tokens (own tokens; admins: all).","description":"List API tokens (own tokens; admins: all).","parameters":[]},"post":{"operationId":"api_api_tokens_post","tags":["ApiToken"],"responses":{"201":{"description":"ApiToken resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ApiToken.jsonld-api_token.read_api_token.created_user.summary"}},"application/json":{"schema":{"$ref":"#/components/schemas/ApiToken-api_token.read_api_token.created_user.summary"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Create an API token. The plaintext `token` is only returned in this response.","description":"Create an API token. The plaintext `token` is only returned in this response.","parameters":[],"requestBody":{"description":"The new ApiToken resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ApiToken-api_token.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/ApiToken-api_token.write"}}},"required":true}}},"/api/api_tokens/{id}":{"delete":{"operationId":"api_api_tokens_id_delete","tags":["ApiToken"],"responses":{"204":{"description":"ApiToken resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Revoke (delete) an API token.","description":"Revoke (delete) an API token.","parameters":[{"name":"id","in":"path","description":"ApiToken identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}},"/api/assignment_rules":{"get":{"operationId":"api_assignment_rules_get_collection","tags":["AssignmentRule"],"responses":{"200":{"description":"AssignmentRule collection","content":{"application/ld+json":{"schema":{"type":"object","description":"AssignmentRule.jsonld-rule.read_assignment_rule.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/AssignmentRule.jsonld-rule.read_assignment_rule.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AssignmentRule-rule.read_assignment_rule.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of AssignmentRule resources.","description":"Retrieves the collection of AssignmentRule resources.","parameters":[]},"post":{"operationId":"api_assignment_rules_post","tags":["AssignmentRule"],"responses":{"201":{"description":"AssignmentRule resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/AssignmentRule.jsonld-rule.read_assignment_rule.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/AssignmentRule-rule.read_assignment_rule.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a AssignmentRule resource.","description":"Creates a AssignmentRule resource.","parameters":[],"requestBody":{"description":"The new AssignmentRule resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/AssignmentRule-rule.write_assignment_rule.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/AssignmentRule-rule.write_assignment_rule.write"}}},"required":true}}},"/api/assignment_rules/{id}":{"get":{"operationId":"api_assignment_rules_id_get","tags":["AssignmentRule"],"responses":{"200":{"description":"AssignmentRule resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/AssignmentRule.jsonld-rule.read_assignment_rule.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/AssignmentRule-rule.read_assignment_rule.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a AssignmentRule resource.","description":"Retrieves a AssignmentRule resource.","parameters":[{"name":"id","in":"path","description":"AssignmentRule identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_assignment_rules_id_delete","tags":["AssignmentRule"],"responses":{"204":{"description":"AssignmentRule resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the AssignmentRule resource.","description":"Removes the AssignmentRule resource.","parameters":[{"name":"id","in":"path","description":"AssignmentRule identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_assignment_rules_id_patch","tags":["AssignmentRule"],"responses":{"200":{"description":"AssignmentRule resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/AssignmentRule.jsonld-rule.read_assignment_rule.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/AssignmentRule-rule.read_assignment_rule.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the AssignmentRule resource.","description":"Updates the AssignmentRule resource.","parameters":[{"name":"id","in":"path","description":"AssignmentRule identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated AssignmentRule resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/AssignmentRule-rule.write_assignment_rule.write.jsonMergePatch"}}},"required":true}}},"/api/attachments/{id}":{"get":{"operationId":"api_attachments_id_get","tags":["Attachment"],"responses":{"200":{"description":"Attachment resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Attachment.jsonld-attachment.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/Attachment-attachment.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a Attachment resource.","description":"Retrieves a Attachment resource.","parameters":[{"name":"id","in":"path","description":"Attachment identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}},"/api/auto_merge_rules":{"get":{"operationId":"api_auto_merge_rules_get_collection","tags":["AutoMergeRule"],"responses":{"200":{"description":"AutoMergeRule collection","content":{"application/ld+json":{"schema":{"type":"object","description":"AutoMergeRule.jsonld-rule.read_auto_merge.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/AutoMergeRule.jsonld-rule.read_auto_merge.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/AutoMergeRule-rule.read_auto_merge.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of AutoMergeRule resources.","description":"Retrieves the collection of AutoMergeRule resources.","parameters":[]},"post":{"operationId":"api_auto_merge_rules_post","tags":["AutoMergeRule"],"responses":{"201":{"description":"AutoMergeRule resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/AutoMergeRule.jsonld-rule.read_auto_merge.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/AutoMergeRule-rule.read_auto_merge.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a AutoMergeRule resource.","description":"Creates a AutoMergeRule resource.","parameters":[],"requestBody":{"description":"The new AutoMergeRule resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/AutoMergeRule-rule.write_auto_merge.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/AutoMergeRule-rule.write_auto_merge.write"}}},"required":true}}},"/api/auto_merge_rules/{id}":{"get":{"operationId":"api_auto_merge_rules_id_get","tags":["AutoMergeRule"],"responses":{"200":{"description":"AutoMergeRule resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/AutoMergeRule.jsonld-rule.read_auto_merge.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/AutoMergeRule-rule.read_auto_merge.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a AutoMergeRule resource.","description":"Retrieves a AutoMergeRule resource.","parameters":[{"name":"id","in":"path","description":"AutoMergeRule identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_auto_merge_rules_id_delete","tags":["AutoMergeRule"],"responses":{"204":{"description":"AutoMergeRule resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the AutoMergeRule resource.","description":"Removes the AutoMergeRule resource.","parameters":[{"name":"id","in":"path","description":"AutoMergeRule identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_auto_merge_rules_id_patch","tags":["AutoMergeRule"],"responses":{"200":{"description":"AutoMergeRule resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/AutoMergeRule.jsonld-rule.read_auto_merge.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/AutoMergeRule-rule.read_auto_merge.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the AutoMergeRule resource.","description":"Updates the AutoMergeRule resource.","parameters":[{"name":"id","in":"path","description":"AutoMergeRule identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated AutoMergeRule resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/AutoMergeRule-rule.write_auto_merge.write.jsonMergePatch"}}},"required":true}}},"/api/automations":{"get":{"operationId":"api_automations_get_collection","tags":["Automation"],"responses":{"200":{"description":"Automation collection","content":{"application/ld+json":{"schema":{"type":"object","description":"Automation.jsonld-rule.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Automation.jsonld-rule.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Automation-rule.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of Automation resources.","description":"Retrieves the collection of Automation resources.","parameters":[]},"post":{"operationId":"api_automations_post","tags":["Automation"],"responses":{"201":{"description":"Automation resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Automation.jsonld-rule.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/Automation-rule.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a Automation resource.","description":"Creates a Automation resource.","parameters":[],"requestBody":{"description":"The new Automation resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Automation-rule.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/Automation-rule.write"}}},"required":true}}},"/api/automations/{id}":{"get":{"operationId":"api_automations_id_get","tags":["Automation"],"responses":{"200":{"description":"Automation resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Automation.jsonld-rule.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/Automation-rule.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a Automation resource.","description":"Retrieves a Automation resource.","parameters":[{"name":"id","in":"path","description":"Automation identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_automations_id_delete","tags":["Automation"],"responses":{"204":{"description":"Automation resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the Automation resource.","description":"Removes the Automation resource.","parameters":[{"name":"id","in":"path","description":"Automation identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_automations_id_patch","tags":["Automation"],"responses":{"200":{"description":"Automation resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Automation.jsonld-rule.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/Automation-rule.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the Automation resource.","description":"Updates the Automation resource.","parameters":[{"name":"id","in":"path","description":"Automation identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Automation resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/Automation-rule.write.jsonMergePatch"}}},"required":true}}},"/api/brands":{"get":{"operationId":"api_brands_get_collection","tags":["Brand"],"responses":{"200":{"description":"Brand collection","content":{"application/ld+json":{"schema":{"type":"object","description":"Brand.jsonld-brand.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Brand.jsonld-brand.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Brand-brand.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of Brand resources.","description":"Retrieves the collection of Brand resources.","parameters":[]},"post":{"operationId":"api_brands_post","tags":["Brand"],"responses":{"201":{"description":"Brand resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Brand.jsonld-brand.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/Brand-brand.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a Brand resource.","description":"Creates a Brand resource.","parameters":[],"requestBody":{"description":"The new Brand resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Brand-brand.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/Brand-brand.write"}}},"required":true}}},"/api/brands/{id}":{"get":{"operationId":"api_brands_id_get","tags":["Brand"],"responses":{"200":{"description":"Brand resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Brand.jsonld-brand.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/Brand-brand.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a Brand resource.","description":"Retrieves a Brand resource.","parameters":[{"name":"id","in":"path","description":"Brand identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_brands_id_patch","tags":["Brand"],"responses":{"200":{"description":"Brand resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Brand.jsonld-brand.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/Brand-brand.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the Brand resource.","description":"Updates the Brand resource.","parameters":[{"name":"id","in":"path","description":"Brand identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Brand resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/Brand-brand.write.jsonMergePatch"}}},"required":true}}},"/api/business_schedules":{"get":{"operationId":"api_business_schedules_get_collection","tags":["BusinessSchedule"],"responses":{"200":{"description":"BusinessSchedule collection","content":{"application/ld+json":{"schema":{"type":"object","description":"BusinessSchedule.jsonld-schedule.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/BusinessSchedule.jsonld-schedule.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BusinessSchedule-schedule.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of BusinessSchedule resources.","description":"Retrieves the collection of BusinessSchedule resources.","parameters":[]},"post":{"operationId":"api_business_schedules_post","tags":["BusinessSchedule"],"responses":{"201":{"description":"BusinessSchedule resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/BusinessSchedule.jsonld-schedule.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/BusinessSchedule-schedule.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a BusinessSchedule resource.","description":"Creates a BusinessSchedule resource.","parameters":[],"requestBody":{"description":"The new BusinessSchedule resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/BusinessSchedule-schedule.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/BusinessSchedule-schedule.write"}}},"required":true}}},"/api/business_schedules/{id}":{"get":{"operationId":"api_business_schedules_id_get","tags":["BusinessSchedule"],"responses":{"200":{"description":"BusinessSchedule resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/BusinessSchedule.jsonld-schedule.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/BusinessSchedule-schedule.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a BusinessSchedule resource.","description":"Retrieves a BusinessSchedule resource.","parameters":[{"name":"id","in":"path","description":"BusinessSchedule identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_business_schedules_id_delete","tags":["BusinessSchedule"],"responses":{"204":{"description":"BusinessSchedule resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the BusinessSchedule resource.","description":"Removes the BusinessSchedule resource.","parameters":[{"name":"id","in":"path","description":"BusinessSchedule identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_business_schedules_id_patch","tags":["BusinessSchedule"],"responses":{"200":{"description":"BusinessSchedule resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/BusinessSchedule.jsonld-schedule.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/BusinessSchedule-schedule.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the BusinessSchedule resource.","description":"Updates the BusinessSchedule resource.","parameters":[{"name":"id","in":"path","description":"BusinessSchedule identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated BusinessSchedule resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/BusinessSchedule-schedule.write.jsonMergePatch"}}},"required":true}}},"/api/contextual_workspaces":{"get":{"operationId":"api_contextual_workspaces_get_collection","tags":["ContextualWorkspace"],"responses":{"200":{"description":"ContextualWorkspace collection","content":{"application/ld+json":{"schema":{"type":"object","description":"ContextualWorkspace.jsonld-rule.read_workspace.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/ContextualWorkspace.jsonld-rule.read_workspace.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ContextualWorkspace-rule.read_workspace.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of ContextualWorkspace resources.","description":"Retrieves the collection of ContextualWorkspace resources.","parameters":[]},"post":{"operationId":"api_contextual_workspaces_post","tags":["ContextualWorkspace"],"responses":{"201":{"description":"ContextualWorkspace resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ContextualWorkspace.jsonld-rule.read_workspace.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/ContextualWorkspace-rule.read_workspace.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a ContextualWorkspace resource.","description":"Creates a ContextualWorkspace resource.","parameters":[],"requestBody":{"description":"The new ContextualWorkspace resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ContextualWorkspace-rule.write_workspace.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/ContextualWorkspace-rule.write_workspace.write"}}},"required":true}}},"/api/contextual_workspaces/{id}":{"get":{"operationId":"api_contextual_workspaces_id_get","tags":["ContextualWorkspace"],"responses":{"200":{"description":"ContextualWorkspace resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ContextualWorkspace.jsonld-rule.read_workspace.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/ContextualWorkspace-rule.read_workspace.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a ContextualWorkspace resource.","description":"Retrieves a ContextualWorkspace resource.","parameters":[{"name":"id","in":"path","description":"ContextualWorkspace identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_contextual_workspaces_id_delete","tags":["ContextualWorkspace"],"responses":{"204":{"description":"ContextualWorkspace resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the ContextualWorkspace resource.","description":"Removes the ContextualWorkspace resource.","parameters":[{"name":"id","in":"path","description":"ContextualWorkspace identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_contextual_workspaces_id_patch","tags":["ContextualWorkspace"],"responses":{"200":{"description":"ContextualWorkspace resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ContextualWorkspace.jsonld-rule.read_workspace.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/ContextualWorkspace-rule.read_workspace.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the ContextualWorkspace resource.","description":"Updates the ContextualWorkspace resource.","parameters":[{"name":"id","in":"path","description":"ContextualWorkspace identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated ContextualWorkspace resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/ContextualWorkspace-rule.write_workspace.write.jsonMergePatch"}}},"required":true}}},"/api/csat_reasons":{"get":{"operationId":"api_csat_reasons_get_collection","tags":["CsatReason"],"responses":{"200":{"description":"CsatReason collection","content":{"application/ld+json":{"schema":{"type":"object","description":"CsatReason.jsonld-csat_reason.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/CsatReason.jsonld-csat_reason.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CsatReason-csat_reason.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of CsatReason resources.","description":"Retrieves the collection of CsatReason resources.","parameters":[]},"post":{"operationId":"api_csat_reasons_post","tags":["CsatReason"],"responses":{"201":{"description":"CsatReason resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/CsatReason.jsonld-csat_reason.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/CsatReason-csat_reason.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a CsatReason resource.","description":"Creates a CsatReason resource.","parameters":[],"requestBody":{"description":"The new CsatReason resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/CsatReason-csat_reason.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/CsatReason-csat_reason.write"}}},"required":true}}},"/api/csat_reasons/{id}":{"get":{"operationId":"api_csat_reasons_id_get","tags":["CsatReason"],"responses":{"200":{"description":"CsatReason resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/CsatReason.jsonld-csat_reason.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/CsatReason-csat_reason.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a CsatReason resource.","description":"Retrieves a CsatReason resource.","parameters":[{"name":"id","in":"path","description":"CsatReason identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_csat_reasons_id_delete","tags":["CsatReason"],"responses":{"204":{"description":"CsatReason resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the CsatReason resource.","description":"Removes the CsatReason resource.","parameters":[{"name":"id","in":"path","description":"CsatReason identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_csat_reasons_id_patch","tags":["CsatReason"],"responses":{"200":{"description":"CsatReason resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/CsatReason.jsonld-csat_reason.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/CsatReason-csat_reason.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the CsatReason resource.","description":"Updates the CsatReason resource.","parameters":[{"name":"id","in":"path","description":"CsatReason identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated CsatReason resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/CsatReason-csat_reason.write.jsonMergePatch"}}},"required":true}}},"/api/custom_agent_statuses":{"get":{"operationId":"api_custom_agent_statuses_get_collection","tags":["CustomAgentStatus"],"responses":{"200":{"description":"CustomAgentStatus collection","content":{"application/ld+json":{"schema":{"type":"object","description":"CustomAgentStatus.jsonld-custom_agent_status.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/CustomAgentStatus.jsonld-custom_agent_status.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/CustomAgentStatus-custom_agent_status.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of CustomAgentStatus resources.","description":"Retrieves the collection of CustomAgentStatus resources.","parameters":[]},"post":{"operationId":"api_custom_agent_statuses_post","tags":["CustomAgentStatus"],"responses":{"201":{"description":"CustomAgentStatus resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/CustomAgentStatus.jsonld-custom_agent_status.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomAgentStatus-custom_agent_status.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a CustomAgentStatus resource.","description":"Creates a CustomAgentStatus resource.","parameters":[],"requestBody":{"description":"The new CustomAgentStatus resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/CustomAgentStatus-custom_agent_status.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomAgentStatus-custom_agent_status.write"}}},"required":true}}},"/api/custom_agent_statuses/{id}":{"get":{"operationId":"api_custom_agent_statuses_id_get","tags":["CustomAgentStatus"],"responses":{"200":{"description":"CustomAgentStatus resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/CustomAgentStatus.jsonld-custom_agent_status.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomAgentStatus-custom_agent_status.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a CustomAgentStatus resource.","description":"Retrieves a CustomAgentStatus resource.","parameters":[{"name":"id","in":"path","description":"CustomAgentStatus identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_custom_agent_statuses_id_delete","tags":["CustomAgentStatus"],"responses":{"204":{"description":"CustomAgentStatus resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the CustomAgentStatus resource.","description":"Removes the CustomAgentStatus resource.","parameters":[{"name":"id","in":"path","description":"CustomAgentStatus identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_custom_agent_statuses_id_patch","tags":["CustomAgentStatus"],"responses":{"200":{"description":"CustomAgentStatus resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/CustomAgentStatus.jsonld-custom_agent_status.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomAgentStatus-custom_agent_status.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the CustomAgentStatus resource.","description":"Updates the CustomAgentStatus resource.","parameters":[{"name":"id","in":"path","description":"CustomAgentStatus identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated CustomAgentStatus resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/CustomAgentStatus-custom_agent_status.write.jsonMergePatch"}}},"required":true}}},"/api/users/{id}/customer_context":{"get":{"operationId":"api_users_idcustomer_context_get","tags":["CustomerContext"],"responses":{"200":{"description":"CustomerContext resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/CustomerContext.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/CustomerContext"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a CustomerContext resource.","description":"Retrieves a CustomerContext resource.","parameters":[{"name":"id","in":"path","description":"CustomerContext identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}},"/api/dynamic_content_items":{"get":{"operationId":"api_dynamic_content_items_get_collection","tags":["DynamicContentItem"],"responses":{"200":{"description":"DynamicContentItem collection","content":{"application/ld+json":{"schema":{"type":"object","description":"DynamicContentItem.jsonld-dc.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/DynamicContentItem.jsonld-dc.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DynamicContentItem-dc.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of DynamicContentItem resources.","description":"Retrieves the collection of DynamicContentItem resources.","parameters":[]},"post":{"operationId":"api_dynamic_content_items_post","tags":["DynamicContentItem"],"responses":{"201":{"description":"DynamicContentItem resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/DynamicContentItem.jsonld-dc.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/DynamicContentItem-dc.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a DynamicContentItem resource.","description":"Creates a DynamicContentItem resource.","parameters":[],"requestBody":{"description":"The new DynamicContentItem resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/DynamicContentItem-dc.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/DynamicContentItem-dc.write"}}},"required":true}}},"/api/dynamic_content_items/{id}":{"get":{"operationId":"api_dynamic_content_items_id_get","tags":["DynamicContentItem"],"responses":{"200":{"description":"DynamicContentItem resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/DynamicContentItem.jsonld-dc.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/DynamicContentItem-dc.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a DynamicContentItem resource.","description":"Retrieves a DynamicContentItem resource.","parameters":[{"name":"id","in":"path","description":"DynamicContentItem identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_dynamic_content_items_id_delete","tags":["DynamicContentItem"],"responses":{"204":{"description":"DynamicContentItem resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the DynamicContentItem resource.","description":"Removes the DynamicContentItem resource.","parameters":[{"name":"id","in":"path","description":"DynamicContentItem identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_dynamic_content_items_id_patch","tags":["DynamicContentItem"],"responses":{"200":{"description":"DynamicContentItem resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/DynamicContentItem.jsonld-dc.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/DynamicContentItem-dc.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the DynamicContentItem resource.","description":"Updates the DynamicContentItem resource.","parameters":[{"name":"id","in":"path","description":"DynamicContentItem identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated DynamicContentItem resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/DynamicContentItem-dc.write.jsonMergePatch"}}},"required":true}}},"/api/email_templates":{"get":{"operationId":"api_email_templates_get_collection","tags":["EmailTemplate"],"responses":{"200":{"description":"EmailTemplate collection","content":{"application/ld+json":{"schema":{"type":"object","description":"EmailTemplate.jsonld collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/EmailTemplate.jsonld"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EmailTemplate"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of EmailTemplate resources.","description":"Retrieves the collection of EmailTemplate resources.","parameters":[]}},"/api/email_templates/{key}":{"get":{"operationId":"api_email_templates_key_get","tags":["EmailTemplate"],"responses":{"200":{"description":"EmailTemplate resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/EmailTemplate.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplate"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a EmailTemplate resource.","description":"Retrieves a EmailTemplate resource.","parameters":[{"name":"key","in":"path","description":"EmailTemplate identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_email_templates_key_delete","tags":["EmailTemplate"],"responses":{"204":{"description":"EmailTemplate resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the EmailTemplate resource.","description":"Removes the EmailTemplate resource.","parameters":[{"name":"key","in":"path","description":"EmailTemplate identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_email_templates_key_patch","tags":["EmailTemplate"],"responses":{"200":{"description":"EmailTemplate resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/EmailTemplate.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplate"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the EmailTemplate resource.","description":"Updates the EmailTemplate resource.","parameters":[{"name":"key","in":"path","description":"EmailTemplate identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated EmailTemplate resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/EmailTemplate.jsonMergePatch"}}},"required":true}}},"/api/email_templates/{key}/preview":{"post":{"operationId":"api_email_templates_keypreview_post","tags":["EmailTemplate"],"responses":{"200":{"description":"EmailTemplate resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/EmailTemplate.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplate"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a EmailTemplate resource.","description":"Creates a EmailTemplate resource.","parameters":[{"name":"key","in":"path","description":"EmailTemplate identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The new EmailTemplate resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/EmailTemplate"}},"application/json":{"schema":{"$ref":"#/components/schemas/EmailTemplate"}}},"required":true}}},"/api/groups":{"get":{"operationId":"api_groups_get_collection","tags":["Group"],"responses":{"200":{"description":"Group collection","content":{"application/ld+json":{"schema":{"type":"object","description":"Group.jsonld-group.read_group.summary_user.summary collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Group.jsonld-group.read_group.summary_user.summary"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Group-group.read_group.summary_user.summary"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of Group resources.","description":"Retrieves the collection of Group resources.","parameters":[]},"post":{"operationId":"api_groups_post","tags":["Group"],"responses":{"201":{"description":"Group resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Group.jsonld-group.read_group.summary_user.summary"}},"application/json":{"schema":{"$ref":"#/components/schemas/Group-group.read_group.summary_user.summary"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a Group resource.","description":"Creates a Group resource.","parameters":[],"requestBody":{"description":"The new Group resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Group-group.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/Group-group.write"}}},"required":true}}},"/api/groups/{id}":{"get":{"operationId":"api_groups_id_get","tags":["Group"],"responses":{"200":{"description":"Group resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Group.jsonld-group.read_group.summary_user.summary"}},"application/json":{"schema":{"$ref":"#/components/schemas/Group-group.read_group.summary_user.summary"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a Group resource.","description":"Retrieves a Group resource.","parameters":[{"name":"id","in":"path","description":"Group identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_groups_id_delete","tags":["Group"],"responses":{"204":{"description":"Group resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the Group resource.","description":"Removes the Group resource.","parameters":[{"name":"id","in":"path","description":"Group identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_groups_id_patch","tags":["Group"],"responses":{"200":{"description":"Group resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Group.jsonld-group.read_group.summary_user.summary"}},"application/json":{"schema":{"$ref":"#/components/schemas/Group-group.read_group.summary_user.summary"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the Group resource.","description":"Updates the Group resource.","parameters":[{"name":"id","in":"path","description":"Group identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Group resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/Group-group.write.jsonMergePatch"}}},"required":true}}},"/api/holidays":{"get":{"operationId":"api_holidays_get_collection","tags":["Holiday"],"responses":{"200":{"description":"Holiday collection","content":{"application/ld+json":{"schema":{"type":"object","description":"Holiday.jsonld-holiday.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Holiday.jsonld-holiday.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Holiday-holiday.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of Holiday resources.","description":"Retrieves the collection of Holiday resources.","parameters":[{"name":"schedule","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"schedule[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true}]},"post":{"operationId":"api_holidays_post","tags":["Holiday"],"responses":{"201":{"description":"Holiday resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Holiday.jsonld-holiday.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/Holiday-holiday.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a Holiday resource.","description":"Creates a Holiday resource.","parameters":[],"requestBody":{"description":"The new Holiday resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Holiday-holiday.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/Holiday-holiday.write"}}},"required":true}}},"/api/holidays/{id}":{"get":{"operationId":"api_holidays_id_get","tags":["Holiday"],"responses":{"200":{"description":"Holiday resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Holiday.jsonld-holiday.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/Holiday-holiday.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a Holiday resource.","description":"Retrieves a Holiday resource.","parameters":[{"name":"id","in":"path","description":"Holiday identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_holidays_id_delete","tags":["Holiday"],"responses":{"204":{"description":"Holiday resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the Holiday resource.","description":"Removes the Holiday resource.","parameters":[{"name":"id","in":"path","description":"Holiday identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_holidays_id_patch","tags":["Holiday"],"responses":{"200":{"description":"Holiday resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Holiday.jsonld-holiday.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/Holiday-holiday.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the Holiday resource.","description":"Updates the Holiday resource.","parameters":[{"name":"id","in":"path","description":"Holiday identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Holiday resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/Holiday-holiday.write.jsonMergePatch"}}},"required":true}}},"/api/macros":{"get":{"operationId":"api_macros_get_collection","tags":["Macro"],"responses":{"200":{"description":"Macro collection","content":{"application/ld+json":{"schema":{"type":"object","description":"Macro.jsonld-rule.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Macro.jsonld-rule.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Macro-rule.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of Macro resources.","description":"Retrieves the collection of Macro resources.","parameters":[]},"post":{"operationId":"api_macros_post","tags":["Macro"],"responses":{"201":{"description":"Macro resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Macro.jsonld-rule.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/Macro-rule.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a Macro resource.","description":"Creates a Macro resource.","parameters":[],"requestBody":{"description":"The new Macro resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Macro-rule.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/Macro-rule.write"}}},"required":true}}},"/api/macros/{id}":{"get":{"operationId":"api_macros_id_get","tags":["Macro"],"responses":{"200":{"description":"Macro resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Macro.jsonld-rule.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/Macro-rule.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a Macro resource.","description":"Retrieves a Macro resource.","parameters":[{"name":"id","in":"path","description":"Macro identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_macros_id_delete","tags":["Macro"],"responses":{"204":{"description":"Macro resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the Macro resource.","description":"Removes the Macro resource.","parameters":[{"name":"id","in":"path","description":"Macro identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_macros_id_patch","tags":["Macro"],"responses":{"200":{"description":"Macro resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Macro.jsonld-rule.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/Macro-rule.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the Macro resource.","description":"Updates the Macro resource.","parameters":[{"name":"id","in":"path","description":"Macro identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Macro resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/Macro-rule.write.jsonMergePatch"}}},"required":true}}},"/api/organizations":{"get":{"operationId":"api_organizations_get_collection","tags":["Organization"],"responses":{"200":{"description":"Organization collection","content":{"application/ld+json":{"schema":{"type":"object","description":"Organization.jsonld-org.read_org.summary_group.summary collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Organization.jsonld-org.read_org.summary_group.summary"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Organization-org.read_org.summary_group.summary"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of Organization resources.","description":"Retrieves the collection of Organization resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":true},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":25,"minimum":0,"maximum":100},"style":"form","explode":true},{"name":"name","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false}]},"post":{"operationId":"api_organizations_post","tags":["Organization"],"responses":{"201":{"description":"Organization resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Organization.jsonld-org.read_org.summary_group.summary"}},"application/json":{"schema":{"$ref":"#/components/schemas/Organization-org.read_org.summary_group.summary"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a Organization resource.","description":"Creates a Organization resource.","parameters":[],"requestBody":{"description":"The new Organization resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Organization-org.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/Organization-org.write"}}},"required":true}}},"/api/organizations/{id}":{"get":{"operationId":"api_organizations_id_get","tags":["Organization"],"responses":{"200":{"description":"Organization resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Organization.jsonld-org.read_org.summary_group.summary"}},"application/json":{"schema":{"$ref":"#/components/schemas/Organization-org.read_org.summary_group.summary"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a Organization resource.","description":"Retrieves a Organization resource.","parameters":[{"name":"id","in":"path","description":"Organization identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_organizations_id_delete","tags":["Organization"],"responses":{"204":{"description":"Organization resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the Organization resource.","description":"Removes the Organization resource.","parameters":[{"name":"id","in":"path","description":"Organization identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_organizations_id_patch","tags":["Organization"],"responses":{"200":{"description":"Organization resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Organization.jsonld-org.read_org.summary_group.summary"}},"application/json":{"schema":{"$ref":"#/components/schemas/Organization-org.read_org.summary_group.summary"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the Organization resource.","description":"Updates the Organization resource.","parameters":[{"name":"id","in":"path","description":"Organization identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Organization resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/Organization-org.write.jsonMergePatch"}}},"required":true}}},"/api/organization_fields":{"get":{"operationId":"api_organization_fields_get_collection","tags":["OrganizationField"],"responses":{"200":{"description":"OrganizationField collection","content":{"application/ld+json":{"schema":{"type":"object","description":"OrganizationField.jsonld-people_field.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationField.jsonld-people_field.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationField-people_field.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of OrganizationField resources.","description":"Retrieves the collection of OrganizationField resources.","parameters":[]},"post":{"operationId":"api_organization_fields_post","tags":["OrganizationField"],"responses":{"201":{"description":"OrganizationField resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/OrganizationField.jsonld-people_field.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationField-people_field.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a OrganizationField resource.","description":"Creates a OrganizationField resource.","parameters":[],"requestBody":{"description":"The new OrganizationField resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/OrganizationField-people_field.write_people_field.create"}},"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationField-people_field.write_people_field.create"}}},"required":true}}},"/api/organization_fields/{id}":{"get":{"operationId":"api_organization_fields_id_get","tags":["OrganizationField"],"responses":{"200":{"description":"OrganizationField resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/OrganizationField.jsonld-people_field.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationField-people_field.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a OrganizationField resource.","description":"Retrieves a OrganizationField resource.","parameters":[{"name":"id","in":"path","description":"OrganizationField identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_organization_fields_id_delete","tags":["OrganizationField"],"responses":{"204":{"description":"OrganizationField resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the OrganizationField resource.","description":"Removes the OrganizationField resource.","parameters":[{"name":"id","in":"path","description":"OrganizationField identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_organization_fields_id_patch","tags":["OrganizationField"],"responses":{"200":{"description":"OrganizationField resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/OrganizationField.jsonld-people_field.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationField-people_field.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the OrganizationField resource.","description":"Updates the OrganizationField resource.","parameters":[{"name":"id","in":"path","description":"OrganizationField identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated OrganizationField resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/OrganizationField-people_field.write.jsonMergePatch"}}},"required":true}}},"/api/realtime/token":{"get":{"operationId":"api_realtimetoken_get","tags":["RealtimeToken"],"responses":{"200":{"description":"RealtimeToken resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/RealtimeToken.jsonld"}},"application/json":{"schema":{"$ref":"#/components/schemas/RealtimeToken"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a RealtimeToken resource.","description":"Retrieves a RealtimeToken resource.","parameters":[]}},"/api/redaction_rules":{"get":{"operationId":"api_redaction_rules_get_collection","tags":["RedactionRule"],"responses":{"200":{"description":"RedactionRule collection","content":{"application/ld+json":{"schema":{"type":"object","description":"RedactionRule.jsonld-redaction_rule.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/RedactionRule.jsonld-redaction_rule.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RedactionRule-redaction_rule.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of RedactionRule resources.","description":"Retrieves the collection of RedactionRule resources.","parameters":[]},"post":{"operationId":"api_redaction_rules_post","tags":["RedactionRule"],"responses":{"201":{"description":"RedactionRule resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/RedactionRule.jsonld-redaction_rule.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/RedactionRule-redaction_rule.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a RedactionRule resource.","description":"Creates a RedactionRule resource.","parameters":[],"requestBody":{"description":"The new RedactionRule resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/RedactionRule-redaction_rule.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/RedactionRule-redaction_rule.write"}}},"required":true}}},"/api/redaction_rules/{id}":{"get":{"operationId":"api_redaction_rules_id_get","tags":["RedactionRule"],"responses":{"200":{"description":"RedactionRule resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/RedactionRule.jsonld-redaction_rule.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/RedactionRule-redaction_rule.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a RedactionRule resource.","description":"Retrieves a RedactionRule resource.","parameters":[{"name":"id","in":"path","description":"RedactionRule identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_redaction_rules_id_delete","tags":["RedactionRule"],"responses":{"204":{"description":"RedactionRule resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the RedactionRule resource.","description":"Removes the RedactionRule resource.","parameters":[{"name":"id","in":"path","description":"RedactionRule identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_redaction_rules_id_patch","tags":["RedactionRule"],"responses":{"200":{"description":"RedactionRule resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/RedactionRule.jsonld-redaction_rule.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/RedactionRule-redaction_rule.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the RedactionRule resource.","description":"Updates the RedactionRule resource.","parameters":[{"name":"id","in":"path","description":"RedactionRule identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated RedactionRule resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/RedactionRule-redaction_rule.write.jsonMergePatch"}}},"required":true}}},"/api/retention_policies":{"get":{"operationId":"api_retention_policies_get_collection","tags":["RetentionPolicy"],"responses":{"200":{"description":"RetentionPolicy collection","content":{"application/ld+json":{"schema":{"type":"object","description":"RetentionPolicy.jsonld-retention.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/RetentionPolicy.jsonld-retention.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RetentionPolicy-retention.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of RetentionPolicy resources.","description":"Retrieves the collection of RetentionPolicy resources.","parameters":[]},"post":{"operationId":"api_retention_policies_post","tags":["RetentionPolicy"],"responses":{"201":{"description":"RetentionPolicy resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/RetentionPolicy.jsonld-retention.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/RetentionPolicy-retention.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a RetentionPolicy resource.","description":"Creates a RetentionPolicy resource.","parameters":[],"requestBody":{"description":"The new RetentionPolicy resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/RetentionPolicy-retention.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/RetentionPolicy-retention.write"}}},"required":true}}},"/api/retention_policies/{id}":{"get":{"operationId":"api_retention_policies_id_get","tags":["RetentionPolicy"],"responses":{"200":{"description":"RetentionPolicy resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/RetentionPolicy.jsonld-retention.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/RetentionPolicy-retention.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a RetentionPolicy resource.","description":"Retrieves a RetentionPolicy resource.","parameters":[{"name":"id","in":"path","description":"RetentionPolicy identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_retention_policies_id_delete","tags":["RetentionPolicy"],"responses":{"204":{"description":"RetentionPolicy resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the RetentionPolicy resource.","description":"Removes the RetentionPolicy resource.","parameters":[{"name":"id","in":"path","description":"RetentionPolicy identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_retention_policies_id_patch","tags":["RetentionPolicy"],"responses":{"200":{"description":"RetentionPolicy resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/RetentionPolicy.jsonld-retention.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/RetentionPolicy-retention.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the RetentionPolicy resource.","description":"Updates the RetentionPolicy resource.","parameters":[{"name":"id","in":"path","description":"RetentionPolicy identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated RetentionPolicy resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/RetentionPolicy-retention.write.jsonMergePatch"}}},"required":true}}},"/api/roles":{"get":{"operationId":"api_roles_get_collection","tags":["Role"],"responses":{"200":{"description":"Role collection","content":{"application/ld+json":{"schema":{"type":"object","description":"Role.jsonld-role.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Role.jsonld-role.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Role-role.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of Role resources.","description":"Retrieves the collection of Role resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":true},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":25,"minimum":0,"maximum":100},"style":"form","explode":true}]},"post":{"operationId":"api_roles_post","tags":["Role"],"responses":{"201":{"description":"Role resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Role.jsonld-role.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/Role-role.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a Role resource.","description":"Creates a Role resource.","parameters":[],"requestBody":{"description":"The new Role resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Role-role.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/Role-role.write"}}},"required":true}}},"/api/roles/{id}":{"get":{"operationId":"api_roles_id_get","tags":["Role"],"responses":{"200":{"description":"Role resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Role.jsonld-role.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/Role-role.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a Role resource.","description":"Retrieves a Role resource.","parameters":[{"name":"id","in":"path","description":"Role identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_roles_id_delete","tags":["Role"],"responses":{"204":{"description":"Role resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the Role resource.","description":"Removes the Role resource.","parameters":[{"name":"id","in":"path","description":"Role identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_roles_id_patch","tags":["Role"],"responses":{"200":{"description":"Role resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Role.jsonld-role.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/Role-role.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the Role resource.","description":"Updates the Role resource.","parameters":[{"name":"id","in":"path","description":"Role identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Role resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/Role-role.write.jsonMergePatch"}}},"required":true}}},"/api/sla_policies":{"get":{"operationId":"api_sla_policies_get_collection","tags":["SlaPolicy"],"responses":{"200":{"description":"SlaPolicy collection","content":{"application/ld+json":{"schema":{"type":"object","description":"SlaPolicy.jsonld-rule.read_sla_policy.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/SlaPolicy.jsonld-rule.read_sla_policy.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SlaPolicy-rule.read_sla_policy.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of SlaPolicy resources.","description":"Retrieves the collection of SlaPolicy resources.","parameters":[]},"post":{"operationId":"api_sla_policies_post","tags":["SlaPolicy"],"responses":{"201":{"description":"SlaPolicy resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/SlaPolicy.jsonld-rule.read_sla_policy.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/SlaPolicy-rule.read_sla_policy.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a SlaPolicy resource.","description":"Creates a SlaPolicy resource.","parameters":[],"requestBody":{"description":"The new SlaPolicy resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/SlaPolicy-rule.write_sla_policy.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/SlaPolicy-rule.write_sla_policy.write"}}},"required":true}}},"/api/sla_policies/{id}":{"get":{"operationId":"api_sla_policies_id_get","tags":["SlaPolicy"],"responses":{"200":{"description":"SlaPolicy resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/SlaPolicy.jsonld-rule.read_sla_policy.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/SlaPolicy-rule.read_sla_policy.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a SlaPolicy resource.","description":"Retrieves a SlaPolicy resource.","parameters":[{"name":"id","in":"path","description":"SlaPolicy identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_sla_policies_id_delete","tags":["SlaPolicy"],"responses":{"204":{"description":"SlaPolicy resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the SlaPolicy resource.","description":"Removes the SlaPolicy resource.","parameters":[{"name":"id","in":"path","description":"SlaPolicy identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_sla_policies_id_patch","tags":["SlaPolicy"],"responses":{"200":{"description":"SlaPolicy resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/SlaPolicy.jsonld-rule.read_sla_policy.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/SlaPolicy-rule.read_sla_policy.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the SlaPolicy resource.","description":"Updates the SlaPolicy resource.","parameters":[{"name":"id","in":"path","description":"SlaPolicy identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated SlaPolicy resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/SlaPolicy-rule.write_sla_policy.write.jsonMergePatch"}}},"required":true}}},"/api/support_addresses":{"get":{"operationId":"api_support_addresses_get_collection","tags":["SupportAddress"],"responses":{"200":{"description":"SupportAddress collection","content":{"application/ld+json":{"schema":{"type":"object","description":"SupportAddress.jsonld-address.read_brand.read_group.summary collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/SupportAddress.jsonld-address.read_brand.read_group.summary"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SupportAddress-address.read_brand.read_group.summary"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of SupportAddress resources.","description":"Retrieves the collection of SupportAddress resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":true},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":50,"minimum":0,"maximum":500},"style":"form","explode":true},{"name":"email","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"name","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"brand","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"brand[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"default_group","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"default_group[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"forwarding_status","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"forwarding_status[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"order[email]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"style":"form","explode":false},{"name":"order[name]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"style":"form","explode":false},{"name":"order[forwarding_status]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"style":"form","explode":false}]},"post":{"operationId":"api_support_addresses_post","tags":["SupportAddress"],"responses":{"201":{"description":"SupportAddress resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/SupportAddress.jsonld-address.read_brand.read_group.summary"}},"application/json":{"schema":{"$ref":"#/components/schemas/SupportAddress-address.read_brand.read_group.summary"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a SupportAddress resource.","description":"Creates a SupportAddress resource.","parameters":[],"requestBody":{"description":"The new SupportAddress resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/SupportAddress-address.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/SupportAddress-address.write"}}},"required":true}}},"/api/support_addresses/{id}":{"get":{"operationId":"api_support_addresses_id_get","tags":["SupportAddress"],"responses":{"200":{"description":"SupportAddress resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/SupportAddress.jsonld-address.read_brand.read_group.summary"}},"application/json":{"schema":{"$ref":"#/components/schemas/SupportAddress-address.read_brand.read_group.summary"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a SupportAddress resource.","description":"Retrieves a SupportAddress resource.","parameters":[{"name":"id","in":"path","description":"SupportAddress identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_support_addresses_id_delete","tags":["SupportAddress"],"responses":{"204":{"description":"SupportAddress resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the SupportAddress resource.","description":"Removes the SupportAddress resource.","parameters":[{"name":"id","in":"path","description":"SupportAddress identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_support_addresses_id_patch","tags":["SupportAddress"],"responses":{"200":{"description":"SupportAddress resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/SupportAddress.jsonld-address.read_brand.read_group.summary"}},"application/json":{"schema":{"$ref":"#/components/schemas/SupportAddress-address.read_brand.read_group.summary"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the SupportAddress resource.","description":"Updates the SupportAddress resource.","parameters":[{"name":"id","in":"path","description":"SupportAddress identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated SupportAddress resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/SupportAddress-address.write.jsonMergePatch"}}},"required":true}}},"/api/suspended_tickets":{"get":{"operationId":"api_suspended_tickets_get_collection","tags":["SuspendedTicket"],"responses":{"200":{"description":"SuspendedTicket collection","content":{"application/ld+json":{"schema":{"type":"object","description":"SuspendedTicket.jsonld-suspended.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/SuspendedTicket.jsonld-suspended.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SuspendedTicket-suspended.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of SuspendedTicket resources.","description":"Retrieves the collection of SuspendedTicket resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":true},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":25,"minimum":0,"maximum":100},"style":"form","explode":true},{"name":"exists[resolved_at]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"cause","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"cause[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"recipient","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"recipient[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"from_address","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"subject","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false}]}},"/api/suspended_tickets/{id}":{"get":{"operationId":"api_suspended_tickets_id_get","tags":["SuspendedTicket"],"responses":{"200":{"description":"SuspendedTicket resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/SuspendedTicket.jsonld-suspended.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/SuspendedTicket-suspended.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a SuspendedTicket resource.","description":"Retrieves a SuspendedTicket resource.","parameters":[{"name":"id","in":"path","description":"SuspendedTicket identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_suspended_tickets_id_delete","tags":["SuspendedTicket"],"responses":{"204":{"description":"SuspendedTicket resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the SuspendedTicket resource.","description":"Removes the SuspendedTicket resource.","parameters":[{"name":"id","in":"path","description":"SuspendedTicket identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}},"/api/suspended_tickets/{id}/recover":{"post":{"operationId":"api_suspended_tickets_idrecover_post","tags":["SuspendedTicket"],"responses":{"200":{"description":"SuspendedTicket resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/SuspendedTicket.jsonld-suspended.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/SuspendedTicket-suspended.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a SuspendedTicket resource.","description":"Creates a SuspendedTicket resource.","parameters":[{"name":"id","in":"path","description":"SuspendedTicket identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}},"/api/tags":{"get":{"operationId":"api_tags_get_collection","tags":["Tag"],"responses":{"200":{"description":"Tag collection","content":{"application/ld+json":{"schema":{"type":"object","description":"Tag.jsonld-tag.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Tag.jsonld-tag.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Tag-tag.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of Tag resources.","description":"Retrieves the collection of Tag resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":true},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":25,"minimum":0,"maximum":100},"style":"form","explode":true},{"name":"name","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false}]}},"/api/tickets":{"get":{"operationId":"api_tickets_get_collection","tags":["Ticket"],"responses":{"200":{"description":"Ticket collection","content":{"application/ld+json":{"schema":{"type":"object","description":"Ticket.jsonld-ticket.read_user.summary_group.summary_org.summary collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Ticket.jsonld-ticket.read_user.summary_group.summary_org.summary"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Ticket-ticket.read_user.summary_group.summary_org.summary"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of Ticket resources.","description":"Lists tickets the caller may see. Page-based by default (`page`, `itemsPerPage`). For exports and syncs, use cursor pagination: send `cursor=` (empty) for the first page and follow `links.next`; results are ordered by id (creation order).","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":true},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":25,"minimum":0,"maximum":100},"style":"form","explode":true},{"name":"number","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"integer"},"style":"form","explode":false},{"name":"number[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"integer"}},"style":"form","explode":true},{"name":"status","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"status[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"priority","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"priority[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"type","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"type[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"via","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"via[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"assignee","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"assignee[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"group","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"group[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"requester","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"requester[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"organization","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"organization[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"brand","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"brand[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"exists[assignee]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"exists[group]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"boolean"},"style":"form","explode":false},{"name":"created_at[before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"created_at[strictly_before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"created_at[after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"created_at[strictly_after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"updated_at[before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"updated_at[strictly_before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"updated_at[after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"updated_at[strictly_after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"solved_at[before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"solved_at[strictly_before]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"solved_at[after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"solved_at[strictly_after]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"order[number]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"style":"form","explode":false},{"name":"order[updated_at]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"style":"form","explode":false},{"name":"order[created_at]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"style":"form","explode":false},{"name":"order[status]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"style":"form","explode":false},{"name":"order[priority]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"style":"form","explode":false},{"name":"order[subject]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"style":"form","explode":false},{"name":"cursor","in":"query","description":"Opt into cursor pagination. Empty for the first page, then the opaque `meta.after_cursor` / `meta.before_cursor` value.","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":true,"example":""},{"name":"limit","in":"query","description":"Cursor page size (1-100, default 25).","required":false,"deprecated":false,"schema":{"type":"integer","minimum":1,"maximum":100,"default":25},"style":"form","explode":true}]},"post":{"operationId":"api_tickets_post","tags":["Ticket"],"responses":{"201":{"description":"Ticket resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Ticket.jsonld-ticket.read_user.summary_group.summary_org.summary"}},"application/json":{"schema":{"$ref":"#/components/schemas/Ticket-ticket.read_user.summary_group.summary_org.summary"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a Ticket resource.","description":"Creates a Ticket resource.","parameters":[],"requestBody":{"description":"The new Ticket resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Ticket.TicketCreateInput"}},"application/json":{"schema":{"$ref":"#/components/schemas/Ticket.TicketCreateInput"}}},"required":true}}},"/api/tickets/{id}":{"get":{"operationId":"api_tickets_id_get","tags":["Ticket"],"responses":{"200":{"description":"Ticket resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Ticket.jsonld-ticket.read_user.summary_group.summary_org.summary"}},"application/json":{"schema":{"$ref":"#/components/schemas/Ticket-ticket.read_user.summary_group.summary_org.summary"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a Ticket resource.","description":"Retrieves a Ticket resource.","parameters":[{"name":"id","in":"path","description":"Ticket identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_tickets_id_patch","tags":["Ticket"],"responses":{"200":{"description":"Ticket resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Ticket.jsonld-ticket.read_user.summary_group.summary_org.summary"}},"application/json":{"schema":{"$ref":"#/components/schemas/Ticket-ticket.read_user.summary_group.summary_org.summary"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the Ticket resource.","description":"Updates the Ticket resource.","parameters":[{"name":"id","in":"path","description":"Ticket identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Ticket resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/Ticket.TicketUpdateInput.jsonMergePatch"}}},"required":true}}},"/api/tickets/{ticketId}/audits":{"get":{"operationId":"api_tickets_ticketIdaudits_get_collection","tags":["TicketAudit"],"responses":{"200":{"description":"TicketAudit collection","content":{"application/ld+json":{"schema":{"type":"object","description":"TicketAudit.jsonld-audit.read_user.summary collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/TicketAudit.jsonld-audit.read_user.summary"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TicketAudit-audit.read_user.summary"}}}}}},"summary":"Retrieves the collection of TicketAudit resources.","description":"Retrieves the collection of TicketAudit resources.","parameters":[{"name":"ticketId","in":"path","description":"Ticket identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}},"/api/tickets/{ticketId}/comments":{"get":{"operationId":"api_tickets_ticketIdcomments_get_collection","tags":["TicketComment"],"responses":{"200":{"description":"TicketComment collection","content":{"application/ld+json":{"schema":{"type":"object","description":"TicketComment.jsonld-comment.read_user.summary collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/TicketComment.jsonld-comment.read_user.summary"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TicketComment-comment.read_user.summary"}}}}}},"summary":"Retrieves the collection of TicketComment resources.","description":"Retrieves the collection of TicketComment resources.","parameters":[{"name":"ticketId","in":"path","description":"Ticket identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}},"/api/ticket_fields":{"get":{"operationId":"api_ticket_fields_get_collection","tags":["TicketField"],"responses":{"200":{"description":"TicketField collection","content":{"application/ld+json":{"schema":{"type":"object","description":"TicketField.jsonld-field.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/TicketField.jsonld-field.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TicketField-field.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of TicketField resources.","description":"Retrieves the collection of TicketField resources.","parameters":[]},"post":{"operationId":"api_ticket_fields_post","tags":["TicketField"],"responses":{"201":{"description":"TicketField resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TicketField.jsonld-field.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/TicketField-field.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a TicketField resource.","description":"Creates a TicketField resource.","parameters":[],"requestBody":{"description":"The new TicketField resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TicketField-field.write_field.create"}},"application/json":{"schema":{"$ref":"#/components/schemas/TicketField-field.write_field.create"}}},"required":true}}},"/api/ticket_fields/{id}":{"get":{"operationId":"api_ticket_fields_id_get","tags":["TicketField"],"responses":{"200":{"description":"TicketField resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TicketField.jsonld-field.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/TicketField-field.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a TicketField resource.","description":"Retrieves a TicketField resource.","parameters":[{"name":"id","in":"path","description":"TicketField identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_ticket_fields_id_patch","tags":["TicketField"],"responses":{"200":{"description":"TicketField resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TicketField.jsonld-field.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/TicketField-field.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the TicketField resource.","description":"Updates the TicketField resource.","parameters":[{"name":"id","in":"path","description":"TicketField identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated TicketField resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/TicketField-field.write.jsonMergePatch"}}},"required":true}}},"/api/ticket_forms":{"get":{"operationId":"api_ticket_forms_get_collection","tags":["TicketForm"],"responses":{"200":{"description":"TicketForm collection","content":{"application/ld+json":{"schema":{"type":"object","description":"TicketForm.jsonld-form.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/TicketForm.jsonld-form.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TicketForm-form.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of TicketForm resources.","description":"Retrieves the collection of TicketForm resources.","parameters":[]},"post":{"operationId":"api_ticket_forms_post","tags":["TicketForm"],"responses":{"201":{"description":"TicketForm resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TicketForm.jsonld-form.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/TicketForm-form.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a TicketForm resource.","description":"Creates a TicketForm resource.","parameters":[],"requestBody":{"description":"The new TicketForm resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TicketForm-form.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/TicketForm-form.write"}}},"required":true}}},"/api/ticket_forms/{id}":{"get":{"operationId":"api_ticket_forms_id_get","tags":["TicketForm"],"responses":{"200":{"description":"TicketForm resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TicketForm.jsonld-form.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/TicketForm-form.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a TicketForm resource.","description":"Retrieves a TicketForm resource.","parameters":[{"name":"id","in":"path","description":"TicketForm identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_ticket_forms_id_delete","tags":["TicketForm"],"responses":{"204":{"description":"TicketForm resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the TicketForm resource.","description":"Removes the TicketForm resource.","parameters":[{"name":"id","in":"path","description":"TicketForm identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_ticket_forms_id_patch","tags":["TicketForm"],"responses":{"200":{"description":"TicketForm resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TicketForm.jsonld-form.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/TicketForm-form.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the TicketForm resource.","description":"Updates the TicketForm resource.","parameters":[{"name":"id","in":"path","description":"TicketForm identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated TicketForm resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/TicketForm-form.write.jsonMergePatch"}}},"required":true}}},"/api/ticket_layouts":{"get":{"operationId":"api_ticket_layouts_get_collection","tags":["TicketLayout"],"responses":{"200":{"description":"TicketLayout collection","content":{"application/ld+json":{"schema":{"type":"object","description":"TicketLayout.jsonld-layout.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/TicketLayout.jsonld-layout.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TicketLayout-layout.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of TicketLayout resources.","description":"Retrieves the collection of TicketLayout resources.","parameters":[]},"post":{"operationId":"api_ticket_layouts_post","tags":["TicketLayout"],"responses":{"201":{"description":"TicketLayout resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TicketLayout.jsonld-layout.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/TicketLayout-layout.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a TicketLayout resource.","description":"Creates a TicketLayout resource.","parameters":[],"requestBody":{"description":"The new TicketLayout resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TicketLayout-layout.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/TicketLayout-layout.write"}}},"required":true}}},"/api/ticket_layouts/{id}":{"get":{"operationId":"api_ticket_layouts_id_get","tags":["TicketLayout"],"responses":{"200":{"description":"TicketLayout resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TicketLayout.jsonld-layout.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/TicketLayout-layout.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a TicketLayout resource.","description":"Retrieves a TicketLayout resource.","parameters":[{"name":"id","in":"path","description":"TicketLayout identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_ticket_layouts_id_delete","tags":["TicketLayout"],"responses":{"204":{"description":"TicketLayout resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the TicketLayout resource.","description":"Removes the TicketLayout resource.","parameters":[{"name":"id","in":"path","description":"TicketLayout identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_ticket_layouts_id_patch","tags":["TicketLayout"],"responses":{"200":{"description":"TicketLayout resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TicketLayout.jsonld-layout.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/TicketLayout-layout.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the TicketLayout resource.","description":"Updates the TicketLayout resource.","parameters":[{"name":"id","in":"path","description":"TicketLayout identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated TicketLayout resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/TicketLayout-layout.write.jsonMergePatch"}}},"required":true}}},"/api/triggers":{"get":{"operationId":"api_triggers_get_collection","tags":["Trigger"],"responses":{"200":{"description":"Trigger collection","content":{"application/ld+json":{"schema":{"type":"object","description":"Trigger.jsonld-rule.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Trigger.jsonld-rule.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Trigger-rule.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of Trigger resources.","description":"Retrieves the collection of Trigger resources.","parameters":[]},"post":{"operationId":"api_triggers_post","tags":["Trigger"],"responses":{"201":{"description":"Trigger resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Trigger.jsonld-rule.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/Trigger-rule.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a Trigger resource.","description":"Creates a Trigger resource.","parameters":[],"requestBody":{"description":"The new Trigger resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Trigger-rule.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/Trigger-rule.write"}}},"required":true}}},"/api/triggers/{id}":{"get":{"operationId":"api_triggers_id_get","tags":["Trigger"],"responses":{"200":{"description":"Trigger resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Trigger.jsonld-rule.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/Trigger-rule.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a Trigger resource.","description":"Retrieves a Trigger resource.","parameters":[{"name":"id","in":"path","description":"Trigger identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_triggers_id_delete","tags":["Trigger"],"responses":{"204":{"description":"Trigger resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the Trigger resource.","description":"Removes the Trigger resource.","parameters":[{"name":"id","in":"path","description":"Trigger identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_triggers_id_patch","tags":["Trigger"],"responses":{"200":{"description":"Trigger resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Trigger.jsonld-rule.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/Trigger-rule.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the Trigger resource.","description":"Updates the Trigger resource.","parameters":[{"name":"id","in":"path","description":"Trigger identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Trigger resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/Trigger-rule.write.jsonMergePatch"}}},"required":true}}},"/api/trigger_categories":{"get":{"operationId":"api_trigger_categories_get_collection","tags":["TriggerCategory"],"responses":{"200":{"description":"TriggerCategory collection","content":{"application/ld+json":{"schema":{"type":"object","description":"TriggerCategory.jsonld-trigger_category.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/TriggerCategory.jsonld-trigger_category.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TriggerCategory-trigger_category.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of TriggerCategory resources.","description":"Retrieves the collection of TriggerCategory resources.","parameters":[]},"post":{"operationId":"api_trigger_categories_post","tags":["TriggerCategory"],"responses":{"201":{"description":"TriggerCategory resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TriggerCategory.jsonld-trigger_category.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCategory-trigger_category.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a TriggerCategory resource.","description":"Creates a TriggerCategory resource.","parameters":[],"requestBody":{"description":"The new TriggerCategory resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TriggerCategory-trigger_category.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCategory-trigger_category.write"}}},"required":true}}},"/api/trigger_categories/{id}":{"get":{"operationId":"api_trigger_categories_id_get","tags":["TriggerCategory"],"responses":{"200":{"description":"TriggerCategory resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TriggerCategory.jsonld-trigger_category.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCategory-trigger_category.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a TriggerCategory resource.","description":"Retrieves a TriggerCategory resource.","parameters":[{"name":"id","in":"path","description":"TriggerCategory identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_trigger_categories_id_delete","tags":["TriggerCategory"],"responses":{"204":{"description":"TriggerCategory resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the TriggerCategory resource.","description":"Removes the TriggerCategory resource.","parameters":[{"name":"id","in":"path","description":"TriggerCategory identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_trigger_categories_id_patch","tags":["TriggerCategory"],"responses":{"200":{"description":"TriggerCategory resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/TriggerCategory.jsonld-trigger_category.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCategory-trigger_category.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the TriggerCategory resource.","description":"Updates the TriggerCategory resource.","parameters":[{"name":"id","in":"path","description":"TriggerCategory identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated TriggerCategory resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/TriggerCategory-trigger_category.write.jsonMergePatch"}}},"required":true}}},"/api/me":{"get":{"operationId":"api_me_get","tags":["User"],"responses":{"200":{"description":"User resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/User.jsonld-user.read_user.summary_org.summary_group.summary"}},"application/json":{"schema":{"$ref":"#/components/schemas/User-user.read_user.summary_org.summary_group.summary"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"The authenticated user, with effective permissions.","description":"The authenticated user, with effective permissions.","parameters":[]}},"/api/users":{"get":{"operationId":"api_users_get_collection","tags":["User"],"responses":{"200":{"description":"User collection","content":{"application/ld+json":{"schema":{"type":"object","description":"User.jsonld-user.read_user.summary_org.summary_group.summary collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/User.jsonld-user.read_user.summary_org.summary_group.summary"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/User-user.read_user.summary_org.summary_group.summary"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of User resources.","description":"Retrieves the collection of User resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":true},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":25,"minimum":0,"maximum":100},"style":"form","explode":true},{"name":"role","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"role[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"name","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"email","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"memberships.organization","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"memberships.organization[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"order[name]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"style":"form","explode":false},{"name":"order[created_at]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"style":"form","explode":false},{"name":"order[updated_at]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"style":"form","explode":false},{"name":"q","in":"query","description":"Search name, any email address or phone number.","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false}]},"post":{"operationId":"api_users_post","tags":["User"],"responses":{"201":{"description":"User resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/User.jsonld-user.read_user.summary_org.summary_group.summary"}},"application/json":{"schema":{"$ref":"#/components/schemas/User-user.read_user.summary_org.summary_group.summary"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a User resource.","description":"Creates a User resource.","parameters":[],"requestBody":{"description":"The new User resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/User.UserInput"}},"application/json":{"schema":{"$ref":"#/components/schemas/User.UserInput"}}},"required":true}}},"/api/users/{id}":{"get":{"operationId":"api_users_id_get","tags":["User"],"responses":{"200":{"description":"User resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/User.jsonld-user.read_user.summary_org.summary_group.summary"}},"application/json":{"schema":{"$ref":"#/components/schemas/User-user.read_user.summary_org.summary_group.summary"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a User resource.","description":"Retrieves a User resource.","parameters":[{"name":"id","in":"path","description":"User identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_users_id_patch","tags":["User"],"responses":{"200":{"description":"User resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/User.jsonld-user.read_user.summary_org.summary_group.summary"}},"application/json":{"schema":{"$ref":"#/components/schemas/User-user.read_user.summary_org.summary_group.summary"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the User resource.","description":"Updates the User resource.","parameters":[{"name":"id","in":"path","description":"User identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated User resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/User.UserInput.jsonMergePatch"}}},"required":true}}},"/api/user_fields":{"get":{"operationId":"api_user_fields_get_collection","tags":["UserField"],"responses":{"200":{"description":"UserField collection","content":{"application/ld+json":{"schema":{"type":"object","description":"UserField.jsonld-people_field.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/UserField.jsonld-people_field.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserField-people_field.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of UserField resources.","description":"Retrieves the collection of UserField resources.","parameters":[]},"post":{"operationId":"api_user_fields_post","tags":["UserField"],"responses":{"201":{"description":"UserField resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/UserField.jsonld-people_field.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/UserField-people_field.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a UserField resource.","description":"Creates a UserField resource.","parameters":[],"requestBody":{"description":"The new UserField resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/UserField-people_field.write_people_field.create"}},"application/json":{"schema":{"$ref":"#/components/schemas/UserField-people_field.write_people_field.create"}}},"required":true}}},"/api/user_fields/{id}":{"get":{"operationId":"api_user_fields_id_get","tags":["UserField"],"responses":{"200":{"description":"UserField resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/UserField.jsonld-people_field.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/UserField-people_field.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a UserField resource.","description":"Retrieves a UserField resource.","parameters":[{"name":"id","in":"path","description":"UserField identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_user_fields_id_delete","tags":["UserField"],"responses":{"204":{"description":"UserField resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the UserField resource.","description":"Removes the UserField resource.","parameters":[{"name":"id","in":"path","description":"UserField identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_user_fields_id_patch","tags":["UserField"],"responses":{"200":{"description":"UserField resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/UserField.jsonld-people_field.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/UserField-people_field.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the UserField resource.","description":"Updates the UserField resource.","parameters":[{"name":"id","in":"path","description":"UserField identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated UserField resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UserField-people_field.write.jsonMergePatch"}}},"required":true}}},"/api/views":{"get":{"operationId":"api_views_get_collection","tags":["View"],"responses":{"200":{"description":"View collection","content":{"application/ld+json":{"schema":{"type":"object","description":"View.jsonld-rule.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/View.jsonld-rule.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/View-rule.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of View resources.","description":"Retrieves the collection of View resources.","parameters":[]},"post":{"operationId":"api_views_post","tags":["View"],"responses":{"201":{"description":"View resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/View.jsonld-rule.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/View-rule.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Creates a View resource.","description":"Creates a View resource.","parameters":[],"requestBody":{"description":"The new View resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/View-rule.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/View-rule.write"}}},"required":true}}},"/api/views/{id}":{"get":{"operationId":"api_views_id_get","tags":["View"],"responses":{"200":{"description":"View resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/View.jsonld-rule.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/View-rule.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a View resource.","description":"Retrieves a View resource.","parameters":[{"name":"id","in":"path","description":"View identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_views_id_delete","tags":["View"],"responses":{"204":{"description":"View resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the View resource.","description":"Removes the View resource.","parameters":[{"name":"id","in":"path","description":"View identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_views_id_patch","tags":["View"],"responses":{"200":{"description":"View resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/View.jsonld-rule.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/View-rule.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the View resource.","description":"Updates the View resource.","parameters":[{"name":"id","in":"path","description":"View identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated View resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/View-rule.write.jsonMergePatch"}}},"required":true}}},"/api/webhooks":{"get":{"operationId":"api_webhooks_get_collection","tags":["Webhook"],"responses":{"200":{"description":"Webhook collection","content":{"application/ld+json":{"schema":{"type":"object","description":"Webhook.jsonld-webhook.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/Webhook.jsonld-webhook.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Webhook-webhook.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of Webhook resources.","description":"Retrieves the collection of Webhook resources.","parameters":[]},"post":{"operationId":"api_webhooks_post","tags":["Webhook"],"responses":{"201":{"description":"Webhook resource created","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Webhook.jsonld-webhook.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/Webhook-webhook.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Create a webhook. A signing secret is generated; read it with GET /api/webhooks/{id}/signing_secret.","description":"Create a webhook. A signing secret is generated; read it with GET /api/webhooks/{id}/signing_secret.","parameters":[],"requestBody":{"description":"The new Webhook resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Webhook-webhook.write"}},"application/json":{"schema":{"$ref":"#/components/schemas/Webhook-webhook.write"}}},"required":true}}},"/api/webhooks/{id}":{"get":{"operationId":"api_webhooks_id_get","tags":["Webhook"],"responses":{"200":{"description":"Webhook resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Webhook.jsonld-webhook.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/Webhook-webhook.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a Webhook resource.","description":"Retrieves a Webhook resource.","parameters":[{"name":"id","in":"path","description":"Webhook identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"delete":{"operationId":"api_webhooks_id_delete","tags":["Webhook"],"responses":{"204":{"description":"Webhook resource deleted"},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Removes the Webhook resource.","description":"Removes the Webhook resource.","parameters":[{"name":"id","in":"path","description":"Webhook identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]},"patch":{"operationId":"api_webhooks_id_patch","tags":["Webhook"],"responses":{"200":{"description":"Webhook resource updated","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Webhook.jsonld-webhook.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/Webhook-webhook.read"}}},"links":{}},"400":{"description":"Invalid input","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"422":{"description":"An error occurred","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}},"application/json":{"schema":{"$ref":"#/components/schemas/ConstraintViolation"}}},"links":{}}},"summary":"Updates the Webhook resource.","description":"Updates the Webhook resource.","parameters":[{"name":"id","in":"path","description":"Webhook identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}],"requestBody":{"description":"The updated Webhook resource","content":{"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/Webhook-webhook.write.jsonMergePatch"}}},"required":true}}},"/api/webhook_deliveries":{"get":{"operationId":"api_webhook_deliveries_get_collection","tags":["WebhookDelivery"],"responses":{"200":{"description":"WebhookDelivery collection","content":{"application/ld+json":{"schema":{"type":"object","description":"WebhookDelivery.jsonld-webhook_delivery.read collection.","allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchema"},{"type":"object","required":["member"],"properties":{"member":{"type":"array","items":{"$ref":"#/components/schemas/WebhookDelivery.jsonld-webhook_delivery.read"}}}}]}},"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/WebhookDelivery-webhook_delivery.read"}}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves the collection of WebhookDelivery resources.","description":"Retrieves the collection of WebhookDelivery resources.","parameters":[{"name":"page","in":"query","description":"The collection page number","required":false,"deprecated":false,"schema":{"type":"integer","default":1},"style":"form","explode":true},{"name":"itemsPerPage","in":"query","description":"The number of items per page","required":false,"deprecated":false,"schema":{"type":"integer","default":25,"minimum":0,"maximum":100},"style":"form","explode":true},{"name":"webhook","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"webhook[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"status","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"status[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"event_type","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"event_type[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true},{"name":"ticket_id","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"string"},"style":"form","explode":false},{"name":"ticket_id[]","in":"query","description":"","required":false,"deprecated":false,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true}]}},"/api/webhook_deliveries/{id}":{"get":{"operationId":"api_webhook_deliveries_id_get","tags":["WebhookDelivery"],"responses":{"200":{"description":"WebhookDelivery resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/WebhookDelivery.jsonld-webhook_delivery.read"}},"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDelivery-webhook_delivery.read"}}}},"403":{"description":"Forbidden","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}},"404":{"description":"Not found","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/Error.jsonld"}},"application/problem+json":{"schema":{"$ref":"#/components/schemas/Error"}},"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}},"links":{}}},"summary":"Retrieves a WebhookDelivery resource.","description":"Retrieves a WebhookDelivery resource.","parameters":[{"name":"id","in":"path","description":"WebhookDelivery identifier","required":true,"deprecated":false,"schema":{"type":"string"},"style":"simple","explode":false}]}}},"components":{"schemas":{"ApiToken-api_token.read_api_token.created_user.summary":{"type":"object","description":"Personal API tokens for integrations. Send them as `Authorization: Bearer desk_…`. Agents see their own tokens; admins see everyone's.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"user":{"readOnly":true,"$ref":"#/components/schemas/User-api_token.read_api_token.created_user.summary"},"name":{"maxLength":100,"default":"","example":"CRM sync","type":"string"},"token_prefix":{"readOnly":true,"description":"First characters of the token, shown in lists so people can tell tokens apart.","default":"","example":"desk_3kF9","type":"string"},"scopes":{"minItems":1,"description":"`read` allows GET requests; `write` also allows POST/PATCH/PUT/DELETE.","default":["read"],"example":["read"],"type":"array","items":{"type":"string"}},"expires_at":{"description":"Null means the token never expires.","type":["string","null"],"format":"date-time"},"last_used_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"token":{"readOnly":true,"description":"The secret token. Shown once; store it safely.","example":"desk_3kF9xQ…","type":["string","null"]}},"required":["name"]},"ApiToken-api_token.read_user.summary":{"type":"object","description":"Personal API tokens for integrations. Send them as `Authorization: Bearer desk_…`. Agents see their own tokens; admins see everyone's.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"user":{"readOnly":true,"$ref":"#/components/schemas/User-api_token.read_user.summary"},"name":{"maxLength":100,"default":"","example":"CRM sync","type":"string"},"token_prefix":{"readOnly":true,"description":"First characters of the token, shown in lists so people can tell tokens apart.","default":"","example":"desk_3kF9","type":"string"},"scopes":{"minItems":1,"description":"`read` allows GET requests; `write` also allows POST/PATCH/PUT/DELETE.","default":["read"],"example":["read"],"type":"array","items":{"type":"string"}},"expires_at":{"description":"Null means the token never expires.","type":["string","null"],"format":"date-time"},"last_used_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"created_at":{"readOnly":true,"type":"string","format":"date-time"}},"required":["name"]},"ApiToken-api_token.write":{"type":"object","description":"Personal API tokens for integrations. Send them as `Authorization: Bearer desk_…`. Agents see their own tokens; admins see everyone's.","required":["name"],"properties":{"name":{"maxLength":100,"default":"","example":"CRM sync","type":"string"},"scopes":{"minItems":1,"description":"`read` allows GET requests; `write` also allows POST/PATCH/PUT/DELETE.","default":["read"],"example":["read"],"type":"array","items":{"type":"string"}},"expires_at":{"description":"Null means the token never expires.","type":["string","null"],"format":"date-time"}}},"ApiToken.jsonld-api_token.read_api_token.created_user.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"user":{"readOnly":true,"$ref":"#/components/schemas/User.jsonld-api_token.read_api_token.created_user.summary"},"name":{"maxLength":100,"default":"","example":"CRM sync","type":"string"},"token_prefix":{"readOnly":true,"description":"First characters of the token, shown in lists so people can tell tokens apart.","default":"","example":"desk_3kF9","type":"string"},"scopes":{"minItems":1,"description":"`read` allows GET requests; `write` also allows POST/PATCH/PUT/DELETE.","default":["read"],"example":["read"],"type":"array","items":{"type":"string"}},"expires_at":{"description":"Null means the token never expires.","type":["string","null"],"format":"date-time"},"last_used_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"token":{"readOnly":true,"description":"The secret token. Shown once; store it safely.","example":"desk_3kF9xQ…","type":["string","null"]}},"required":["name"]}],"description":"Personal API tokens for integrations. Send them as `Authorization: Bearer desk_…`. Agents see their own tokens; admins see everyone's."},"ApiToken.jsonld-api_token.read_user.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"user":{"readOnly":true,"$ref":"#/components/schemas/User.jsonld-api_token.read_user.summary"},"name":{"maxLength":100,"default":"","example":"CRM sync","type":"string"},"token_prefix":{"readOnly":true,"description":"First characters of the token, shown in lists so people can tell tokens apart.","default":"","example":"desk_3kF9","type":"string"},"scopes":{"minItems":1,"description":"`read` allows GET requests; `write` also allows POST/PATCH/PUT/DELETE.","default":["read"],"example":["read"],"type":"array","items":{"type":"string"}},"expires_at":{"description":"Null means the token never expires.","type":["string","null"],"format":"date-time"},"last_used_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"created_at":{"readOnly":true,"type":"string","format":"date-time"}},"required":["name"]}],"description":"Personal API tokens for integrations. Send them as `Authorization: Bearer desk_…`. Agents see their own tokens; admins see everyone's."},"AssignmentRule-rule.read_assignment_rule.read":{"type":"object","description":"Guided assignment rule (the Playlist replacement). For its agents it limits which tickets\nthey may receive (conditions: group, form, tags, priority…), which views they may play,\nhow many open tickets they may hold, and optionally auto-assigns new tickets that match\n(round-robin or least-loaded, only to agents who are online).\n\nAgents without any active rule are unrestricted (Zendesk default).","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"max_open_tickets":{"minimum":1,"maximum":10000,"description":"Capacity: open (new + open) tickets an agent may hold; null = unlimited.","type":["integer","null"]},"auto_assign":{"description":"Assign new, unassigned matching tickets automatically.","default":false,"type":"boolean"},"strategy":{"default":"round_robin","type":"string","enum":["round_robin","least_loaded"]},"only_online":{"description":"Auto-assign only to agents whose status is \"online\".","default":true,"type":"boolean"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"},"agent_ids":{"readOnly":true,"type":"array","items":{"type":"string"}},"view_ids":{"readOnly":true,"type":"array","items":{"type":"string"}}},"required":["title"]},"AssignmentRule-rule.write_assignment_rule.write":{"type":"object","description":"Guided assignment rule (the Playlist replacement). For its agents it limits which tickets\nthey may receive (conditions: group, form, tags, priority…), which views they may play,\nhow many open tickets they may hold, and optionally auto-assigns new tickets that match\n(round-robin or least-loaded, only to agents who are online).\n\nAgents without any active rule are unrestricted (Zendesk default).","properties":{"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"agents":{"type":"array","items":{"type":"string","format":"iri-reference","example":"https://example.com/"}},"views":{"description":"Views these agents may play; empty = every view they can see.","type":"array","items":{"$ref":"#/components/schemas/View-rule.write_assignment_rule.write"}},"max_open_tickets":{"minimum":1,"maximum":10000,"description":"Capacity: open (new + open) tickets an agent may hold; null = unlimited.","type":["integer","null"]},"auto_assign":{"description":"Assign new, unassigned matching tickets automatically.","default":false,"type":"boolean"},"strategy":{"default":"round_robin","type":"string","enum":["round_robin","least_loaded"]},"only_online":{"description":"Auto-assign only to agents whose status is \"online\".","default":true,"type":"boolean"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"}},"required":["title"]},"AssignmentRule-rule.write_assignment_rule.write.jsonMergePatch":{"type":"object","description":"Guided assignment rule (the Playlist replacement). For its agents it limits which tickets\nthey may receive (conditions: group, form, tags, priority…), which views they may play,\nhow many open tickets they may hold, and optionally auto-assigns new tickets that match\n(round-robin or least-loaded, only to agents who are online).\n\nAgents without any active rule are unrestricted (Zendesk default).","properties":{"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"agents":{"type":"array","items":{"type":"string","format":"iri-reference","example":"https://example.com/"}},"views":{"description":"Views these agents may play; empty = every view they can see.","type":"array","items":{"$ref":"#/components/schemas/View-rule.write_assignment_rule.write"}},"max_open_tickets":{"minimum":1,"maximum":10000,"description":"Capacity: open (new + open) tickets an agent may hold; null = unlimited.","type":["integer","null"]},"auto_assign":{"description":"Assign new, unassigned matching tickets automatically.","default":false,"type":"boolean"},"strategy":{"default":"round_robin","type":"string","enum":["round_robin","least_loaded"]},"only_online":{"description":"Auto-assign only to agents whose status is \"online\".","default":true,"type":"boolean"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"}}},"AssignmentRule.jsonld-rule.read_assignment_rule.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"max_open_tickets":{"minimum":1,"maximum":10000,"description":"Capacity: open (new + open) tickets an agent may hold; null = unlimited.","type":["integer","null"]},"auto_assign":{"description":"Assign new, unassigned matching tickets automatically.","default":false,"type":"boolean"},"strategy":{"default":"round_robin","type":"string","enum":["round_robin","least_loaded"]},"only_online":{"description":"Auto-assign only to agents whose status is \"online\".","default":true,"type":"boolean"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"},"agent_ids":{"readOnly":true,"type":"array","items":{"type":"string"}},"view_ids":{"readOnly":true,"type":"array","items":{"type":"string"}}},"required":["title"]}],"description":"Guided assignment rule (the Playlist replacement). For its agents it limits which tickets\nthey may receive (conditions: group, form, tags, priority…), which views they may play,\nhow many open tickets they may hold, and optionally auto-assigns new tickets that match\n(round-robin or least-loaded, only to agents who are online).\n\nAgents without any active rule are unrestricted (Zendesk default)."},"Attachment-attachment.read":{"type":"object","description":"A file stored privately in S3. Uploaded first (unattached, owned by the uploader), then\nlinked to a comment when the reply is submitted. Inbound email attachments are created attached.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"filename":{"type":"string"},"content_type":{"type":"string"},"size":{"type":"integer"},"inline":{"type":"boolean"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"download_url":{"readOnly":true,"description":"Transient: presigned URL filled by AttachmentUrlListener after load/persist.","type":["string","null"]}}},"Attachment-comment.read_user.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"filename":{"type":"string"},"content_type":{"type":"string"},"size":{"type":"integer"},"inline":{"type":"boolean"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"download_url":{"readOnly":true,"description":"Transient: presigned URL filled by AttachmentUrlListener after load/persist.","type":["string","null"]}}},"Attachment.jsonld-attachment.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"filename":{"type":"string"},"content_type":{"type":"string"},"size":{"type":"integer"},"inline":{"type":"boolean"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"download_url":{"readOnly":true,"description":"Transient: presigned URL filled by AttachmentUrlListener after load/persist.","type":["string","null"]}}}],"description":"A file stored privately in S3. Uploaded first (unattached, owned by the uploader), then\nlinked to a comment when the reply is submitted. Inbound email attachments are created attached."},"Attachment.jsonld-comment.read_user.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"filename":{"type":"string"},"content_type":{"type":"string"},"size":{"type":"integer"},"inline":{"type":"boolean"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"download_url":{"readOnly":true,"description":"Transient: presigned URL filled by AttachmentUrlListener after load/persist.","type":["string","null"]}}}],"description":"A file stored privately in S3. Uploaded first (unattached, owned by the uploader), then\nlinked to a comment when the reply is submitted. Inbound email attachments are created attached."},"AutoMergeRule-rule.read_auto_merge.read":{"type":"object","description":"Auto merge (the \"Auto Merge\" app): a new ticket that matches the conditions and has the same\nrequester and the same subject (or the same value in a reference field) as an unsolved ticket\ncreated within the last N minutes is merged into the oldest such ticket.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"match_on":{"minItems":1,"description":"\"subject\" and/or \"custom_fields.<key>\" (an external reference field); any match counts.","default":["subject"],"type":"array","items":{"type":"string"}},"window_minutes":{"minimum":1,"maximum":10080,"default":60,"type":"integer"},"public_comment":{"description":"Merge comments are public (the requester is told) or internal notes.","default":false,"type":"boolean"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"},"merge_as_id":{"readOnly":true,"type":["string","null"]}},"required":["title"]},"AutoMergeRule-rule.write_auto_merge.write":{"type":"object","description":"Auto merge (the \"Auto Merge\" app): a new ticket that matches the conditions and has the same\nrequester and the same subject (or the same value in a reference field) as an unsolved ticket\ncreated within the last N minutes is merged into the oldest such ticket.","properties":{"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"match_on":{"minItems":1,"description":"\"subject\" and/or \"custom_fields.<key>\" (an external reference field); any match counts.","default":["subject"],"type":"array","items":{"type":"string"}},"window_minutes":{"minimum":1,"maximum":10080,"default":60,"type":"integer"},"public_comment":{"description":"Merge comments are public (the requester is told) or internal notes.","default":false,"type":"boolean"},"merge_as":{"description":"The agent the merge is recorded as (Zendesk apps run as their installing admin); needs the merge permission.","type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"}},"required":["merge_as","title"]},"AutoMergeRule-rule.write_auto_merge.write.jsonMergePatch":{"type":"object","description":"Auto merge (the \"Auto Merge\" app): a new ticket that matches the conditions and has the same\nrequester and the same subject (or the same value in a reference field) as an unsolved ticket\ncreated within the last N minutes is merged into the oldest such ticket.","properties":{"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"match_on":{"minItems":1,"description":"\"subject\" and/or \"custom_fields.<key>\" (an external reference field); any match counts.","default":["subject"],"type":"array","items":{"type":"string"}},"window_minutes":{"minimum":1,"maximum":10080,"default":60,"type":"integer"},"public_comment":{"description":"Merge comments are public (the requester is told) or internal notes.","default":false,"type":"boolean"},"merge_as":{"description":"The agent the merge is recorded as (Zendesk apps run as their installing admin); needs the merge permission.","type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"}}},"AutoMergeRule.jsonld-rule.read_auto_merge.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"match_on":{"minItems":1,"description":"\"subject\" and/or \"custom_fields.<key>\" (an external reference field); any match counts.","default":["subject"],"type":"array","items":{"type":"string"}},"window_minutes":{"minimum":1,"maximum":10080,"default":60,"type":"integer"},"public_comment":{"description":"Merge comments are public (the requester is told) or internal notes.","default":false,"type":"boolean"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"},"merge_as_id":{"readOnly":true,"type":["string","null"]}},"required":["title"]}],"description":"Auto merge (the \"Auto Merge\" app): a new ticket that matches the conditions and has the same\nrequester and the same subject (or the same value in a reference field) as an unsolved ticket\ncreated within the last N minutes is merged into the oldest such ticket."},"Automation-rule.read":{"type":"object","description":"Time-based rule: evaluated hourly against tickets matching its conditions (at most once per ticket per update).","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"actions":{"type":"array","items":{"type":"object","additionalProperties":{}}},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"}},"required":["title"]},"Automation-rule.write":{"type":"object","description":"Time-based rule: evaluated hourly against tickets matching its conditions (at most once per ticket per update).","properties":{"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"actions":{"type":"array","items":{"type":"object","additionalProperties":{}}},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"}},"required":["title"]},"Automation-rule.write.jsonMergePatch":{"type":"object","description":"Time-based rule: evaluated hourly against tickets matching its conditions (at most once per ticket per update).","properties":{"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"actions":{"type":"array","items":{"type":"object","additionalProperties":{}}},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"}}},"Automation.jsonld-rule.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"actions":{"type":"array","items":{"type":"object","additionalProperties":{}}},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"}},"required":["title"]}],"description":"Time-based rule: evaluated hourly against tickets matching its conditions (at most once per ticket per update)."},"Brand-address.read_brand.read_group.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"},"subdomain":{"pattern":"^([a-z0-9][a-z0-9-]{0,62})$","type":"string"},"slug":{"pattern":"^(((?!^(articles|sections|categories|search|requests|signin|auth|brand|bff|rate|community|contributions|subscriptions)$).)*)$","description":"The brand's path in a unified help centre: /hc/{locale}/{slug}/… (e.g. /hc/en/enterprise/articles/…).","type":"string"},"help_center_host":{"maxLength":253,"pattern":"^(.*(^(?=.{1,253}(:|$))(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)(?::[0-9]{1,5})?$).*)$","description":"Zendesk \"host mapping\": the brand's own help-centre domain (e.g. help.example.com). Without one the\nhelp centre lives at {subdomain}.{HC_BASE_DOMAIN} (see App\\HelpCenter\\HelpCenterHosts).","type":["string","null"]},"is_default":{"default":false,"type":"boolean"},"active":{"default":true,"type":"boolean"},"signature_template":{"description":"Twig (sandboxed) appended to outbound agent replies.","type":["string","null"]},"personalized_replies":{"description":"Zendesk \"personalized email replies\": the From name carries the replying agent's name.","default":true,"type":"boolean"},"from_name_format":{"enum":["agent_address","agent_via_brand"],"description":"agent_address = \"Ana Silva (Acme Support)\" (Zendesk), agent_via_brand = \"Ana Silva via Acme\".","default":"agent_address","type":"string"},"email_template":{"enum":["modern","plain"],"description":"modern | plain (Zendesk `modern_email_template`).","default":"modern","type":"string"},"email_accent_color":{"pattern":"^(#[0-9a-fA-F]{6})$","type":["string","null"]},"email_footer":{"maxLength":1000,"description":"Plain text shown at the bottom of every email of this brand (address, legal line…).","type":["string","null"]}},"required":["name","slug"]},"Brand-brand.read":{"type":"object","description":"Minimal brand (see docs/architecture.md §17 Q2): help-centre identity + support addresses.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"},"subdomain":{"pattern":"^([a-z0-9][a-z0-9-]{0,62})$","type":"string"},"slug":{"pattern":"^(((?!^(articles|sections|categories|search|requests|signin|auth|brand|bff|rate|community|contributions|subscriptions)$).)*)$","description":"The brand's path in a unified help centre: /hc/{locale}/{slug}/… (e.g. /hc/en/enterprise/articles/…).","type":"string"},"help_center_host":{"maxLength":253,"pattern":"^(.*(^(?=.{1,253}(:|$))(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)(?::[0-9]{1,5})?$).*)$","description":"Zendesk \"host mapping\": the brand's own help-centre domain (e.g. help.example.com). Without one the\nhelp centre lives at {subdomain}.{HC_BASE_DOMAIN} (see App\\HelpCenter\\HelpCenterHosts).","type":["string","null"]},"is_default":{"default":false,"type":"boolean"},"active":{"default":true,"type":"boolean"},"signature_template":{"description":"Twig (sandboxed) appended to outbound agent replies.","type":["string","null"]},"personalized_replies":{"description":"Zendesk \"personalized email replies\": the From name carries the replying agent's name.","default":true,"type":"boolean"},"from_name_format":{"enum":["agent_address","agent_via_brand"],"description":"agent_address = \"Ana Silva (Acme Support)\" (Zendesk), agent_via_brand = \"Ana Silva via Acme\".","default":"agent_address","type":"string"},"email_template":{"enum":["modern","plain"],"description":"modern | plain (Zendesk `modern_email_template`).","default":"modern","type":"string"},"email_accent_color":{"pattern":"^(#[0-9a-fA-F]{6})$","type":["string","null"]},"email_footer":{"maxLength":1000,"description":"Plain text shown at the bottom of every email of this brand (address, legal line…).","type":["string","null"]}},"required":["name","slug"]},"Brand-brand.write":{"type":"object","description":"Minimal brand (see docs/architecture.md §17 Q2): help-centre identity + support addresses.","required":["name","slug"],"properties":{"name":{"type":"string"},"subdomain":{"pattern":"^([a-z0-9][a-z0-9-]{0,62})$","type":"string"},"slug":{"pattern":"^(((?!^(articles|sections|categories|search|requests|signin|auth|brand|bff|rate|community|contributions|subscriptions)$).)*)$","description":"The brand's path in a unified help centre: /hc/{locale}/{slug}/… (e.g. /hc/en/enterprise/articles/…).","type":"string"},"help_center_host":{"maxLength":253,"pattern":"^(.*(^(?=.{1,253}(:|$))(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)(?::[0-9]{1,5})?$).*)$","description":"Zendesk \"host mapping\": the brand's own help-centre domain (e.g. help.example.com). Without one the\nhelp centre lives at {subdomain}.{HC_BASE_DOMAIN} (see App\\HelpCenter\\HelpCenterHosts).","type":["string","null"]},"is_default":{"default":false,"type":"boolean"},"active":{"default":true,"type":"boolean"},"signature_template":{"description":"Twig (sandboxed) appended to outbound agent replies.","type":["string","null"]},"personalized_replies":{"description":"Zendesk \"personalized email replies\": the From name carries the replying agent's name.","default":true,"type":"boolean"},"from_name_format":{"enum":["agent_address","agent_via_brand"],"description":"agent_address = \"Ana Silva (Acme Support)\" (Zendesk), agent_via_brand = \"Ana Silva via Acme\".","default":"agent_address","type":"string"},"email_template":{"enum":["modern","plain"],"description":"modern | plain (Zendesk `modern_email_template`).","default":"modern","type":"string"},"email_accent_color":{"pattern":"^(#[0-9a-fA-F]{6})$","type":["string","null"]},"email_footer":{"maxLength":1000,"description":"Plain text shown at the bottom of every email of this brand (address, legal line…).","type":["string","null"]}}},"Brand-brand.write.jsonMergePatch":{"type":"object","description":"Minimal brand (see docs/architecture.md §17 Q2): help-centre identity + support addresses.","properties":{"name":{"type":"string"},"subdomain":{"pattern":"^([a-z0-9][a-z0-9-]{0,62})$","type":"string"},"slug":{"pattern":"^(((?!^(articles|sections|categories|search|requests|signin|auth|brand|bff|rate|community|contributions|subscriptions)$).)*)$","description":"The brand's path in a unified help centre: /hc/{locale}/{slug}/… (e.g. /hc/en/enterprise/articles/…).","type":"string"},"help_center_host":{"maxLength":253,"pattern":"^(.*(^(?=.{1,253}(:|$))(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)(?::[0-9]{1,5})?$).*)$","description":"Zendesk \"host mapping\": the brand's own help-centre domain (e.g. help.example.com). Without one the\nhelp centre lives at {subdomain}.{HC_BASE_DOMAIN} (see App\\HelpCenter\\HelpCenterHosts).","type":["string","null"]},"is_default":{"default":false,"type":"boolean"},"active":{"default":true,"type":"boolean"},"signature_template":{"description":"Twig (sandboxed) appended to outbound agent replies.","type":["string","null"]},"personalized_replies":{"description":"Zendesk \"personalized email replies\": the From name carries the replying agent's name.","default":true,"type":"boolean"},"from_name_format":{"enum":["agent_address","agent_via_brand"],"description":"agent_address = \"Ana Silva (Acme Support)\" (Zendesk), agent_via_brand = \"Ana Silva via Acme\".","default":"agent_address","type":"string"},"email_template":{"enum":["modern","plain"],"description":"modern | plain (Zendesk `modern_email_template`).","default":"modern","type":"string"},"email_accent_color":{"pattern":"^(#[0-9a-fA-F]{6})$","type":["string","null"]},"email_footer":{"maxLength":1000,"description":"Plain text shown at the bottom of every email of this brand (address, legal line…).","type":["string","null"]}}},"Brand-ticket.read_user.summary_group.summary_org.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["name"]},"Brand.jsonld-address.read_brand.read_group.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"},"subdomain":{"pattern":"^([a-z0-9][a-z0-9-]{0,62})$","type":"string"},"slug":{"pattern":"^(((?!^(articles|sections|categories|search|requests|signin|auth|brand|bff|rate|community|contributions|subscriptions)$).)*)$","description":"The brand's path in a unified help centre: /hc/{locale}/{slug}/… (e.g. /hc/en/enterprise/articles/…).","type":"string"},"help_center_host":{"maxLength":253,"pattern":"^(.*(^(?=.{1,253}(:|$))(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)(?::[0-9]{1,5})?$).*)$","description":"Zendesk \"host mapping\": the brand's own help-centre domain (e.g. help.example.com). Without one the\nhelp centre lives at {subdomain}.{HC_BASE_DOMAIN} (see App\\HelpCenter\\HelpCenterHosts).","type":["string","null"]},"is_default":{"default":false,"type":"boolean"},"active":{"default":true,"type":"boolean"},"signature_template":{"description":"Twig (sandboxed) appended to outbound agent replies.","type":["string","null"]},"personalized_replies":{"description":"Zendesk \"personalized email replies\": the From name carries the replying agent's name.","default":true,"type":"boolean"},"from_name_format":{"enum":["agent_address","agent_via_brand"],"description":"agent_address = \"Ana Silva (Acme Support)\" (Zendesk), agent_via_brand = \"Ana Silva via Acme\".","default":"agent_address","type":"string"},"email_template":{"enum":["modern","plain"],"description":"modern | plain (Zendesk `modern_email_template`).","default":"modern","type":"string"},"email_accent_color":{"pattern":"^(#[0-9a-fA-F]{6})$","type":["string","null"]},"email_footer":{"maxLength":1000,"description":"Plain text shown at the bottom of every email of this brand (address, legal line…).","type":["string","null"]}},"required":["name","slug"]}],"description":"Minimal brand (see docs/architecture.md §17 Q2): help-centre identity + support addresses."},"Brand.jsonld-brand.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"},"subdomain":{"pattern":"^([a-z0-9][a-z0-9-]{0,62})$","type":"string"},"slug":{"pattern":"^(((?!^(articles|sections|categories|search|requests|signin|auth|brand|bff|rate|community|contributions|subscriptions)$).)*)$","description":"The brand's path in a unified help centre: /hc/{locale}/{slug}/… (e.g. /hc/en/enterprise/articles/…).","type":"string"},"help_center_host":{"maxLength":253,"pattern":"^(.*(^(?=.{1,253}(:|$))(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)(?::[0-9]{1,5})?$).*)$","description":"Zendesk \"host mapping\": the brand's own help-centre domain (e.g. help.example.com). Without one the\nhelp centre lives at {subdomain}.{HC_BASE_DOMAIN} (see App\\HelpCenter\\HelpCenterHosts).","type":["string","null"]},"is_default":{"default":false,"type":"boolean"},"active":{"default":true,"type":"boolean"},"signature_template":{"description":"Twig (sandboxed) appended to outbound agent replies.","type":["string","null"]},"personalized_replies":{"description":"Zendesk \"personalized email replies\": the From name carries the replying agent's name.","default":true,"type":"boolean"},"from_name_format":{"enum":["agent_address","agent_via_brand"],"description":"agent_address = \"Ana Silva (Acme Support)\" (Zendesk), agent_via_brand = \"Ana Silva via Acme\".","default":"agent_address","type":"string"},"email_template":{"enum":["modern","plain"],"description":"modern | plain (Zendesk `modern_email_template`).","default":"modern","type":"string"},"email_accent_color":{"pattern":"^(#[0-9a-fA-F]{6})$","type":["string","null"]},"email_footer":{"maxLength":1000,"description":"Plain text shown at the bottom of every email of this brand (address, legal line…).","type":["string","null"]}},"required":["name","slug"]}],"description":"Minimal brand (see docs/architecture.md §17 Q2): help-centre identity + support addresses."},"Brand.jsonld-ticket.read_user.summary_group.summary_org.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["name"]}],"description":"Minimal brand (see docs/architecture.md §17 Q2): help-centre identity + support addresses."},"BusinessSchedule-rule.read_sla_policy.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":150,"type":"string"}},"required":["name"]},"BusinessSchedule-schedule.read":{"type":"object","description":"Business hours for SLA targets: weekly opening intervals in a timezone, plus holidays.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":150,"type":"string"},"timezone":{"default":"Africa/Johannesburg","type":"string"},"intervals":{"description":"weekday (mon…sun) => [\"07:00-19:00\", …] in local time","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"default":{"description":"Used by policies without an explicit schedule.","default":false,"type":"boolean"},"holidays":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/Holiday-schedule.read"}},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"}},"required":["name","timezone"]},"BusinessSchedule-schedule.write":{"type":"object","description":"Business hours for SLA targets: weekly opening intervals in a timezone, plus holidays.","required":["name","timezone"],"properties":{"name":{"maxLength":150,"type":"string"},"timezone":{"default":"Africa/Johannesburg","type":"string"},"intervals":{"description":"weekday (mon…sun) => [\"07:00-19:00\", …] in local time","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"default":{"description":"Used by policies without an explicit schedule.","default":false,"type":"boolean"}}},"BusinessSchedule-schedule.write.jsonMergePatch":{"type":"object","description":"Business hours for SLA targets: weekly opening intervals in a timezone, plus holidays.","properties":{"name":{"maxLength":150,"type":"string"},"timezone":{"default":"Africa/Johannesburg","type":"string"},"intervals":{"description":"weekday (mon…sun) => [\"07:00-19:00\", …] in local time","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"default":{"description":"Used by policies without an explicit schedule.","default":false,"type":"boolean"}}},"BusinessSchedule.jsonld-rule.read_sla_policy.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":150,"type":"string"}},"required":["name"]}],"description":"Business hours for SLA targets: weekly opening intervals in a timezone, plus holidays."},"BusinessSchedule.jsonld-schedule.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":150,"type":"string"},"timezone":{"default":"Africa/Johannesburg","type":"string"},"intervals":{"description":"weekday (mon…sun) => [\"07:00-19:00\", …] in local time","type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}},"default":{"description":"Used by policies without an explicit schedule.","default":false,"type":"boolean"},"holidays":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/Holiday.jsonld-schedule.read"}},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"}},"required":["name","timezone"]}],"description":"Business hours for SLA targets: weekly opening intervals in a timezone, plus holidays."},"CommentInput":{"type":"object","properties":{"body":{"maxLength":500000,"description":"HTML (sanitized server-side).","default":"","type":"string"},"public":{"default":true,"type":"boolean"},"attachment_ids":{"maxItems":25,"description":"ids from POST /api/uploads","type":"array","items":{"type":"string"}}}},"ConstraintViolation":{"type":"object","description":"Unprocessable entity","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"},"code":{"type":"string","description":"The code of the violation"},"hint":{"type":"string","description":"An extra hint to understand the violation"},"payload":{"type":"object","additionalProperties":true,"description":"The serialized payload of the violation"}},"required":["propertyPath","message"]}},"detail":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}},"ConstraintViolation.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"status":{"default":422,"type":"integer"},"violations":{"type":"array","items":{"type":"object","properties":{"propertyPath":{"type":"string","description":"The property path of the violation"},"message":{"type":"string","description":"The message associated with the violation"},"code":{"type":"string","description":"The code of the violation"},"hint":{"type":"string","description":"An extra hint to understand the violation"},"payload":{"type":"object","additionalProperties":true,"description":"The serialized payload of the violation"}},"required":["propertyPath","message"]}},"detail":{"readOnly":true,"type":"string"},"description":{"readOnly":true,"type":"string"},"type":{"readOnly":true,"type":"string"},"title":{"readOnly":true,"type":["string","null"]},"instance":{"readOnly":true,"type":["string","null"]}}}],"description":"Unprocessable entity"},"ContextualWorkspace-rule.read_workspace.read":{"type":"object","description":"Contextual workspace (Zendesk admin.workspaces): the first active workspace (by position)\nwhose conditions match a ticket decides which shared macros, which ticket form layout and\nwhich sidebar apps the agent sees on it (e.g. one workspace for billing, one for technical support).","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"apps":{"description":"Sidebar app keys shown in this workspace (empty = all installed apps).","type":"array","items":{"type":"string"}},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"},"macro_ids":{"readOnly":true,"type":"array","items":{"type":"string"}},"ticket_form_id":{"readOnly":true,"type":["string","null"]}},"required":["title"]},"ContextualWorkspace-rule.write_workspace.write":{"type":"object","description":"Contextual workspace (Zendesk admin.workspaces): the first active workspace (by position)\nwhose conditions match a ticket decides which shared macros, which ticket form layout and\nwhich sidebar apps the agent sees on it (e.g. one workspace for billing, one for technical support).","properties":{"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"macros":{"description":"Shared macros offered in this workspace (personal macros always show).","type":"array","items":{"$ref":"#/components/schemas/Macro-rule.write_workspace.write"}},"ticket_form":{"description":"Ticket form whose field layout the workspace shows; null = the ticket's own form.","type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"apps":{"description":"Sidebar app keys shown in this workspace (empty = all installed apps).","type":"array","items":{"type":"string"}},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"}},"required":["title"]},"ContextualWorkspace-rule.write_workspace.write.jsonMergePatch":{"type":"object","description":"Contextual workspace (Zendesk admin.workspaces): the first active workspace (by position)\nwhose conditions match a ticket decides which shared macros, which ticket form layout and\nwhich sidebar apps the agent sees on it (e.g. one workspace for billing, one for technical support).","properties":{"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"macros":{"description":"Shared macros offered in this workspace (personal macros always show).","type":"array","items":{"$ref":"#/components/schemas/Macro-rule.write_workspace.write"}},"ticket_form":{"description":"Ticket form whose field layout the workspace shows; null = the ticket's own form.","type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"apps":{"description":"Sidebar app keys shown in this workspace (empty = all installed apps).","type":"array","items":{"type":"string"}},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"}}},"ContextualWorkspace.jsonld-rule.read_workspace.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"apps":{"description":"Sidebar app keys shown in this workspace (empty = all installed apps).","type":"array","items":{"type":"string"}},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"},"macro_ids":{"readOnly":true,"type":"array","items":{"type":"string"}},"ticket_form_id":{"readOnly":true,"type":["string","null"]}},"required":["title"]}],"description":"Contextual workspace (Zendesk admin.workspaces): the first active workspace (by position)\nwhose conditions match a ticket decides which shared macros, which ticket form layout and\nwhich sidebar apps the agent sees on it (e.g. one workspace for billing, one for technical support)."},"CsatReason-csat_reason.read":{"type":"object","description":"Admin-configured CSAT reason (Zendesk csat_reason_code), offered on the rating page when the\nrequester rates bad. Inactive reasons stay on old ratings but can't be picked any more.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"code":{"pattern":"^([a-z0-9][a-z0-9_]{0,63})$","type":"string"},"title":{"maxLength":255,"type":"string"},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"}},"required":["code","title"]},"CsatReason-csat_reason.write":{"type":"object","description":"Admin-configured CSAT reason (Zendesk csat_reason_code), offered on the rating page when the\nrequester rates bad. Inactive reasons stay on old ratings but can't be picked any more.","required":["code","title"],"properties":{"code":{"pattern":"^([a-z0-9][a-z0-9_]{0,63})$","type":"string"},"title":{"maxLength":255,"type":"string"},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"}}},"CsatReason-csat_reason.write.jsonMergePatch":{"type":"object","description":"Admin-configured CSAT reason (Zendesk csat_reason_code), offered on the rating page when the\nrequester rates bad. Inactive reasons stay on old ratings but can't be picked any more.","properties":{"code":{"pattern":"^([a-z0-9][a-z0-9_]{0,63})$","type":"string"},"title":{"maxLength":255,"type":"string"},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"}}},"CsatReason.jsonld-csat_reason.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"code":{"pattern":"^([a-z0-9][a-z0-9_]{0,63})$","type":"string"},"title":{"maxLength":255,"type":"string"},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"}},"required":["code","title"]}],"description":"Admin-configured CSAT reason (Zendesk csat_reason_code), offered on the rating page when the\nrequester rates bad. Inactive reasons stay on old ratings but can't be picked any more."},"CustomAgentStatus-custom_agent_status.read":{"type":"object","description":"Admin-defined agent status (Zendesk custom agent statuses), e.g. \"Lunch\" or \"Training\" on top of\nAway, \"Phones only\" on top of Online. Routing and chat only look at the base status; the name tells\nthe team what the agent is doing. Agents pick active ones in the top bar. Deleting one puts its\nagents back on the plain base status.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":64,"type":"string"},"description":{"maxLength":255,"type":["string","null"]},"base_status":{"description":"What routing sees: only Online agents receive chats and auto-assigned tickets.","type":"string","enum":["online","away","offline"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"}},"required":["name"]},"CustomAgentStatus-custom_agent_status.write":{"type":"object","description":"Admin-defined agent status (Zendesk custom agent statuses), e.g. \"Lunch\" or \"Training\" on top of\nAway, \"Phones only\" on top of Online. Routing and chat only look at the base status; the name tells\nthe team what the agent is doing. Agents pick active ones in the top bar. Deleting one puts its\nagents back on the plain base status.","required":["name"],"properties":{"name":{"maxLength":64,"type":"string"},"description":{"maxLength":255,"type":["string","null"]},"base_status":{"description":"What routing sees: only Online agents receive chats and auto-assigned tickets.","type":"string","enum":["online","away","offline"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"}}},"CustomAgentStatus-custom_agent_status.write.jsonMergePatch":{"type":"object","description":"Admin-defined agent status (Zendesk custom agent statuses), e.g. \"Lunch\" or \"Training\" on top of\nAway, \"Phones only\" on top of Online. Routing and chat only look at the base status; the name tells\nthe team what the agent is doing. Agents pick active ones in the top bar. Deleting one puts its\nagents back on the plain base status.","properties":{"name":{"maxLength":64,"type":"string"},"description":{"maxLength":255,"type":["string","null"]},"base_status":{"description":"What routing sees: only Online agents receive chats and auto-assigned tickets.","type":"string","enum":["online","away","offline"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"}}},"CustomAgentStatus.jsonld-custom_agent_status.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":64,"type":"string"},"description":{"maxLength":255,"type":["string","null"]},"base_status":{"description":"What routing sees: only Online agents receive chats and auto-assigned tickets.","type":"string","enum":["online","away","offline"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"}},"required":["name"]}],"description":"Admin-defined agent status (Zendesk custom agent statuses), e.g. \"Lunch\" or \"Training\" on top of\nAway, \"Phones only\" on top of Online. Routing and chat only look at the base status; the name tells\nthe team what the agent is doing. Agents pick active ones in the top bar. Deleting one puts its\nagents back on the plain base status."},"CustomFieldInput":{"type":"object","required":["id"],"properties":{"id":{"format":"uuid","externalDocs":{"url":"https://schema.org/identifier"},"default":"","type":"string"},"value":{}}},"CustomerContext":{"type":"object","description":"The ticket \"Customer\" panel for an end user: profile, tags, attributes, lists and alerts from the customer data connector (or demo data). `?refresh=1` skips the cache.","properties":{"id":{"type":"string"},"available":{"type":"boolean"},"source":{"type":"string"},"label":{"type":["string","null"]},"fetched_at":{"type":"string","format":"date-time"},"profile":{"type":["object","null"],"additionalProperties":{}},"tags":{"type":"array","items":{"type":"string"}},"attributes":{"type":"array","items":{"type":"object","additionalProperties":{}}},"lists":{"type":"array","items":{"type":"object","additionalProperties":{}}},"alerts":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"unavailable_reason":{"type":["string","null"]},"error":{"type":["string","null"]}}},"CustomerContext.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":"string"},"available":{"type":"boolean"},"source":{"type":"string"},"label":{"type":["string","null"]},"fetched_at":{"type":"string","format":"date-time"},"profile":{"type":["object","null"],"additionalProperties":{}},"tags":{"type":"array","items":{"type":"string"}},"attributes":{"type":"array","items":{"type":"object","additionalProperties":{}}},"lists":{"type":"array","items":{"type":"object","additionalProperties":{}}},"alerts":{"type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"unavailable_reason":{"type":["string","null"]},"error":{"type":["string","null"]}}}],"description":"The ticket \"Customer\" panel for an end user: profile, tags, attributes, lists and alerts from the customer data connector (or demo data). `?refresh=1` skips the cache."},"DynamicContentItem-dc.read":{"type":"object","description":"Zendesk dynamic content: `{{dc.name}}` in notification templates, macros and triggers renders the\nvariant for the requester's locale, falling back to the language (\"pt\" for \"pt-BR\"), then to the\ndefault locale. Variants are stored as {locale: text}.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"pattern":"^([a-z0-9_]+)$","description":"Placeholder key: `{{dc.<name>}}`.","type":"string"},"default_locale":{"default":"en","type":"string"},"variants":{"minItems":1,"description":"locale → text","type":"object","additionalProperties":{"type":"string"}},"updated_at":{"readOnly":true,"type":"string","format":"date-time"}},"required":["name","default_locale"]},"DynamicContentItem-dc.write":{"type":"object","description":"Zendesk dynamic content: `{{dc.name}}` in notification templates, macros and triggers renders the\nvariant for the requester's locale, falling back to the language (\"pt\" for \"pt-BR\"), then to the\ndefault locale. Variants are stored as {locale: text}.","required":["name","default_locale"],"properties":{"name":{"pattern":"^([a-z0-9_]+)$","description":"Placeholder key: `{{dc.<name>}}`.","type":"string"},"default_locale":{"default":"en","type":"string"},"variants":{"minItems":1,"description":"locale → text","type":"object","additionalProperties":{"type":"string"}}}},"DynamicContentItem-dc.write.jsonMergePatch":{"type":"object","description":"Zendesk dynamic content: `{{dc.name}}` in notification templates, macros and triggers renders the\nvariant for the requester's locale, falling back to the language (\"pt\" for \"pt-BR\"), then to the\ndefault locale. Variants are stored as {locale: text}.","properties":{"name":{"pattern":"^([a-z0-9_]+)$","description":"Placeholder key: `{{dc.<name>}}`.","type":"string"},"default_locale":{"default":"en","type":"string"},"variants":{"minItems":1,"description":"locale → text","type":"object","additionalProperties":{"type":"string"}}}},"DynamicContentItem.jsonld-dc.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"pattern":"^([a-z0-9_]+)$","description":"Placeholder key: `{{dc.<name>}}`.","type":"string"},"default_locale":{"default":"en","type":"string"},"variants":{"minItems":1,"description":"locale → text","type":"object","additionalProperties":{"type":"string"}},"updated_at":{"readOnly":true,"type":"string","format":"date-time"}},"required":["name","default_locale"]}],"description":"Zendesk dynamic content: `{{dc.name}}` in notification templates, macros and triggers renders the\nvariant for the requester's locale, falling back to the language (\"pt\" for \"pt-BR\"), then to the\ndefault locale. Variants are stored as {locale: text}."},"EmailTemplate":{"type":"object","description":"Notification templates: built-in defaults with optional admin overrides (sandboxed Twig).","properties":{"key":{"readOnly":true,"default":"","type":"string"},"name":{"readOnly":true,"default":"","type":"string"},"audience":{"readOnly":true,"default":"","type":"string"},"description":{"readOnly":true,"default":"","type":"string"},"subject":{"maxLength":500,"default":"","type":"string"},"body":{"maxLength":100000,"default":"","type":"string"},"customized":{"readOnly":true,"default":false,"type":"boolean"},"preview_ticket_number":{"description":"Preview only: ticket number to render against (defaults to the latest ticket).","type":["integer","null"]},"rendered_subject":{"readOnly":true,"description":"Preview output.","type":["string","null"]},"rendered_html":{"readOnly":true,"type":["string","null"]}},"required":["subject","body"]},"EmailTemplate.jsonMergePatch":{"type":"object","description":"Notification templates: built-in defaults with optional admin overrides (sandboxed Twig).","properties":{"key":{"readOnly":true,"default":"","type":"string"},"name":{"readOnly":true,"default":"","type":"string"},"audience":{"readOnly":true,"default":"","type":"string"},"description":{"readOnly":true,"default":"","type":"string"},"subject":{"maxLength":500,"default":"","type":"string"},"body":{"maxLength":100000,"default":"","type":"string"},"customized":{"readOnly":true,"default":false,"type":"boolean"},"preview_ticket_number":{"description":"Preview only: ticket number to render against (defaults to the latest ticket).","type":["integer","null"]},"rendered_subject":{"readOnly":true,"description":"Preview output.","type":["string","null"]},"rendered_html":{"readOnly":true,"type":["string","null"]}}},"EmailTemplate.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"key":{"readOnly":true,"default":"","type":"string"},"name":{"readOnly":true,"default":"","type":"string"},"audience":{"readOnly":true,"default":"","type":"string"},"description":{"readOnly":true,"default":"","type":"string"},"subject":{"maxLength":500,"default":"","type":"string"},"body":{"maxLength":100000,"default":"","type":"string"},"customized":{"readOnly":true,"default":false,"type":"boolean"},"preview_ticket_number":{"description":"Preview only: ticket number to render against (defaults to the latest ticket).","type":["integer","null"]},"rendered_subject":{"readOnly":true,"description":"Preview output.","type":["string","null"]},"rendered_html":{"readOnly":true,"type":["string","null"]}},"required":["subject","body"]}],"description":"Notification templates: built-in defaults with optional admin overrides (sandboxed Twig)."},"Error":{"type":"object","description":"A representation of common errors.","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":["integer","null"],"examples":[404],"default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"}}},"Error.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"title":{"readOnly":true,"description":"A short, human-readable summary of the problem.","type":["string","null"]},"detail":{"readOnly":true,"description":"A human-readable explanation specific to this occurrence of the problem.","type":["string","null"]},"status":{"type":["integer","null"],"examples":[404],"default":400},"instance":{"readOnly":true,"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":["string","null"]},"type":{"readOnly":true,"description":"A URI reference that identifies the problem type","type":"string"},"description":{"readOnly":true,"type":["string","null"]}}}],"description":"A representation of common errors."},"Group-address.read_brand.read_group.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":150,"type":"string"}},"required":["name"]},"Group-group.read_group.summary_user.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":150,"type":"string"},"description":{"type":["string","null"]},"is_default":{"default":false,"type":"boolean"},"is_private":{"description":"Private group (Zendesk): its tickets are visible only to members, admins included.","default":false,"type":"boolean"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"members":{"type":"array","items":{"$ref":"#/components/schemas/User-group.read_group.summary_user.summary"}}},"required":["name"]},"Group-group.write":{"type":"object","required":["name"],"properties":{"name":{"maxLength":150,"type":"string"},"description":{"type":["string","null"]},"is_default":{"default":false,"type":"boolean"},"is_private":{"description":"Private group (Zendesk): its tickets are visible only to members, admins included.","default":false,"type":"boolean"},"members":{"type":"array","items":{"type":"string","format":"iri-reference","example":"https://example.com/"}}}},"Group-group.write.jsonMergePatch":{"type":"object","properties":{"name":{"maxLength":150,"type":"string"},"description":{"type":["string","null"]},"is_default":{"default":false,"type":"boolean"},"is_private":{"description":"Private group (Zendesk): its tickets are visible only to members, admins included.","default":false,"type":"boolean"},"members":{"type":"array","items":{"type":"string","format":"iri-reference","example":"https://example.com/"}}}},"Group-org.read_org.summary_group.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":150,"type":"string"}},"required":["name"]},"Group-ticket.read_user.summary_group.summary_org.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":150,"type":"string"}},"required":["name"]},"Group-user.read_user.summary_org.summary_group.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":150,"type":"string"}},"required":["name"]},"Group.jsonld-address.read_brand.read_group.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":150,"type":"string"}},"required":["name"]}]},"Group.jsonld-group.read_group.summary_user.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":150,"type":"string"},"description":{"type":["string","null"]},"is_default":{"default":false,"type":"boolean"},"is_private":{"description":"Private group (Zendesk): its tickets are visible only to members, admins included.","default":false,"type":"boolean"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"members":{"type":"array","items":{"$ref":"#/components/schemas/User.jsonld-group.read_group.summary_user.summary"}}},"required":["name"]}]},"Group.jsonld-org.read_org.summary_group.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":150,"type":"string"}},"required":["name"]}]},"Group.jsonld-ticket.read_user.summary_group.summary_org.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":150,"type":"string"}},"required":["name"]}]},"Group.jsonld-user.read_user.summary_org.summary_group.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":150,"type":"string"}},"required":["name"]}]},"Holiday-holiday.read":{"type":"object","description":"A closed day of a business schedule; recurring holidays repeat every year on the same date.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"schedule":{"type":"string","format":"iri-reference","example":"https://example.com/"},"name":{"maxLength":150,"type":"string"},"date":{"type":"string","format":"date-time"},"recurring":{"default":false,"type":"boolean"}},"required":["name"]},"Holiday-holiday.write":{"type":"object","description":"A closed day of a business schedule; recurring holidays repeat every year on the same date.","properties":{"schedule":{"type":"string","format":"iri-reference","example":"https://example.com/"},"name":{"maxLength":150,"type":"string"},"date":{"type":"string","format":"date-time"},"recurring":{"default":false,"type":"boolean"}},"required":["name"]},"Holiday-holiday.write.jsonMergePatch":{"type":"object","description":"A closed day of a business schedule; recurring holidays repeat every year on the same date.","properties":{"schedule":{"type":"string","format":"iri-reference","example":"https://example.com/"},"name":{"maxLength":150,"type":"string"},"date":{"type":"string","format":"date-time"},"recurring":{"default":false,"type":"boolean"}}},"Holiday-schedule.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":150,"type":"string"},"date":{"type":"string","format":"date-time"},"recurring":{"default":false,"type":"boolean"}},"required":["name"]},"Holiday.jsonld-holiday.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"schedule":{"type":"string","format":"iri-reference","example":"https://example.com/"},"name":{"maxLength":150,"type":"string"},"date":{"type":"string","format":"date-time"},"recurring":{"default":false,"type":"boolean"}},"required":["name"]}],"description":"A closed day of a business schedule; recurring holidays repeat every year on the same date."},"Holiday.jsonld-schedule.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":150,"type":"string"},"date":{"type":"string","format":"date-time"},"recurring":{"default":false,"type":"boolean"}},"required":["name"]}],"description":"A closed day of a business schedule; recurring holidays repeat every year on the same date."},"HydraCollectionBaseSchema":{"allOf":[{"$ref":"#/components/schemas/HydraCollectionBaseSchemaNoPagination"},{"type":"object","properties":{"view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"first":{"type":["string","null"],"format":"iri-reference"},"last":{"type":["string","null"],"format":"iri-reference"},"previous":{"type":["string","null"],"format":"iri-reference"},"next":{"type":["string","null"],"format":"iri-reference"}},"example":{"@id":"string","@type":"string","first":"string","last":"string","previous":"string","next":"string"}}}}]},"HydraCollectionBaseSchemaNoPagination":{"type":"object","properties":{"totalItems":{"type":"integer","minimum":0},"search":{"type":"object","properties":{"@type":{"type":"string"},"template":{"type":"string"},"variableRepresentation":{"type":"string"},"mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":["string","null"]},"required":{"type":"boolean"}}}}}}}},"HydraItemBaseSchema":{"type":"object","properties":{"@context":{"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"type":"string"},"@type":{"type":"string"}},"required":["@id","@type"]},"Macro-rule.read":{"type":"object","description":"Macro: shared (owner null; managing needs macro.manage_shared, or macro.manage_group when it is\nrestricted to the agent's groups) or personal to its owner (macro.manage_personal).\nCollections are scoped by PersonalRuleScopeExtension.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"shared":{"description":"Write-only switch: false makes it personal to the current agent (set by PersonalRuleProcessor).","type":["boolean","null"]},"actions":{"type":"array","items":{"type":"object","additionalProperties":{}}},"usage_count":{"readOnly":true,"default":0,"type":"integer"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"},"restricted_groups":{"type":"array","items":{"type":"string","format":"iri-reference","example":"https://example.com/"}}},"required":["title"]},"Macro-rule.write":{"type":"object","description":"Macro: shared (owner null; managing needs macro.manage_shared, or macro.manage_group when it is\nrestricted to the agent's groups) or personal to its owner (macro.manage_personal).\nCollections are scoped by PersonalRuleScopeExtension.","properties":{"shared":{"description":"Write-only switch: false makes it personal to the current agent (set by PersonalRuleProcessor).","type":["boolean","null"]},"actions":{"type":"array","items":{"type":"object","additionalProperties":{}}},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"restricted_groups":{"type":"array","items":{"type":"string","format":"iri-reference","example":"https://example.com/"}}},"required":["title"]},"Macro-rule.write.jsonMergePatch":{"type":"object","description":"Macro: shared (owner null; managing needs macro.manage_shared, or macro.manage_group when it is\nrestricted to the agent's groups) or personal to its owner (macro.manage_personal).\nCollections are scoped by PersonalRuleScopeExtension.","properties":{"shared":{"description":"Write-only switch: false makes it personal to the current agent (set by PersonalRuleProcessor).","type":["boolean","null"]},"actions":{"type":"array","items":{"type":"object","additionalProperties":{}}},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"restricted_groups":{"type":"array","items":{"type":"string","format":"iri-reference","example":"https://example.com/"}}}},"Macro-rule.write_workspace.write":{"type":"object","description":"Macro: shared (owner null; managing needs macro.manage_shared, or macro.manage_group when it is\nrestricted to the agent's groups) or personal to its owner (macro.manage_personal).\nCollections are scoped by PersonalRuleScopeExtension.","properties":{"shared":{"description":"Write-only switch: false makes it personal to the current agent (set by PersonalRuleProcessor).","type":["boolean","null"]},"actions":{"type":"array","items":{"type":"object","additionalProperties":{}}},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"restricted_groups":{"type":"array","items":{"type":"string","format":"iri-reference","example":"https://example.com/"}}},"required":["title"]},"Macro.jsonld-rule.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"shared":{"description":"Write-only switch: false makes it personal to the current agent (set by PersonalRuleProcessor).","type":["boolean","null"]},"actions":{"type":"array","items":{"type":"object","additionalProperties":{}}},"usage_count":{"readOnly":true,"default":0,"type":"integer"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"},"restricted_groups":{"type":"array","items":{"type":"string","format":"iri-reference","example":"https://example.com/"}}},"required":["title"]}],"description":"Macro: shared (owner null; managing needs macro.manage_shared, or macro.manage_group when it is\nrestricted to the agent's groups) or personal to its owner (macro.manage_personal).\nCollections are scoped by PersonalRuleScopeExtension."},"Organization-org.read_org.summary_group.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":255,"type":"string"},"details":{"type":["string","null"]},"notes":{"type":["string","null"]},"shared_tickets":{"description":"Zendesk \"shared tickets\": members can see each other's requests in the portal.","default":false,"type":"boolean"},"default_group":{"anyOf":[{"$ref":"#/components/schemas/Group-org.read_org.summary_group.summary"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"domain_names":{"type":"array","items":{"type":"string"}}},"required":["name"]},"Organization-org.write":{"type":"object","required":["name"],"properties":{"name":{"maxLength":255,"type":"string"},"details":{"type":["string","null"]},"notes":{"type":["string","null"]},"shared_tickets":{"description":"Zendesk \"shared tickets\": members can see each other's requests in the portal.","default":false,"type":"boolean"},"default_group":{"type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"tags":{"type":"array","items":{"type":"string"}},"domain_names":{"type":"array","items":{"type":"string"}}}},"Organization-org.write.jsonMergePatch":{"type":"object","properties":{"name":{"maxLength":255,"type":"string"},"details":{"type":["string","null"]},"notes":{"type":["string","null"]},"shared_tickets":{"description":"Zendesk \"shared tickets\": members can see each other's requests in the portal.","default":false,"type":"boolean"},"default_group":{"type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"tags":{"type":"array","items":{"type":"string"}},"domain_names":{"type":"array","items":{"type":"string"}}}},"Organization-ticket.read_user.summary_group.summary_org.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":255,"type":"string"}},"required":["name"]},"Organization-user.read_user.summary_org.summary_group.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":255,"type":"string"}},"required":["name"]},"Organization.jsonld-org.read_org.summary_group.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":255,"type":"string"},"details":{"type":["string","null"]},"notes":{"type":["string","null"]},"shared_tickets":{"description":"Zendesk \"shared tickets\": members can see each other's requests in the portal.","default":false,"type":"boolean"},"default_group":{"anyOf":[{"$ref":"#/components/schemas/Group.jsonld-org.read_org.summary_group.summary"},{"type":"null"}]},"tags":{"type":"array","items":{"type":"string"}},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"domain_names":{"type":"array","items":{"type":"string"}}},"required":["name"]}]},"Organization.jsonld-ticket.read_user.summary_group.summary_org.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":255,"type":"string"}},"required":["name"]}]},"Organization.jsonld-user.read_user.summary_org.summary_group.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":255,"type":"string"}},"required":["name"]}]},"OrganizationField-people_field.read":{"type":"object","description":"Custom organization field definition (Zendesk \"organization fields\").","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"key":{"pattern":"^([a-z][a-z0-9_]{1,63})$","description":"Stable machine key used in rules, search, import and the API (`user_fields.{key}`).","type":"string"},"title":{"maxLength":255,"type":"string"},"type":{"type":"string","enum":["text","textarea","dropdown","multiselect","date","integer","decimal","checkbox","regex","credit_card","lookup","currency"]},"description":{"maxLength":1000,"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"regex_pattern":{"type":["string","null"]},"options":{"description":"options for dropdown/multiselect","type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}}},"required":["title"]},"OrganizationField-people_field.write.jsonMergePatch":{"type":"object","description":"Custom organization field definition (Zendesk \"organization fields\").","properties":{"title":{"maxLength":255,"type":"string"},"description":{"maxLength":1000,"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"regex_pattern":{"type":["string","null"]},"options":{"description":"options for dropdown/multiselect","type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}}}},"OrganizationField-people_field.write_people_field.create":{"type":"object","description":"Custom organization field definition (Zendesk \"organization fields\").","properties":{"key":{"pattern":"^([a-z][a-z0-9_]{1,63})$","description":"Stable machine key used in rules, search, import and the API (`user_fields.{key}`).","type":"string"},"title":{"maxLength":255,"type":"string"},"type":{"type":"string","enum":["text","textarea","dropdown","multiselect","date","integer","decimal","checkbox","regex","credit_card","lookup","currency"]},"description":{"maxLength":1000,"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"regex_pattern":{"type":["string","null"]},"options":{"description":"options for dropdown/multiselect","type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}}},"required":["title"]},"OrganizationField.jsonld-people_field.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"key":{"pattern":"^([a-z][a-z0-9_]{1,63})$","description":"Stable machine key used in rules, search, import and the API (`user_fields.{key}`).","type":"string"},"title":{"maxLength":255,"type":"string"},"type":{"type":"string","enum":["text","textarea","dropdown","multiselect","date","integer","decimal","checkbox","regex","credit_card","lookup","currency"]},"description":{"maxLength":1000,"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"regex_pattern":{"type":["string","null"]},"options":{"description":"options for dropdown/multiselect","type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}}},"required":["title"]}],"description":"Custom organization field definition (Zendesk \"organization fields\")."},"RealtimeToken":{"type":"object","description":"Short-lived Mercure subscriber token scoped to the topics this user may receive.","properties":{"hub_url":{"type":"string"},"token":{"type":"string"},"topics":{"type":"array","items":{"type":"string"}},"expires_at":{"type":"string","format":"date-time"}}},"RealtimeToken.jsonld":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"hub_url":{"type":"string"},"token":{"type":"string"},"topics":{"type":"array","items":{"type":"string"}},"expires_at":{"type":"string","format":"date-time"}}}],"description":"Short-lived Mercure subscriber token scoped to the topics this user may receive."},"RedactionRule-redaction_rule.read":{"type":"object","description":"One PII auto-redaction rule applied to every incoming comment and subject (P10).\nBuilt-in kinds (card number, passport and the regional pack detectors: SA ID, IBAN, EU national\nIDs, US SSN, JMBG, OIB) are validated detectors that can only be switched on or off; PIN and\ncustom kinds are admin-editable regular expressions. Only card numbers are on by default.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":120,"type":"string"},"kind":{"type":"string","enum":["pin","card_number","sa_id","passport","iban","eu_national_id","us_ssn","jmbg","oib","custom"]},"pattern":{"description":"PCRE without delimiters; group 1 (if any) is the part that is masked. Null for built-in kinds.","type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"},"built_in":{"readOnly":true,"type":"boolean"}},"required":["name"]},"RedactionRule-redaction_rule.write":{"type":"object","description":"One PII auto-redaction rule applied to every incoming comment and subject (P10).\nBuilt-in kinds (card number, passport and the regional pack detectors: SA ID, IBAN, EU national\nIDs, US SSN, JMBG, OIB) are validated detectors that can only be switched on or off; PIN and\ncustom kinds are admin-editable regular expressions. Only card numbers are on by default.","required":["name"],"properties":{"name":{"maxLength":120,"type":"string"},"kind":{"type":"string","enum":["pin","card_number","sa_id","passport","iban","eu_national_id","us_ssn","jmbg","oib","custom"]},"pattern":{"description":"PCRE without delimiters; group 1 (if any) is the part that is masked. Null for built-in kinds.","type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"}}},"RedactionRule-redaction_rule.write.jsonMergePatch":{"type":"object","description":"One PII auto-redaction rule applied to every incoming comment and subject (P10).\nBuilt-in kinds (card number, passport and the regional pack detectors: SA ID, IBAN, EU national\nIDs, US SSN, JMBG, OIB) are validated detectors that can only be switched on or off; PIN and\ncustom kinds are admin-editable regular expressions. Only card numbers are on by default.","properties":{"name":{"maxLength":120,"type":"string"},"kind":{"type":"string","enum":["pin","card_number","sa_id","passport","iban","eu_national_id","us_ssn","jmbg","oib","custom"]},"pattern":{"description":"PCRE without delimiters; group 1 (if any) is the part that is masked. Null for built-in kinds.","type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"}}},"RedactionRule.jsonld-redaction_rule.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":120,"type":"string"},"kind":{"type":"string","enum":["pin","card_number","sa_id","passport","iban","eu_national_id","us_ssn","jmbg","oib","custom"]},"pattern":{"description":"PCRE without delimiters; group 1 (if any) is the part that is masked. Null for built-in kinds.","type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"},"built_in":{"readOnly":true,"type":"boolean"}},"required":["name"]}],"description":"One PII auto-redaction rule applied to every incoming comment and subject (P10).\nBuilt-in kinds (card number, passport and the regional pack detectors: SA ID, IBAN, EU national\nIDs, US SSN, JMBG, OIB) are validated detectors that can only be switched on or off; PIN and\ncustom kinds are admin-editable regular expressions. Only card numbers are on by default."},"RequesterInput":{"type":"object","properties":{"name":{"maxLength":255,"type":["string","null"]},"email":{"format":"email","externalDocs":{"url":"https://schema.org/email"},"default":"","type":"string"}},"required":["email"]},"RetentionPolicy-retention.read":{"type":"object","description":"Data retention (P10): closed tickets last updated more than N months ago are deleted or\nanonymised by the daily RunRetentionPolicies job. Optionally limited to a brand and/or group.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":120,"type":"string"},"action":{"type":"string","enum":["delete","anonymize"]},"after_months":{"minimum":1,"maximum":240,"description":"Months since the ticket was closed (last update of a closed ticket).","type":"integer"},"brand":{"type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"group":{"type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"active":{"default":true,"type":"boolean"},"last_run_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"last_run_count":{"readOnly":true,"type":["integer","null"]},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"}},"required":["name"]},"RetentionPolicy-retention.write":{"type":"object","description":"Data retention (P10): closed tickets last updated more than N months ago are deleted or\nanonymised by the daily RunRetentionPolicies job. Optionally limited to a brand and/or group.","required":["name"],"properties":{"name":{"maxLength":120,"type":"string"},"action":{"type":"string","enum":["delete","anonymize"]},"after_months":{"minimum":1,"maximum":240,"description":"Months since the ticket was closed (last update of a closed ticket).","type":"integer"},"brand":{"type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"group":{"type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"active":{"default":true,"type":"boolean"}}},"RetentionPolicy-retention.write.jsonMergePatch":{"type":"object","description":"Data retention (P10): closed tickets last updated more than N months ago are deleted or\nanonymised by the daily RunRetentionPolicies job. Optionally limited to a brand and/or group.","properties":{"name":{"maxLength":120,"type":"string"},"action":{"type":"string","enum":["delete","anonymize"]},"after_months":{"minimum":1,"maximum":240,"description":"Months since the ticket was closed (last update of a closed ticket).","type":"integer"},"brand":{"type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"group":{"type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"active":{"default":true,"type":"boolean"}}},"RetentionPolicy.jsonld-retention.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":120,"type":"string"},"action":{"type":"string","enum":["delete","anonymize"]},"after_months":{"minimum":1,"maximum":240,"description":"Months since the ticket was closed (last update of a closed ticket).","type":"integer"},"brand":{"type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"group":{"type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"active":{"default":true,"type":"boolean"},"last_run_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"last_run_count":{"readOnly":true,"type":["integer","null"]},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"}},"required":["name"]}],"description":"Data retention (P10): closed tickets last updated more than N months ago are deleted or\nanonymised by the daily RunRetentionPolicies job. Optionally limited to a brand and/or group."},"Role-role.read":{"type":"object","description":"Agent role: built-in (\"Agent\", \"Light agent\") or custom. Admins don't need one.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":100,"type":"string"},"description":{"type":["string","null"]},"system":{"default":false,"type":"boolean"},"ticket_access":{"type":"string","enum":["all","groups","assigned"]},"permissions":{"type":"array","items":{"type":"string"}},"configuration":{"description":"Raw Zendesk custom_role.configuration (imported, seeded or saved by the role editor). It is\nthe source of truth for ticket access and permissions whenever it is set; null for roles\nthat only have a permission list (the API then derives one, see getConfiguration()).","type":["object","null"],"additionalProperties":{}}},"required":["name"]},"Role-role.write":{"type":"object","description":"Agent role: built-in (\"Agent\", \"Light agent\") or custom. Admins don't need one.","required":["name"],"properties":{"name":{"maxLength":100,"type":"string"},"description":{"type":["string","null"]},"ticket_access":{"type":"string","enum":["all","groups","assigned"]},"permissions":{"type":"array","items":{"type":"string"}},"configuration":{"description":"Raw Zendesk custom_role.configuration (imported, seeded or saved by the role editor). It is\nthe source of truth for ticket access and permissions whenever it is set; null for roles\nthat only have a permission list (the API then derives one, see getConfiguration()).","type":["object","null"],"additionalProperties":{}}}},"Role-role.write.jsonMergePatch":{"type":"object","description":"Agent role: built-in (\"Agent\", \"Light agent\") or custom. Admins don't need one.","properties":{"name":{"maxLength":100,"type":"string"},"description":{"type":["string","null"]},"ticket_access":{"type":"string","enum":["all","groups","assigned"]},"permissions":{"type":"array","items":{"type":"string"}},"configuration":{"description":"Raw Zendesk custom_role.configuration (imported, seeded or saved by the role editor). It is\nthe source of truth for ticket access and permissions whenever it is set; null for roles\nthat only have a permission list (the API then derives one, see getConfiguration()).","type":["object","null"],"additionalProperties":{}}}},"Role-user.read_user.summary_org.summary_group.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":100,"type":"string"}},"required":["name"]},"Role.jsonld-role.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":100,"type":"string"},"description":{"type":["string","null"]},"system":{"default":false,"type":"boolean"},"ticket_access":{"type":"string","enum":["all","groups","assigned"]},"permissions":{"type":"array","items":{"type":"string"}},"configuration":{"description":"Raw Zendesk custom_role.configuration (imported, seeded or saved by the role editor). It is\nthe source of truth for ticket access and permissions whenever it is set; null for roles\nthat only have a permission list (the API then derives one, see getConfiguration()).","type":["object","null"],"additionalProperties":{}}},"required":["name"]}],"description":"Agent role: built-in (\"Agent\", \"Light agent\") or custom. Admins don't need one."},"Role.jsonld-user.read_user.summary_org.summary_group.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":100,"type":"string"}},"required":["name"]}],"description":"Agent role: built-in (\"Agent\", \"Light agent\") or custom. Admins don't need one."},"SlaPolicy-rule.read_sla_policy.read":{"type":"object","description":"An SLA policy (Zendesk): ordered, the first active policy whose conditions match the ticket\napplies. Targets are per metric and priority, in minutes, in business or calendar hours.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"targets":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"string"}]}}},"schedule":{"description":"Business hours for targets measured in business hours; null = the default schedule.","anyOf":[{"$ref":"#/components/schemas/BusinessSchedule-rule.read_sla_policy.read"},{"type":"null"}]},"warning_percent":{"minimum":0,"maximum":99,"description":"Scanner warning when this share of a target is used (0 disables warnings).","default":75,"type":"integer"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"}},"required":["title"]},"SlaPolicy-rule.write_sla_policy.write":{"type":"object","description":"An SLA policy (Zendesk): ordered, the first active policy whose conditions match the ticket\napplies. Targets are per metric and priority, in minutes, in business or calendar hours.","properties":{"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"targets":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"string"}]}}},"schedule":{"description":"Business hours for targets measured in business hours; null = the default schedule.","type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"warning_percent":{"minimum":0,"maximum":99,"description":"Scanner warning when this share of a target is used (0 disables warnings).","default":75,"type":"integer"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"}},"required":["title"]},"SlaPolicy-rule.write_sla_policy.write.jsonMergePatch":{"type":"object","description":"An SLA policy (Zendesk): ordered, the first active policy whose conditions match the ticket\napplies. Targets are per metric and priority, in minutes, in business or calendar hours.","properties":{"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"targets":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"string"}]}}},"schedule":{"description":"Business hours for targets measured in business hours; null = the default schedule.","type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"warning_percent":{"minimum":0,"maximum":99,"description":"Scanner warning when this share of a target is used (0 disables warnings).","default":75,"type":"integer"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"}}},"SlaPolicy.jsonld-rule.read_sla_policy.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"targets":{"type":"array","items":{"type":"object","additionalProperties":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"string"}]}}},"schedule":{"description":"Business hours for targets measured in business hours; null = the default schedule.","anyOf":[{"$ref":"#/components/schemas/BusinessSchedule.jsonld-rule.read_sla_policy.read"},{"type":"null"}]},"warning_percent":{"minimum":0,"maximum":99,"description":"Scanner warning when this share of a target is used (0 disables warnings).","default":75,"type":"integer"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"}},"required":["title"]}],"description":"An SLA policy (Zendesk): ordered, the first active policy whose conditions match the ticket\napplies. Targets are per metric and priority, in minutes, in business or calendar hours."},"SupportAddress-address.read_brand.read_group.summary":{"type":"object","description":"Inbound/outbound support email address (\"received at\"), routed to a brand, default group and\ndefault form. `is_default` marks the brand's default sending address (Zendesk: one per brand).\nForwarding is verified by mailing a token to the address and receiving it back.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"email":{"format":"email","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"name":{"type":"string"},"brand":{"$ref":"#/components/schemas/Brand-address.read_brand.read_group.summary"},"default_group":{"anyOf":[{"$ref":"#/components/schemas/Group-address.read_brand.read_group.summary"},{"type":"null"}]},"is_default":{"default":false,"type":"boolean"},"default_form":{"description":"Applied to new tickets received at this address (Zendesk: form by address via triggers).","type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"forwarding_status":{"readOnly":true,"description":"unknown | pending | verified | failed","default":"unknown","type":"string"},"forwarding_checked_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"forwarding_verified_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"forwarding_failure_reason":{"readOnly":true,"type":["string","null"]}},"required":["name"]},"SupportAddress-address.write":{"type":"object","description":"Inbound/outbound support email address (\"received at\"), routed to a brand, default group and\ndefault form. `is_default` marks the brand's default sending address (Zendesk: one per brand).\nForwarding is verified by mailing a token to the address and receiving it back.","properties":{"email":{"format":"email","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"name":{"type":"string"},"brand":{"type":"string","format":"iri-reference","example":"https://example.com/"},"default_group":{"type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"is_default":{"default":false,"type":"boolean"},"default_form":{"description":"Applied to new tickets received at this address (Zendesk: form by address via triggers).","type":["string","null"],"format":"iri-reference","example":"https://example.com/"}},"required":["name"]},"SupportAddress-address.write.jsonMergePatch":{"type":"object","description":"Inbound/outbound support email address (\"received at\"), routed to a brand, default group and\ndefault form. `is_default` marks the brand's default sending address (Zendesk: one per brand).\nForwarding is verified by mailing a token to the address and receiving it back.","properties":{"email":{"format":"email","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"name":{"type":"string"},"brand":{"type":"string","format":"iri-reference","example":"https://example.com/"},"default_group":{"type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"is_default":{"default":false,"type":"boolean"},"default_form":{"description":"Applied to new tickets received at this address (Zendesk: form by address via triggers).","type":["string","null"],"format":"iri-reference","example":"https://example.com/"}}},"SupportAddress.jsonld-address.read_brand.read_group.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"email":{"format":"email","externalDocs":{"url":"https://schema.org/email"},"type":"string"},"name":{"type":"string"},"brand":{"$ref":"#/components/schemas/Brand.jsonld-address.read_brand.read_group.summary"},"default_group":{"anyOf":[{"$ref":"#/components/schemas/Group.jsonld-address.read_brand.read_group.summary"},{"type":"null"}]},"is_default":{"default":false,"type":"boolean"},"default_form":{"description":"Applied to new tickets received at this address (Zendesk: form by address via triggers).","type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"forwarding_status":{"readOnly":true,"description":"unknown | pending | verified | failed","default":"unknown","type":"string"},"forwarding_checked_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"forwarding_verified_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"forwarding_failure_reason":{"readOnly":true,"type":["string","null"]}},"required":["name"]}],"description":"Inbound/outbound support email address (\"received at\"), routed to a brand, default group and\ndefault form. `is_default` marks the brand's default sending address (Zendesk: one per brand).\nForwarding is verified by mailing a token to the address and receiving it back."},"SuspendedTicket-suspended.read":{"type":"object","description":"Email that was held back (spam, auto-reply, unknown sender…) for an agent to recover or delete.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"cause":{"description":"spam | sender_suspended | auto_reply | bulk | mailing_list | loop | unverified | blocklist | rate_limited | empty\n(legacy: unknown_sender = unverified). See App\\Email\\Inbound\\SuspensionCause.","type":"string"},"from_address":{"type":"string"},"from_name":{"type":["string","null"]},"subject":{"type":"string"},"excerpt":{"type":"string"},"recipient":{"type":["string","null"]},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"resolved_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"recovered_ticket":{"readOnly":true,"type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"spam_score":{"description":"Spam score reported by the provider/filter (X-Spam-Score, rspamd…), when known.","type":["number","null"]}}},"SuspendedTicket.jsonld-suspended.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"cause":{"description":"spam | sender_suspended | auto_reply | bulk | mailing_list | loop | unverified | blocklist | rate_limited | empty\n(legacy: unknown_sender = unverified). See App\\Email\\Inbound\\SuspensionCause.","type":"string"},"from_address":{"type":"string"},"from_name":{"type":["string","null"]},"subject":{"type":"string"},"excerpt":{"type":"string"},"recipient":{"type":["string","null"]},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"resolved_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"recovered_ticket":{"readOnly":true,"type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"spam_score":{"description":"Spam score reported by the provider/filter (X-Spam-Score, rspamd…), when known.","type":["number","null"]}}}],"description":"Email that was held back (spam, auto-reply, unknown sender…) for an agent to recover or delete."},"Tag-tag.read":{"type":"object","description":"Tag catalogue (autocomplete + usage). Tickets store tags as a jsonb string list\n(GIN-indexed); this table is kept in sync by TagCatalog.","properties":{"name":{"type":"string"}}},"Tag.jsonld-tag.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"name":{"type":"string"}}}],"description":"Tag catalogue (autocomplete + usage). Tickets store tags as a jsonb string list\n(GIN-indexed); this table is kept in sync by TagCatalog."},"Ticket-ticket.read_user.summary_group.summary_org.summary":{"type":"object","description":"Ticket aggregate. Mutate ONLY through App\\Ticket\\TicketService, which records the TicketAudit.\nSetters below are deliberately \"apply*\"-named and used by TicketChangeApplier.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"number":{"description":"Human-facing sequential number (#10234).","type":"integer"},"subject":{"type":"string"},"status":{"readOnly":true,"default":"new","type":"string","enum":["new","open","pending","hold","solved","closed"]},"priority":{"readOnly":true,"default":"normal","type":"string","enum":["low","normal","high","urgent"]},"type":{"readOnly":true,"type":["string","null"],"enum":["question","incident","problem","task",null]},"due_at":{"readOnly":true,"description":"Task due date.","type":["string","null"],"format":"date-time"},"requester":{"$ref":"#/components/schemas/User-ticket.read_user.summary_group.summary_org.summary"},"submitter":{"$ref":"#/components/schemas/User-ticket.read_user.summary_group.summary_org.summary"},"assignee":{"readOnly":true,"anyOf":[{"$ref":"#/components/schemas/User-ticket.read_user.summary_group.summary_org.summary"},{"type":"null"}]},"group":{"readOnly":true,"anyOf":[{"$ref":"#/components/schemas/Group-ticket.read_user.summary_group.summary_org.summary"},{"type":"null"}]},"organization":{"readOnly":true,"anyOf":[{"$ref":"#/components/schemas/Organization-ticket.read_user.summary_group.summary_org.summary"},{"type":"null"}]},"brand":{"readOnly":true,"anyOf":[{"$ref":"#/components/schemas/Brand-ticket.read_user.summary_group.summary_org.summary"},{"type":"null"}]},"form":{"readOnly":true,"anyOf":[{"$ref":"#/components/schemas/TicketForm-ticket.read_user.summary_group.summary_org.summary"},{"type":"null"}]},"via":{"type":"string","enum":["web","email","api","help_center","chat","rule","system","whatsapp","facebook","messaging","instagram","sms","import"]},"recipient":{"readOnly":true,"description":"The support address the ticket arrived on / replies are sent from.","type":["string","null"]},"tags":{"readOnly":true,"type":"array","items":{"type":"string"}},"collaborators":{"readOnly":true,"description":"CCs (receive public replies)","type":"array","items":{"$ref":"#/components/schemas/User-ticket.read_user.summary_group.summary_org.summary"}},"followers":{"readOnly":true,"description":"followers (agents; notified of all updates)","type":"array","items":{"$ref":"#/components/schemas/User-ticket.read_user.summary_group.summary_org.summary"}},"is_public":{"readOnly":true,"description":"False when created with a private comment (Zendesk is_public).","default":true,"type":"boolean"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"},"status_updated_at":{"readOnly":true,"type":"string","format":"date-time"},"assigned_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"solved_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"requester_updated_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"assignee_updated_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"satisfaction":{"readOnly":true,"description":"CSAT state (P6): unoffered → offered → good|bad. Details in SatisfactionRating.","default":"unoffered","type":"string","enum":["unoffered","offered","bad","good"]},"satisfaction_reason":{"readOnly":true,"description":"CSAT reason code picked with a bad rating (Zendesk csat_reason_code); see App\\Entity\\CsatReason.","type":["string","null"]},"deleted_at":{"readOnly":true,"description":"Soft delete (Zendesk \"deleted tickets\"): hidden everywhere, restorable for 30 days, then purged.","type":["string","null"],"format":"date-time"},"external_id":{"readOnly":true,"description":"Zendesk `external_id`: the integration's own reference (e.g. an order id in another system); set via the Zendesk API or import.","type":["string","null"]},"version":{"readOnly":true,"description":"Optimistic lock + \"safe update\" stamp.","default":1,"type":"integer"},"total_time_spent":{"readOnly":true,"description":"Seconds agents spent on the ticket (Zendesk Time Tracking \"Total time spent\"); only App\\TimeTracking keeps it.","default":0,"type":"integer"},"problem_id":{"readOnly":true,"type":["string","null"]},"follow_up_source_id":{"readOnly":true,"type":["string","null"]},"custom_fields":{"readOnly":true,"type":"array","items":{"type":"object","additionalProperties":{}}},"schedule_id":{"readOnly":true,"type":["string","null"]},"follow_up_source_number":{"readOnly":true,"type":["integer","null"]},"custom_status_id":{"readOnly":true,"type":["string","null"]},"custom_status":{"readOnly":true,"description":"`custom_status` for badges and the status picker.","type":["object","null"],"additionalProperties":{"type":"string"}}}},"Ticket.TicketCreateInput":{"type":"object","description":"Ticket aggregate. Mutate ONLY through App\\Ticket\\TicketService, which records the TicketAudit.\nSetters below are deliberately \"apply*\"-named and used by TicketChangeApplier.","required":["subject","comment"],"properties":{"subject":{"maxLength":255,"default":"","type":"string"},"comment":{"anyOf":[{"$ref":"#/components/schemas/CommentInput"},{"type":"null"}]},"requester_id":{"format":"uuid","externalDocs":{"url":"https://schema.org/identifier"},"type":["string","null"]},"requester":{"anyOf":[{"$ref":"#/components/schemas/RequesterInput"},{"type":"null"}]},"assignee_id":{"format":"uuid","externalDocs":{"url":"https://schema.org/identifier"},"type":["string","null"]},"group_id":{"format":"uuid","externalDocs":{"url":"https://schema.org/identifier"},"type":["string","null"]},"organization_id":{"format":"uuid","externalDocs":{"url":"https://schema.org/identifier"},"type":["string","null"]},"brand_id":{"format":"uuid","externalDocs":{"url":"https://schema.org/identifier"},"type":["string","null"]},"problem_id":{"format":"uuid","externalDocs":{"url":"https://schema.org/identifier"},"type":["string","null"]},"form_id":{"format":"uuid","externalDocs":{"url":"https://schema.org/identifier"},"type":["string","null"]},"status":{"type":["string","null"],"enum":["new","open","pending","hold","solved","closed",null]},"custom_status_id":{"format":"uuid","description":"Zendesk `custom_status_id` (wins over `status`).","externalDocs":{"url":"https://schema.org/identifier"},"type":["string","null"]},"priority":{"type":["string","null"],"enum":["low","normal","high","urgent",null]},"type":{"type":["string","null"],"enum":["question","incident","problem","task",null]},"due_at":{"type":["string","null"],"format":"date-time"},"tags":{"type":"array","items":{"type":"string"}},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldInput"}},"collaborator_ids":{"type":"array","items":{"type":"string"}}}},"Ticket.TicketUpdateInput.jsonMergePatch":{"type":"object","description":"Ticket aggregate. Mutate ONLY through App\\Ticket\\TicketService, which records the TicketAudit.\nSetters below are deliberately \"apply*\"-named and used by TicketChangeApplier.","properties":{"subject":{"minLength":1,"maxLength":255,"type":"string"},"status":{"type":"string","enum":["new","open","pending","hold","solved","closed"]},"custom_status_id":{"format":"uuid","description":"Zendesk `custom_status_id`: the ticket's status becomes the custom status's category.","externalDocs":{"url":"https://schema.org/identifier"},"type":"string"},"priority":{"type":"string","enum":["low","normal","high","urgent"]},"type":{"type":["string","null"],"enum":["question","incident","problem","task",null]},"due_at":{"type":["string","null"],"format":"date-time"},"assignee_id":{"format":"uuid","externalDocs":{"url":"https://schema.org/identifier"},"type":["string","null"]},"group_id":{"format":"uuid","externalDocs":{"url":"https://schema.org/identifier"},"type":["string","null"]},"requester_id":{"format":"uuid","externalDocs":{"url":"https://schema.org/identifier"},"type":"string"},"organization_id":{"format":"uuid","externalDocs":{"url":"https://schema.org/identifier"},"type":["string","null"]},"problem_id":{"format":"uuid","externalDocs":{"url":"https://schema.org/identifier"},"type":["string","null"]},"form_id":{"format":"uuid","externalDocs":{"url":"https://schema.org/identifier"},"type":["string","null"]},"tags":{"description":"replaces all tags","type":"array","items":{"type":"string"}},"additional_tags":{"type":"array","items":{"type":"string"}},"remove_tags":{"type":"array","items":{"type":"string"}},"custom_fields":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldInput"}},"add_collaborator_ids":{"type":"array","items":{"type":"string"}},"remove_collaborator_ids":{"type":"array","items":{"type":"string"}},"add_follower_ids":{"type":"array","items":{"type":"string"}},"remove_follower_ids":{"type":"array","items":{"type":"string"}},"comment":{"$ref":"#/components/schemas/CommentInput"},"macro_ids":{"description":"macros applied to this draft (Zendesk `macro_ids`): their tag changes are allowed without ticket.edit_tags","type":"array","items":{"type":"string"}},"time_spent":{"minimum":0,"maximum":86400,"description":"Seconds the agent spent on this update (Zendesk Time Tracking app); App\\TimeTracking\\TimeTrackingHook.","type":"integer"},"version":{"minimum":0,"exclusiveMinimum":0,"description":"Safe update: the ticket version the client last saw.","type":"integer"}}},"Ticket.jsonld-ticket.read_user.summary_group.summary_org.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"number":{"description":"Human-facing sequential number (#10234).","type":"integer"},"subject":{"type":"string"},"status":{"readOnly":true,"default":"new","type":"string","enum":["new","open","pending","hold","solved","closed"]},"priority":{"readOnly":true,"default":"normal","type":"string","enum":["low","normal","high","urgent"]},"type":{"readOnly":true,"type":["string","null"],"enum":["question","incident","problem","task",null]},"due_at":{"readOnly":true,"description":"Task due date.","type":["string","null"],"format":"date-time"},"requester":{"$ref":"#/components/schemas/User.jsonld-ticket.read_user.summary_group.summary_org.summary"},"submitter":{"$ref":"#/components/schemas/User.jsonld-ticket.read_user.summary_group.summary_org.summary"},"assignee":{"readOnly":true,"anyOf":[{"$ref":"#/components/schemas/User.jsonld-ticket.read_user.summary_group.summary_org.summary"},{"type":"null"}]},"group":{"readOnly":true,"anyOf":[{"$ref":"#/components/schemas/Group.jsonld-ticket.read_user.summary_group.summary_org.summary"},{"type":"null"}]},"organization":{"readOnly":true,"anyOf":[{"$ref":"#/components/schemas/Organization.jsonld-ticket.read_user.summary_group.summary_org.summary"},{"type":"null"}]},"brand":{"readOnly":true,"anyOf":[{"$ref":"#/components/schemas/Brand.jsonld-ticket.read_user.summary_group.summary_org.summary"},{"type":"null"}]},"form":{"readOnly":true,"anyOf":[{"$ref":"#/components/schemas/TicketForm.jsonld-ticket.read_user.summary_group.summary_org.summary"},{"type":"null"}]},"via":{"type":"string","enum":["web","email","api","help_center","chat","rule","system","whatsapp","facebook","messaging","instagram","sms","import"]},"recipient":{"readOnly":true,"description":"The support address the ticket arrived on / replies are sent from.","type":["string","null"]},"tags":{"readOnly":true,"type":"array","items":{"type":"string"}},"collaborators":{"readOnly":true,"description":"CCs (receive public replies)","type":"array","items":{"$ref":"#/components/schemas/User.jsonld-ticket.read_user.summary_group.summary_org.summary"}},"followers":{"readOnly":true,"description":"followers (agents; notified of all updates)","type":"array","items":{"$ref":"#/components/schemas/User.jsonld-ticket.read_user.summary_group.summary_org.summary"}},"is_public":{"readOnly":true,"description":"False when created with a private comment (Zendesk is_public).","default":true,"type":"boolean"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"},"status_updated_at":{"readOnly":true,"type":"string","format":"date-time"},"assigned_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"solved_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"requester_updated_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"assignee_updated_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"satisfaction":{"readOnly":true,"description":"CSAT state (P6): unoffered → offered → good|bad. Details in SatisfactionRating.","default":"unoffered","type":"string","enum":["unoffered","offered","bad","good"]},"satisfaction_reason":{"readOnly":true,"description":"CSAT reason code picked with a bad rating (Zendesk csat_reason_code); see App\\Entity\\CsatReason.","type":["string","null"]},"deleted_at":{"readOnly":true,"description":"Soft delete (Zendesk \"deleted tickets\"): hidden everywhere, restorable for 30 days, then purged.","type":["string","null"],"format":"date-time"},"external_id":{"readOnly":true,"description":"Zendesk `external_id`: the integration's own reference (e.g. an order id in another system); set via the Zendesk API or import.","type":["string","null"]},"version":{"readOnly":true,"description":"Optimistic lock + \"safe update\" stamp.","default":1,"type":"integer"},"total_time_spent":{"readOnly":true,"description":"Seconds agents spent on the ticket (Zendesk Time Tracking \"Total time spent\"); only App\\TimeTracking keeps it.","default":0,"type":"integer"},"problem_id":{"readOnly":true,"type":["string","null"]},"follow_up_source_id":{"readOnly":true,"type":["string","null"]},"custom_fields":{"readOnly":true,"type":"array","items":{"type":"object","additionalProperties":{}}},"schedule_id":{"readOnly":true,"type":["string","null"]},"follow_up_source_number":{"readOnly":true,"type":["integer","null"]},"custom_status_id":{"readOnly":true,"type":["string","null"]},"custom_status":{"readOnly":true,"description":"`custom_status` for badges and the status picker.","type":["object","null"],"additionalProperties":{"type":"string"}}}}],"description":"Ticket aggregate. Mutate ONLY through App\\Ticket\\TicketService, which records the TicketAudit.\nSetters below are deliberately \"apply*\"-named and used by TicketChangeApplier."},"TicketAudit-audit.read_user.summary":{"type":"object","description":"Immutable record of one ticket update (append-only; enforced by a DB trigger).\nHolds the events (field changes, comment, notifications…) that happened in that update.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"actor":{"description":"Null for system/rule-originated audits.","anyOf":[{"$ref":"#/components/schemas/User-audit.read_user.summary"},{"type":"null"}]},"via":{"type":"string","enum":["web","email","api","help_center","chat","rule","system","whatsapp","facebook","messaging","instagram","sms","import"]},"rule_type":{"description":"e.g. trigger|automation|macro|sla when via=rule.","type":["string","null"]},"rule_id":{"type":["string","null"],"format":"uuid"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"metadata":{"description":"request/channel metadata (request id, client) - never PII","type":"object","additionalProperties":{}},"events":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/TicketAuditEvent-audit.read_user.summary"}}}},"TicketAudit.jsonld-audit.read_user.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"actor":{"description":"Null for system/rule-originated audits.","anyOf":[{"$ref":"#/components/schemas/User.jsonld-audit.read_user.summary"},{"type":"null"}]},"via":{"type":"string","enum":["web","email","api","help_center","chat","rule","system","whatsapp","facebook","messaging","instagram","sms","import"]},"rule_type":{"description":"e.g. trigger|automation|macro|sla when via=rule.","type":["string","null"]},"rule_id":{"type":["string","null"],"format":"uuid"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"metadata":{"description":"request/channel metadata (request id, client) - never PII","type":"object","additionalProperties":{}},"events":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/TicketAuditEvent.jsonld-audit.read_user.summary"}}}}],"description":"Immutable record of one ticket update (append-only; enforced by a DB trigger).\nHolds the events (field changes, comment, notifications…) that happened in that update."},"TicketAuditEvent-audit.read_user.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"type":{"type":"string","enum":["create","change","comment","notification","webhook_call","sla_change","merge","error","side_conversation","redaction","mention"]},"field":{"type":["string","null"]},"value_from":{},"value_to":{},"data":{"readOnly":true,"description":"Always a JSON object (never `[]`) for API consumers.","type":"object","additionalProperties":{}}}},"TicketAuditEvent.jsonld-audit.read_user.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"type":{"type":"string","enum":["create","change","comment","notification","webhook_call","sla_change","merge","error","side_conversation","redaction","mention"]},"field":{"type":["string","null"]},"value_from":{},"value_to":{},"data":{"readOnly":true,"description":"Always a JSON object (never `[]`) for API consumers.","type":"object","additionalProperties":{}}}},"TicketComment-comment.read_user.summary":{"type":"object","description":"Public reply or internal note. Immutable once written (Zendesk allows redaction only).","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"author":{"$ref":"#/components/schemas/User-comment.read_user.summary"},"html_body":{"description":"Sanitized HTML.","type":"string"},"plain_body":{"description":"Plain-text twin for email, search and quote stripping.","type":"string"},"public":{"type":"boolean"},"via":{"type":"string","enum":["web","email","api","help_center","chat","rule","system","whatsapp","facebook","messaging","instagram","sms","import"]},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment-comment.read_user.summary"}},"mentions":{"readOnly":true,"description":"Agents @mentioned in this internal note who could see the ticket (App\\Mention), in order.","type":"array","items":{"type":"string"}}}},"TicketComment.jsonld-comment.read_user.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"author":{"$ref":"#/components/schemas/User.jsonld-comment.read_user.summary"},"html_body":{"description":"Sanitized HTML.","type":"string"},"plain_body":{"description":"Plain-text twin for email, search and quote stripping.","type":"string"},"public":{"type":"boolean"},"via":{"type":"string","enum":["web","email","api","help_center","chat","rule","system","whatsapp","facebook","messaging","instagram","sms","import"]},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment.jsonld-comment.read_user.summary"}},"mentions":{"readOnly":true,"description":"Agents @mentioned in this internal note who could see the ticket (App\\Mention), in order.","type":"array","items":{"type":"string"}}}}],"description":"Public reply or internal note. Immutable once written (Zendesk allows redaction only)."},"TicketField-field.read":{"type":"object","description":"Custom ticket field definition.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"key":{"pattern":"^([a-z][a-z0-9_]{1,63})$","description":"Stable machine key used in search/rules, e.g. \"order_number\".","type":"string"},"title":{"type":"string"},"type":{"type":"string","enum":["text","textarea","dropdown","multiselect","date","integer","decimal","checkbox","regex","credit_card","lookup","currency"]},"description":{"type":["string","null"]},"title_in_portal":{"description":"Title shown to customers in the help centre (Zendesk `title_in_portal`); null = title.","type":["string","null"]},"agent_description":{"description":"Description only agents see (Zendesk `agent_description`); `description` is shown to end users.","type":["string","null"]},"required_to_solve":{"description":"Required for agents when solving (Zendesk behaviour).","default":false,"type":"boolean"},"visible_in_portal":{"default":false,"type":"boolean"},"editable_in_portal":{"default":false,"type":"boolean"},"required_in_portal":{"default":false,"type":"boolean"},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"regex_pattern":{"type":["string","null"]},"options":{"description":"options for dropdown/multiselect","type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"relationship_target_type":{"description":"Lookup fields (Zendesk lookup relationship fields): the related record type, see App\\Lookup\\LookupTarget.","type":["string","null"]},"relationship_filter":{"description":"Lookup fields: conditions the related record must meet ({all: [...], any: [...]}, Zendesk\n`relationship_filter`), see App\\Lookup\\LookupFilter.","type":["object","null"],"additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}}},"required":["title"]},"TicketField-field.write.jsonMergePatch":{"type":"object","description":"Custom ticket field definition.","properties":{"title":{"type":"string"},"type":{"type":"string","enum":["text","textarea","dropdown","multiselect","date","integer","decimal","checkbox","regex","credit_card","lookup","currency"]},"description":{"type":["string","null"]},"title_in_portal":{"description":"Title shown to customers in the help centre (Zendesk `title_in_portal`); null = title.","type":["string","null"]},"agent_description":{"description":"Description only agents see (Zendesk `agent_description`); `description` is shown to end users.","type":["string","null"]},"required_to_solve":{"description":"Required for agents when solving (Zendesk behaviour).","default":false,"type":"boolean"},"visible_in_portal":{"default":false,"type":"boolean"},"editable_in_portal":{"default":false,"type":"boolean"},"required_in_portal":{"default":false,"type":"boolean"},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"regex_pattern":{"type":["string","null"]},"options":{"description":"options for dropdown/multiselect","type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"relationship_target_type":{"description":"Lookup fields (Zendesk lookup relationship fields): the related record type, see App\\Lookup\\LookupTarget.","type":["string","null"]},"relationship_filter":{"description":"Lookup fields: conditions the related record must meet ({all: [...], any: [...]}, Zendesk\n`relationship_filter`), see App\\Lookup\\LookupFilter.","type":["object","null"],"additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}}}},"TicketField-field.write_field.create":{"type":"object","description":"Custom ticket field definition.","properties":{"key":{"pattern":"^([a-z][a-z0-9_]{1,63})$","description":"Stable machine key used in search/rules, e.g. \"order_number\".","type":"string"},"title":{"type":"string"},"type":{"type":"string","enum":["text","textarea","dropdown","multiselect","date","integer","decimal","checkbox","regex","credit_card","lookup","currency"]},"description":{"type":["string","null"]},"title_in_portal":{"description":"Title shown to customers in the help centre (Zendesk `title_in_portal`); null = title.","type":["string","null"]},"agent_description":{"description":"Description only agents see (Zendesk `agent_description`); `description` is shown to end users.","type":["string","null"]},"required_to_solve":{"description":"Required for agents when solving (Zendesk behaviour).","default":false,"type":"boolean"},"visible_in_portal":{"default":false,"type":"boolean"},"editable_in_portal":{"default":false,"type":"boolean"},"required_in_portal":{"default":false,"type":"boolean"},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"regex_pattern":{"type":["string","null"]},"options":{"description":"options for dropdown/multiselect","type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"relationship_target_type":{"description":"Lookup fields (Zendesk lookup relationship fields): the related record type, see App\\Lookup\\LookupTarget.","type":["string","null"]},"relationship_filter":{"description":"Lookup fields: conditions the related record must meet ({all: [...], any: [...]}, Zendesk\n`relationship_filter`), see App\\Lookup\\LookupFilter.","type":["object","null"],"additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}}},"required":["title"]},"TicketField.jsonld-field.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"key":{"pattern":"^([a-z][a-z0-9_]{1,63})$","description":"Stable machine key used in search/rules, e.g. \"order_number\".","type":"string"},"title":{"type":"string"},"type":{"type":"string","enum":["text","textarea","dropdown","multiselect","date","integer","decimal","checkbox","regex","credit_card","lookup","currency"]},"description":{"type":["string","null"]},"title_in_portal":{"description":"Title shown to customers in the help centre (Zendesk `title_in_portal`); null = title.","type":["string","null"]},"agent_description":{"description":"Description only agents see (Zendesk `agent_description`); `description` is shown to end users.","type":["string","null"]},"required_to_solve":{"description":"Required for agents when solving (Zendesk behaviour).","default":false,"type":"boolean"},"visible_in_portal":{"default":false,"type":"boolean"},"editable_in_portal":{"default":false,"type":"boolean"},"required_in_portal":{"default":false,"type":"boolean"},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"regex_pattern":{"type":["string","null"]},"options":{"description":"options for dropdown/multiselect","type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}},"relationship_target_type":{"description":"Lookup fields (Zendesk lookup relationship fields): the related record type, see App\\Lookup\\LookupTarget.","type":["string","null"]},"relationship_filter":{"description":"Lookup fields: conditions the related record must meet ({all: [...], any: [...]}, Zendesk\n`relationship_filter`), see App\\Lookup\\LookupFilter.","type":["object","null"],"additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}}},"required":["title"]}],"description":"Custom ticket field definition."},"TicketForm-form.read":{"type":"object","description":"Ticket form (Zendesk): which custom fields a kind of request uses, in order, plus conditional\nfields - e.g. \"Payout method = bank deposit\" shows \"Bank name\" and makes it required.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"},"display_name":{"description":"Name shown to customers in the help centre (defaults to name).","type":["string","null"]},"position":{"default":0,"type":"integer"},"active":{"default":true,"type":"boolean"},"default":{"default":false,"type":"boolean"},"end_user_visible":{"default":true,"type":"boolean"},"field_ids":{"description":"ticket field ids, in display order","type":"array","items":{"type":"string"}},"conditions":{"description":"agent conditions (Zendesk `agent_conditions`)","type":"array","items":{"type":"object","additionalProperties":{}}},"end_user_conditions":{"description":"help-centre conditions (Zendesk `end_user_conditions`); same shape as `conditions`","type":"array","items":{"type":"object","additionalProperties":{}}},"brand_ids":{"description":"brand ids the form is offered for (Zendesk `restricted_brand_ids`); empty = every brand","type":"array","items":{"type":"string"}}},"required":["name"]},"TicketForm-form.write":{"type":"object","description":"Ticket form (Zendesk): which custom fields a kind of request uses, in order, plus conditional\nfields - e.g. \"Payout method = bank deposit\" shows \"Bank name\" and makes it required.","required":["name"],"properties":{"name":{"type":"string"},"display_name":{"description":"Name shown to customers in the help centre (defaults to name).","type":["string","null"]},"position":{"default":0,"type":"integer"},"active":{"default":true,"type":"boolean"},"default":{"default":false,"type":"boolean"},"end_user_visible":{"default":true,"type":"boolean"},"field_ids":{"description":"ticket field ids, in display order","type":"array","items":{"type":"string"}},"conditions":{"description":"agent conditions (Zendesk `agent_conditions`)","type":"array","items":{"type":"object","additionalProperties":{}}},"end_user_conditions":{"description":"help-centre conditions (Zendesk `end_user_conditions`); same shape as `conditions`","type":"array","items":{"type":"object","additionalProperties":{}}},"brand_ids":{"description":"brand ids the form is offered for (Zendesk `restricted_brand_ids`); empty = every brand","type":"array","items":{"type":"string"}}}},"TicketForm-form.write.jsonMergePatch":{"type":"object","description":"Ticket form (Zendesk): which custom fields a kind of request uses, in order, plus conditional\nfields - e.g. \"Payout method = bank deposit\" shows \"Bank name\" and makes it required.","properties":{"name":{"type":"string"},"display_name":{"description":"Name shown to customers in the help centre (defaults to name).","type":["string","null"]},"position":{"default":0,"type":"integer"},"active":{"default":true,"type":"boolean"},"default":{"default":false,"type":"boolean"},"end_user_visible":{"default":true,"type":"boolean"},"field_ids":{"description":"ticket field ids, in display order","type":"array","items":{"type":"string"}},"conditions":{"description":"agent conditions (Zendesk `agent_conditions`)","type":"array","items":{"type":"object","additionalProperties":{}}},"end_user_conditions":{"description":"help-centre conditions (Zendesk `end_user_conditions`); same shape as `conditions`","type":"array","items":{"type":"object","additionalProperties":{}}},"brand_ids":{"description":"brand ids the form is offered for (Zendesk `restricted_brand_ids`); empty = every brand","type":"array","items":{"type":"string"}}}},"TicketForm-ticket.read_user.summary_group.summary_org.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["name"]},"TicketForm.jsonld-form.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"},"display_name":{"description":"Name shown to customers in the help centre (defaults to name).","type":["string","null"]},"position":{"default":0,"type":"integer"},"active":{"default":true,"type":"boolean"},"default":{"default":false,"type":"boolean"},"end_user_visible":{"default":true,"type":"boolean"},"field_ids":{"description":"ticket field ids, in display order","type":"array","items":{"type":"string"}},"conditions":{"description":"agent conditions (Zendesk `agent_conditions`)","type":"array","items":{"type":"object","additionalProperties":{}}},"end_user_conditions":{"description":"help-centre conditions (Zendesk `end_user_conditions`); same shape as `conditions`","type":"array","items":{"type":"object","additionalProperties":{}}},"brand_ids":{"description":"brand ids the form is offered for (Zendesk `restricted_brand_ids`); empty = every brand","type":"array","items":{"type":"string"}}},"required":["name"]}],"description":"Ticket form (Zendesk): which custom fields a kind of request uses, in order, plus conditional\nfields - e.g. \"Payout method = bank deposit\" shows \"Bank name\" and makes it required."},"TicketForm.jsonld-ticket.read_user.summary_group.summary_org.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"}},"required":["name"]}],"description":"Ticket form (Zendesk): which custom fields a kind of request uses, in order, plus conditional\nfields - e.g. \"Payout method = bank deposit\" shows \"Bank name\" and makes it required."},"TicketLayout-layout.read":{"type":"object","description":"Ticket layout (Zendesk Agent Workspace layout builder): which panes the ticket page shows, in\nwhich columns, how wide and whether they start collapsed, plus the properties-panel components.\nAssigned to ticket forms and/or contextual workspaces; one layout can be the default.\nApp\\Layout\\LayoutResolver picks: the ticket form's layout, then the workspace's, then the default.\nA form or workspace has at most one layout (assigning it elsewhere moves it).","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":120,"type":"string"},"description":{"maxLength":2000,"type":["string","null"]},"definition":{"description":"see App\\Layout\\LayoutDefinition","type":"array","items":{}},"default":{"default":false,"type":"boolean"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"},"ticket_form_ids":{"readOnly":true,"type":"array","items":{"type":"string"}},"workspace_ids":{"readOnly":true,"type":"array","items":{"type":"string"}}},"required":["name"]},"TicketLayout-layout.write":{"type":"object","description":"Ticket layout (Zendesk Agent Workspace layout builder): which panes the ticket page shows, in\nwhich columns, how wide and whether they start collapsed, plus the properties-panel components.\nAssigned to ticket forms and/or contextual workspaces; one layout can be the default.\nApp\\Layout\\LayoutResolver picks: the ticket form's layout, then the workspace's, then the default.\nA form or workspace has at most one layout (assigning it elsewhere moves it).","required":["name"],"properties":{"name":{"maxLength":120,"type":"string"},"description":{"maxLength":2000,"type":["string","null"]},"definition":{"description":"see App\\Layout\\LayoutDefinition","type":"array","items":{}},"default":{"default":false,"type":"boolean"},"ticket_forms":{"type":"array","items":{"type":"string","format":"iri-reference","example":"https://example.com/"}},"workspaces":{"type":"array","items":{"type":"string","format":"iri-reference","example":"https://example.com/"}}}},"TicketLayout-layout.write.jsonMergePatch":{"type":"object","description":"Ticket layout (Zendesk Agent Workspace layout builder): which panes the ticket page shows, in\nwhich columns, how wide and whether they start collapsed, plus the properties-panel components.\nAssigned to ticket forms and/or contextual workspaces; one layout can be the default.\nApp\\Layout\\LayoutResolver picks: the ticket form's layout, then the workspace's, then the default.\nA form or workspace has at most one layout (assigning it elsewhere moves it).","properties":{"name":{"maxLength":120,"type":"string"},"description":{"maxLength":2000,"type":["string","null"]},"definition":{"description":"see App\\Layout\\LayoutDefinition","type":"array","items":{}},"default":{"default":false,"type":"boolean"},"ticket_forms":{"type":"array","items":{"type":"string","format":"iri-reference","example":"https://example.com/"}},"workspaces":{"type":"array","items":{"type":"string","format":"iri-reference","example":"https://example.com/"}}}},"TicketLayout.jsonld-layout.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":120,"type":"string"},"description":{"maxLength":2000,"type":["string","null"]},"definition":{"description":"see App\\Layout\\LayoutDefinition","type":"array","items":{}},"default":{"default":false,"type":"boolean"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"},"ticket_form_ids":{"readOnly":true,"type":"array","items":{"type":"string"}},"workspace_ids":{"readOnly":true,"type":"array","items":{"type":"string"}}},"required":["name"]}],"description":"Ticket layout (Zendesk Agent Workspace layout builder): which panes the ticket page shows, in\nwhich columns, how wide and whether they start collapsed, plus the properties-panel components.\nAssigned to ticket forms and/or contextual workspaces; one layout can be the default.\nApp\\Layout\\LayoutResolver picks: the ticket form's layout, then the workspace's, then the default.\nA form or workspace has at most one layout (assigning it elsewhere moves it)."},"Trigger-rule.read":{"type":"object","description":"Event-driven rule: runs inside every ticket create/update, in position order.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"actions":{"type":"array","items":{"type":"object","additionalProperties":{}}},"category":{"description":"Zendesk trigger category (null = uncategorised, runs before every category).","type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"}},"required":["title"]},"Trigger-rule.write":{"type":"object","description":"Event-driven rule: runs inside every ticket create/update, in position order.","properties":{"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"actions":{"type":"array","items":{"type":"object","additionalProperties":{}}},"category":{"description":"Zendesk trigger category (null = uncategorised, runs before every category).","type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"}},"required":["title"]},"Trigger-rule.write.jsonMergePatch":{"type":"object","description":"Event-driven rule: runs inside every ticket create/update, in position order.","properties":{"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"actions":{"type":"array","items":{"type":"object","additionalProperties":{}}},"category":{"description":"Zendesk trigger category (null = uncategorised, runs before every category).","type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"}}},"Trigger.jsonld-rule.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"actions":{"type":"array","items":{"type":"object","additionalProperties":{}}},"category":{"description":"Zendesk trigger category (null = uncategorised, runs before every category).","type":["string","null"],"format":"iri-reference","example":"https://example.com/"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"}},"required":["title"]}],"description":"Event-driven rule: runs inside every ticket create/update, in position order."},"TriggerCategory-trigger_category.read":{"type":"object","description":"Zendesk trigger category: triggers run in category order, then in their position within the\ncategory. Uncategorised triggers run first (Zendesk puts them in an initial category).","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"title":{"maxLength":255,"type":"string"},"position":{"default":0,"type":"integer"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"}},"required":["title"]},"TriggerCategory-trigger_category.write":{"type":"object","description":"Zendesk trigger category: triggers run in category order, then in their position within the\ncategory. Uncategorised triggers run first (Zendesk puts them in an initial category).","required":["title"],"properties":{"title":{"maxLength":255,"type":"string"},"position":{"default":0,"type":"integer"}}},"TriggerCategory-trigger_category.write.jsonMergePatch":{"type":"object","description":"Zendesk trigger category: triggers run in category order, then in their position within the\ncategory. Uncategorised triggers run first (Zendesk puts them in an initial category).","properties":{"title":{"maxLength":255,"type":"string"},"position":{"default":0,"type":"integer"}}},"TriggerCategory.jsonld-trigger_category.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"title":{"maxLength":255,"type":"string"},"position":{"default":0,"type":"integer"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"}},"required":["title"]}],"description":"Zendesk trigger category: triggers run in category order, then in their position within the\ncategory. Uncategorised triggers run first (Zendesk puts them in an initial category)."},"User-api_token.read_api_token.created_user.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"description":"Primary email (lower-cased). Also present as an identity.","type":["string","null"]},"role":{"type":"string","enum":["end_user","agent","admin"]}}},"User-api_token.read_user.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"description":"Primary email (lower-cased). Also present as an identity.","type":["string","null"]},"role":{"type":"string","enum":["end_user","agent","admin"]}}},"User-audit.read_user.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"description":"Primary email (lower-cased). Also present as an identity.","type":["string","null"]},"role":{"type":"string","enum":["end_user","agent","admin"]}}},"User-comment.read_user.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"description":"Primary email (lower-cased). Also present as an identity.","type":["string","null"]},"role":{"type":"string","enum":["end_user","agent","admin"]}}},"User-group.read_group.summary_user.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"description":"Primary email (lower-cased). Also present as an identity.","type":["string","null"]},"role":{"type":"string","enum":["end_user","agent","admin"]}}},"User-ticket.read_user.summary_group.summary_org.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"description":"Primary email (lower-cased). Also present as an identity.","type":["string","null"]},"role":{"type":"string","enum":["end_user","agent","admin"]}}},"User-user.read_user.summary_org.summary_group.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"description":"Primary email (lower-cased). Also present as an identity.","type":["string","null"]},"role":{"type":"string","enum":["end_user","agent","admin"]},"custom_role":{"readOnly":true,"description":"Agent role (Agent, Light agent, custom). Null for end users and admins.","anyOf":[{"$ref":"#/components/schemas/Role-user.read_user.summary_org.summary_group.summary"},{"type":"null"}]},"locale":{"default":"en","type":"string"},"time_zone":{"default":"Africa/Johannesburg","type":"string"},"notes":{"type":["string","null"]},"details":{"type":["string","null"]},"verified":{"readOnly":true,"default":false,"type":"boolean"},"suspended":{"default":false,"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"last_login_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"},"identities":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/UserIdentity-user.read_user.summary_org.summary_group.summary"}},"groups":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/Group-user.read_user.summary_org.summary_group.summary"}},"permissions":{"readOnly":true,"type":"array","items":{"type":"string"}},"organizations":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/Organization-user.read_user.summary_org.summary_group.summary"}},"default_organization":{"readOnly":true,"anyOf":[{"$ref":"#/components/schemas/Organization-user.read_user.summary_org.summary_group.summary"},{"type":"null"}]}}},"User.UserInput":{"type":"object","properties":{"name":{"maxLength":255,"type":"string"},"email":{"format":"email","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"role":{"type":"string","enum":["end_user","agent","admin"]},"custom_role_id":{"format":"uuid","externalDocs":{"url":"https://schema.org/identifier"},"type":["string","null"]},"additional_emails":{"type":"array","items":{"type":"string"}},"phones":{"type":"array","items":{"type":"string"}},"organization_ids":{"type":"array","items":{"type":"string"}},"remove_organization_ids":{"type":"array","items":{"type":"string"}},"remove_identity_ids":{"description":"identity ids (emails/phones) to remove; the primary email cannot be removed","type":"array","items":{"type":"string"}},"group_ids":{"type":"array","items":{"type":"string"}},"locale":{"type":"string"},"time_zone":{"type":"string"},"notes":{"maxLength":10000,"type":["string","null"]},"details":{"maxLength":10000,"type":["string","null"]},"tags":{"type":"array","items":{"type":"string"}},"suspended":{"type":"boolean"}}},"User.UserInput.jsonMergePatch":{"type":"object","properties":{"name":{"maxLength":255,"type":"string"},"email":{"format":"email","externalDocs":{"url":"https://schema.org/email"},"type":["string","null"]},"role":{"type":"string","enum":["end_user","agent","admin"]},"custom_role_id":{"format":"uuid","externalDocs":{"url":"https://schema.org/identifier"},"type":["string","null"]},"additional_emails":{"type":"array","items":{"type":"string"}},"phones":{"type":"array","items":{"type":"string"}},"organization_ids":{"type":"array","items":{"type":"string"}},"remove_organization_ids":{"type":"array","items":{"type":"string"}},"remove_identity_ids":{"description":"identity ids (emails/phones) to remove; the primary email cannot be removed","type":"array","items":{"type":"string"}},"group_ids":{"type":"array","items":{"type":"string"}},"locale":{"type":"string"},"time_zone":{"type":"string"},"notes":{"maxLength":10000,"type":["string","null"]},"details":{"maxLength":10000,"type":["string","null"]},"tags":{"type":"array","items":{"type":"string"}},"suspended":{"type":"boolean"}}},"User.jsonld-api_token.read_api_token.created_user.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"description":"Primary email (lower-cased). Also present as an identity.","type":["string","null"]},"role":{"type":"string","enum":["end_user","agent","admin"]}}}]},"User.jsonld-api_token.read_user.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"description":"Primary email (lower-cased). Also present as an identity.","type":["string","null"]},"role":{"type":"string","enum":["end_user","agent","admin"]}}}]},"User.jsonld-audit.read_user.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"description":"Primary email (lower-cased). Also present as an identity.","type":["string","null"]},"role":{"type":"string","enum":["end_user","agent","admin"]}}}]},"User.jsonld-comment.read_user.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"description":"Primary email (lower-cased). Also present as an identity.","type":["string","null"]},"role":{"type":"string","enum":["end_user","agent","admin"]}}}]},"User.jsonld-group.read_group.summary_user.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"description":"Primary email (lower-cased). Also present as an identity.","type":["string","null"]},"role":{"type":"string","enum":["end_user","agent","admin"]}}}]},"User.jsonld-ticket.read_user.summary_group.summary_org.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"description":"Primary email (lower-cased). Also present as an identity.","type":["string","null"]},"role":{"type":"string","enum":["end_user","agent","admin"]}}}]},"User.jsonld-user.read_user.summary_org.summary_group.summary":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"type":"string"},"email":{"description":"Primary email (lower-cased). Also present as an identity.","type":["string","null"]},"role":{"type":"string","enum":["end_user","agent","admin"]},"custom_role":{"readOnly":true,"description":"Agent role (Agent, Light agent, custom). Null for end users and admins.","anyOf":[{"$ref":"#/components/schemas/Role.jsonld-user.read_user.summary_org.summary_group.summary"},{"type":"null"}]},"locale":{"default":"en","type":"string"},"time_zone":{"default":"Africa/Johannesburg","type":"string"},"notes":{"type":["string","null"]},"details":{"type":["string","null"]},"verified":{"readOnly":true,"default":false,"type":"boolean"},"suspended":{"default":false,"type":"boolean"},"tags":{"type":"array","items":{"type":"string"}},"last_login_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"},"identities":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/UserIdentity.jsonld-user.read_user.summary_org.summary_group.summary"}},"groups":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/Group.jsonld-user.read_user.summary_org.summary_group.summary"}},"permissions":{"readOnly":true,"type":"array","items":{"type":"string"}},"organizations":{"readOnly":true,"type":"array","items":{"$ref":"#/components/schemas/Organization.jsonld-user.read_user.summary_org.summary_group.summary"}},"default_organization":{"readOnly":true,"anyOf":[{"$ref":"#/components/schemas/Organization.jsonld-user.read_user.summary_org.summary_group.summary"},{"type":"null"}]}}}]},"UserField-people_field.read":{"type":"object","description":"Custom user field definition (Zendesk \"user fields\": WhatsApp number, Valtari ID, CSAT opt-out…).","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"key":{"pattern":"^([a-z][a-z0-9_]{1,63})$","description":"Stable machine key used in rules, search, import and the API (`user_fields.{key}`).","type":"string"},"title":{"maxLength":255,"type":"string"},"type":{"type":"string","enum":["text","textarea","dropdown","multiselect","date","integer","decimal","checkbox","regex","credit_card","lookup","currency"]},"description":{"maxLength":1000,"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"regex_pattern":{"type":["string","null"]},"options":{"description":"options for dropdown/multiselect","type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}}},"required":["title"]},"UserField-people_field.write.jsonMergePatch":{"type":"object","description":"Custom user field definition (Zendesk \"user fields\": WhatsApp number, Valtari ID, CSAT opt-out…).","properties":{"title":{"maxLength":255,"type":"string"},"description":{"maxLength":1000,"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"regex_pattern":{"type":["string","null"]},"options":{"description":"options for dropdown/multiselect","type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}}}},"UserField-people_field.write_people_field.create":{"type":"object","description":"Custom user field definition (Zendesk \"user fields\": WhatsApp number, Valtari ID, CSAT opt-out…).","properties":{"key":{"pattern":"^([a-z][a-z0-9_]{1,63})$","description":"Stable machine key used in rules, search, import and the API (`user_fields.{key}`).","type":"string"},"title":{"maxLength":255,"type":"string"},"type":{"type":"string","enum":["text","textarea","dropdown","multiselect","date","integer","decimal","checkbox","regex","credit_card","lookup","currency"]},"description":{"maxLength":1000,"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"regex_pattern":{"type":["string","null"]},"options":{"description":"options for dropdown/multiselect","type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}}},"required":["title"]},"UserField.jsonld-people_field.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"key":{"pattern":"^([a-z][a-z0-9_]{1,63})$","description":"Stable machine key used in rules, search, import and the API (`user_fields.{key}`).","type":"string"},"title":{"maxLength":255,"type":"string"},"type":{"type":"string","enum":["text","textarea","dropdown","multiselect","date","integer","decimal","checkbox","regex","credit_card","lookup","currency"]},"description":{"maxLength":1000,"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"regex_pattern":{"type":["string","null"]},"options":{"description":"options for dropdown/multiselect","type":"array","items":{"type":"object","additionalProperties":{"type":"string"}}}},"required":["title"]}],"description":"Custom user field definition (Zendesk \"user fields\": WhatsApp number, Valtari ID, CSAT opt-out…)."},"UserIdentity-user.read_user.summary_org.summary_group.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"type":{"type":"string","enum":["email","phone"]},"value":{"type":"string"},"primary":{"type":"boolean"},"verified":{"readOnly":true,"default":false,"type":"boolean"},"undeliverable":{"readOnly":true,"description":"Set when mail to this address hard-bounces.","default":false,"type":"boolean"}}},"UserIdentity.jsonld-user.read_user.summary_org.summary_group.summary":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"type":{"type":"string","enum":["email","phone"]},"value":{"type":"string"},"primary":{"type":"boolean"},"verified":{"readOnly":true,"default":false,"type":"boolean"},"undeliverable":{"readOnly":true,"description":"Set when mail to this address hard-bounces.","default":false,"type":"boolean"}}},"View-rule.read":{"type":"object","description":"View: shared (owner null; managing needs view.manage_shared, or view.manage_group when it is\nrestricted to the agent's groups) or personal to its owner (view.manage_personal).\nCollections are scoped by PersonalRuleScopeExtension.","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"shared":{"description":"Write-only switch: false makes it personal to the current agent (set by PersonalRuleProcessor).","type":["boolean","null"]},"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"columns":{"description":"table columns, e.g. [\"status\",\"subject\",\"requester\",\"updated_at\",\"assignee\",\"priority\"]","default":["status","subject","requester","created_at","updated_at","group","assignee","priority"],"type":"array","items":{"type":"string"}},"sort_by":{"default":"updated_at","type":"string"},"sort_order":{"default":"desc","type":"string"},"group_by":{"description":"Zendesk \"Group by\" (execution.group_by): status, priority, type, group, assignee, requester,\norganization, brand, form or \"custom_fields.<key>\" of a drop-down field; null = not grouped.","type":["string","null"]},"group_order":{"default":"asc","type":"string"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"},"restricted_groups":{"type":"array","items":{"type":"string","format":"iri-reference","example":"https://example.com/"}}},"required":["title"]},"View-rule.write":{"type":"object","description":"View: shared (owner null; managing needs view.manage_shared, or view.manage_group when it is\nrestricted to the agent's groups) or personal to its owner (view.manage_personal).\nCollections are scoped by PersonalRuleScopeExtension.","properties":{"shared":{"description":"Write-only switch: false makes it personal to the current agent (set by PersonalRuleProcessor).","type":["boolean","null"]},"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"columns":{"description":"table columns, e.g. [\"status\",\"subject\",\"requester\",\"updated_at\",\"assignee\",\"priority\"]","default":["status","subject","requester","created_at","updated_at","group","assignee","priority"],"type":"array","items":{"type":"string"}},"sort_by":{"default":"updated_at","type":"string"},"sort_order":{"default":"desc","type":"string"},"group_by":{"description":"Zendesk \"Group by\" (execution.group_by): status, priority, type, group, assignee, requester,\norganization, brand, form or \"custom_fields.<key>\" of a drop-down field; null = not grouped.","type":["string","null"]},"group_order":{"default":"asc","type":"string"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"restricted_groups":{"type":"array","items":{"type":"string","format":"iri-reference","example":"https://example.com/"}}},"required":["title"]},"View-rule.write.jsonMergePatch":{"type":"object","description":"View: shared (owner null; managing needs view.manage_shared, or view.manage_group when it is\nrestricted to the agent's groups) or personal to its owner (view.manage_personal).\nCollections are scoped by PersonalRuleScopeExtension.","properties":{"shared":{"description":"Write-only switch: false makes it personal to the current agent (set by PersonalRuleProcessor).","type":["boolean","null"]},"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"columns":{"description":"table columns, e.g. [\"status\",\"subject\",\"requester\",\"updated_at\",\"assignee\",\"priority\"]","default":["status","subject","requester","created_at","updated_at","group","assignee","priority"],"type":"array","items":{"type":"string"}},"sort_by":{"default":"updated_at","type":"string"},"sort_order":{"default":"desc","type":"string"},"group_by":{"description":"Zendesk \"Group by\" (execution.group_by): status, priority, type, group, assignee, requester,\norganization, brand, form or \"custom_fields.<key>\" of a drop-down field; null = not grouped.","type":["string","null"]},"group_order":{"default":"asc","type":"string"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"restricted_groups":{"type":"array","items":{"type":"string","format":"iri-reference","example":"https://example.com/"}}}},"View-rule.write_assignment_rule.write":{"type":"object","description":"View: shared (owner null; managing needs view.manage_shared, or view.manage_group when it is\nrestricted to the agent's groups) or personal to its owner (view.manage_personal).\nCollections are scoped by PersonalRuleScopeExtension.","properties":{"shared":{"description":"Write-only switch: false makes it personal to the current agent (set by PersonalRuleProcessor).","type":["boolean","null"]},"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"columns":{"description":"table columns, e.g. [\"status\",\"subject\",\"requester\",\"updated_at\",\"assignee\",\"priority\"]","default":["status","subject","requester","created_at","updated_at","group","assignee","priority"],"type":"array","items":{"type":"string"}},"sort_by":{"default":"updated_at","type":"string"},"sort_order":{"default":"desc","type":"string"},"group_by":{"description":"Zendesk \"Group by\" (execution.group_by): status, priority, type, group, assignee, requester,\norganization, brand, form or \"custom_fields.<key>\" of a drop-down field; null = not grouped.","type":["string","null"]},"group_order":{"default":"asc","type":"string"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"restricted_groups":{"type":"array","items":{"type":"string","format":"iri-reference","example":"https://example.com/"}}},"required":["title"]},"View.jsonld-rule.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"shared":{"description":"Write-only switch: false makes it personal to the current agent (set by PersonalRuleProcessor).","type":["boolean","null"]},"conditions":{"default":{"all":[],"any":[]},"type":"object","additionalProperties":{"type":"array","items":{"type":"object","additionalProperties":{}}}},"columns":{"description":"table columns, e.g. [\"status\",\"subject\",\"requester\",\"updated_at\",\"assignee\",\"priority\"]","default":["status","subject","requester","created_at","updated_at","group","assignee","priority"],"type":"array","items":{"type":"string"}},"sort_by":{"default":"updated_at","type":"string"},"sort_order":{"default":"desc","type":"string"},"group_by":{"description":"Zendesk \"Group by\" (execution.group_by): status, priority, type, group, assignee, requester,\norganization, brand, form or \"custom_fields.<key>\" of a drop-down field; null = not grouped.","type":["string","null"]},"group_order":{"default":"asc","type":"string"},"title":{"maxLength":255,"default":"","type":"string"},"description":{"type":["string","null"]},"active":{"default":true,"type":"boolean"},"position":{"default":0,"type":"integer"},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"},"restricted_groups":{"type":"array","items":{"type":"string","format":"iri-reference","example":"https://example.com/"}}},"required":["title"]}],"description":"View: shared (owner null; managing needs view.manage_shared, or view.manage_group when it is\nrestricted to the agent's groups) or personal to its owner (view.manage_personal).\nCollections are scoped by PersonalRuleScopeExtension."},"Webhook-webhook.read":{"type":"object","description":"Webhooks: signed HTTP callbacks for ticket events and trigger/automation actions. Every request carries `X-Desk-Timestamp` and `X-Desk-Signature` = base64(HMAC-SHA256(secret, timestamp + \".\" + body)).","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":100,"example":"CRM ticket sync","type":"string"},"description":{"type":["string","null"]},"endpoint":{"format":"uri","externalDocs":{"url":"https://schema.org/url"},"example":"https://hooks.example.com/desk","type":"string"},"method":{"enum":["POST","PUT","PATCH"],"default":"POST","type":"string"},"active":{"default":true,"type":"boolean"},"subscriptions":{"minItems":1,"description":"Event types (`ticket.created`, `ticket.status_changed`, …) and/or `conditional_ticket_events` (called by triggers and automations).","default":["conditional_ticket_events"],"example":["ticket.created","ticket.status_changed"],"type":"array","items":{"type":"string"}},"body_template":{"maxLength":65536,"description":"Custom JSON body for event deliveries (placeholders such as `{{ticket.id}}`, `{{ticket.status}}`, `{{ticket.requester.email}}`; values are JSON-escaped). Null sends the standard envelope.","example":"{\"ticket_id\": \"{{ticket.id}}\", \"status\": \"{{ticket.status}}\"}","type":["string","null"]},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"}},"required":["name","endpoint"]},"Webhook-webhook.write":{"type":"object","description":"Webhooks: signed HTTP callbacks for ticket events and trigger/automation actions. Every request carries `X-Desk-Timestamp` and `X-Desk-Signature` = base64(HMAC-SHA256(secret, timestamp + \".\" + body)).","required":["name","endpoint"],"properties":{"name":{"maxLength":100,"example":"CRM ticket sync","type":"string"},"description":{"type":["string","null"]},"endpoint":{"format":"uri","externalDocs":{"url":"https://schema.org/url"},"example":"https://hooks.example.com/desk","type":"string"},"method":{"enum":["POST","PUT","PATCH"],"default":"POST","type":"string"},"active":{"default":true,"type":"boolean"},"subscriptions":{"minItems":1,"description":"Event types (`ticket.created`, `ticket.status_changed`, …) and/or `conditional_ticket_events` (called by triggers and automations).","default":["conditional_ticket_events"],"example":["ticket.created","ticket.status_changed"],"type":"array","items":{"type":"string"}},"body_template":{"maxLength":65536,"description":"Custom JSON body for event deliveries (placeholders such as `{{ticket.id}}`, `{{ticket.status}}`, `{{ticket.requester.email}}`; values are JSON-escaped). Null sends the standard envelope.","example":"{\"ticket_id\": \"{{ticket.id}}\", \"status\": \"{{ticket.status}}\"}","type":["string","null"]}}},"Webhook-webhook.write.jsonMergePatch":{"type":"object","description":"Webhooks: signed HTTP callbacks for ticket events and trigger/automation actions. Every request carries `X-Desk-Timestamp` and `X-Desk-Signature` = base64(HMAC-SHA256(secret, timestamp + \".\" + body)).","properties":{"name":{"maxLength":100,"example":"CRM ticket sync","type":"string"},"description":{"type":["string","null"]},"endpoint":{"format":"uri","externalDocs":{"url":"https://schema.org/url"},"example":"https://hooks.example.com/desk","type":"string"},"method":{"enum":["POST","PUT","PATCH"],"default":"POST","type":"string"},"active":{"default":true,"type":"boolean"},"subscriptions":{"minItems":1,"description":"Event types (`ticket.created`, `ticket.status_changed`, …) and/or `conditional_ticket_events` (called by triggers and automations).","default":["conditional_ticket_events"],"example":["ticket.created","ticket.status_changed"],"type":"array","items":{"type":"string"}},"body_template":{"maxLength":65536,"description":"Custom JSON body for event deliveries (placeholders such as `{{ticket.id}}`, `{{ticket.status}}`, `{{ticket.requester.email}}`; values are JSON-escaped). Null sends the standard envelope.","example":"{\"ticket_id\": \"{{ticket.id}}\", \"status\": \"{{ticket.status}}\"}","type":["string","null"]}}},"Webhook-webhook_delivery.read":{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":100,"example":"CRM ticket sync","type":"string"}},"required":["name"]},"Webhook.jsonld-webhook.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":100,"example":"CRM ticket sync","type":"string"},"description":{"type":["string","null"]},"endpoint":{"format":"uri","externalDocs":{"url":"https://schema.org/url"},"example":"https://hooks.example.com/desk","type":"string"},"method":{"enum":["POST","PUT","PATCH"],"default":"POST","type":"string"},"active":{"default":true,"type":"boolean"},"subscriptions":{"minItems":1,"description":"Event types (`ticket.created`, `ticket.status_changed`, …) and/or `conditional_ticket_events` (called by triggers and automations).","default":["conditional_ticket_events"],"example":["ticket.created","ticket.status_changed"],"type":"array","items":{"type":"string"}},"body_template":{"maxLength":65536,"description":"Custom JSON body for event deliveries (placeholders such as `{{ticket.id}}`, `{{ticket.status}}`, `{{ticket.requester.email}}`; values are JSON-escaped). Null sends the standard envelope.","example":"{\"ticket_id\": \"{{ticket.id}}\", \"status\": \"{{ticket.status}}\"}","type":["string","null"]},"created_at":{"readOnly":true,"type":"string","format":"date-time"},"updated_at":{"readOnly":true,"type":"string","format":"date-time"}},"required":["name","endpoint"]}],"description":"Webhooks: signed HTTP callbacks for ticket events and trigger/automation actions. Every request carries `X-Desk-Timestamp` and `X-Desk-Signature` = base64(HMAC-SHA256(secret, timestamp + \".\" + body))."},"Webhook.jsonld-webhook_delivery.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"readOnly":true,"type":"string","format":"uuid"},"name":{"maxLength":100,"example":"CRM ticket sync","type":"string"}},"required":["name"]}],"description":"Webhooks: signed HTTP callbacks for ticket events and trigger/automation actions. Every request carries `X-Desk-Timestamp` and `X-Desk-Signature` = base64(HMAC-SHA256(secret, timestamp + \".\" + body))."},"WebhookDelivery-webhook_delivery.read":{"type":"object","description":"Webhook delivery log (request/response excerpts with PII removed). Replay with POST /api/webhook_deliveries/{id}/replay.","properties":{"id":{"type":["string","null"],"format":"uuid"},"webhook":{"$ref":"#/components/schemas/Webhook-webhook_delivery.read"},"event_type":{"example":"ticket.status_changed","type":"string"},"ticket_id":{"type":["string","null"],"format":"uuid"},"request_excerpt":{"readOnly":true,"type":"string"},"status":{"readOnly":true,"default":"pending","type":"string","enum":["pending","succeeded","retrying","failed"]},"attempts":{"readOnly":true,"default":0,"type":"integer"},"response_status":{"readOnly":true,"type":["integer","null"]},"response_excerpt":{"readOnly":true,"type":["string","null"]},"error":{"readOnly":true,"type":["string","null"]},"duration_ms":{"readOnly":true,"type":["integer","null"]},"last_attempt_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"next_attempt_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"replay_of":{"readOnly":true,"type":["string","null"],"format":"uuid"},"test":{"readOnly":true,"default":false,"type":"boolean"},"created_at":{"readOnly":true,"type":"string","format":"date-time"}}},"WebhookDelivery.jsonld-webhook_delivery.read":{"allOf":[{"$ref":"#/components/schemas/HydraItemBaseSchema"},{"type":"object","properties":{"id":{"type":["string","null"],"format":"uuid"},"webhook":{"$ref":"#/components/schemas/Webhook.jsonld-webhook_delivery.read"},"event_type":{"example":"ticket.status_changed","type":"string"},"ticket_id":{"type":["string","null"],"format":"uuid"},"request_excerpt":{"readOnly":true,"type":"string"},"status":{"readOnly":true,"default":"pending","type":"string","enum":["pending","succeeded","retrying","failed"]},"attempts":{"readOnly":true,"default":0,"type":"integer"},"response_status":{"readOnly":true,"type":["integer","null"]},"response_excerpt":{"readOnly":true,"type":["string","null"]},"error":{"readOnly":true,"type":["string","null"]},"duration_ms":{"readOnly":true,"type":["integer","null"]},"last_attempt_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"next_attempt_at":{"readOnly":true,"type":["string","null"],"format":"date-time"},"replay_of":{"readOnly":true,"type":["string","null"],"format":"uuid"},"test":{"readOnly":true,"default":false,"type":"boolean"},"created_at":{"readOnly":true,"type":"string","format":"date-time"}}}],"description":"Webhook delivery log (request/response excerpts with PII removed). Replay with POST /api/webhook_deliveries/{id}/replay."}},"responses":{},"parameters":{},"examples":{},"requestBodies":{},"headers":{},"securitySchemes":{"bearer":{"type":"http","description":"Keycloak access token (agents) or personal API token `desk_…` (integrations).","scheme":"bearer"}}},"security":[{"bearer":[]}],"tags":[{"name":"CustomerContext","description":"Resource 'CustomerContext' operations."},{"name":"EmailTemplate","description":"Notification templates: built-in defaults with optional admin overrides (sandboxed Twig)."},{"name":"RealtimeToken","description":"Short-lived Mercure subscriber token scoped to the topics this user may receive."},{"name":"ApiToken","description":"Personal API tokens for integrations. Send them as `Authorization: Bearer desk_…`. Agents see their own tokens; admins see everyone's."},{"name":"AssignmentRule","description":"Guided assignment rule (the Playlist replacement). For its agents it limits which tickets\nthey may receive (conditions: group, form, tags, priority…), which views they may play,\nhow many open tickets they may hold, and optionally auto-assigns new tickets that match\n(round-robin or least-loaded, only to agents who are online).\n\nAgents without any active rule are unrestricted (Zendesk default)."},{"name":"Attachment","description":"A file stored privately in S3. Uploaded first (unattached, owned by the uploader), then\nlinked to a comment when the reply is submitted. Inbound email attachments are created attached."},{"name":"AutoMergeRule","description":"Auto merge (the \"Auto Merge\" app): a new ticket that matches the conditions and has the same\nrequester and the same subject (or the same value in a reference field) as an unsolved ticket\ncreated within the last N minutes is merged into the oldest such ticket."},{"name":"Automation","description":"Time-based rule: evaluated hourly against tickets matching its conditions (at most once per ticket per update)."},{"name":"Brand","description":"Minimal brand (see docs/architecture.md §17 Q2): help-centre identity + support addresses."},{"name":"BusinessSchedule","description":"Business hours for SLA targets: weekly opening intervals in a timezone, plus holidays."},{"name":"ContextualWorkspace","description":"Contextual workspace (Zendesk admin.workspaces): the first active workspace (by position)\nwhose conditions match a ticket decides which shared macros, which ticket form layout and\nwhich sidebar apps the agent sees on it (e.g. one workspace for billing, one for technical support)."},{"name":"CsatReason","description":"Admin-configured CSAT reason (Zendesk csat_reason_code), offered on the rating page when the\nrequester rates bad. Inactive reasons stay on old ratings but can't be picked any more."},{"name":"CustomAgentStatus","description":"Admin-defined agent status (Zendesk custom agent statuses), e.g. \"Lunch\" or \"Training\" on top of\nAway, \"Phones only\" on top of Online. Routing and chat only look at the base status; the name tells\nthe team what the agent is doing. Agents pick active ones in the top bar. Deleting one puts its\nagents back on the plain base status."},{"name":"DynamicContentItem","description":"Zendesk dynamic content: `{{dc.name}}` in notification templates, macros and triggers renders the\nvariant for the requester's locale, falling back to the language (\"pt\" for \"pt-BR\"), then to the\ndefault locale. Variants are stored as {locale: text}."},{"name":"Group","description":"Resource 'Group' operations."},{"name":"Holiday","description":"A closed day of a business schedule; recurring holidays repeat every year on the same date."},{"name":"Macro","description":"Macro: shared (owner null; managing needs macro.manage_shared, or macro.manage_group when it is\nrestricted to the agent's groups) or personal to its owner (macro.manage_personal).\nCollections are scoped by PersonalRuleScopeExtension."},{"name":"Organization","description":"Resource 'Organization' operations."},{"name":"OrganizationField","description":"Custom organization field definition (Zendesk \"organization fields\")."},{"name":"RedactionRule","description":"One PII auto-redaction rule applied to every incoming comment and subject (P10).\nBuilt-in kinds (card number, passport and the regional pack detectors: SA ID, IBAN, EU national\nIDs, US SSN, JMBG, OIB) are validated detectors that can only be switched on or off; PIN and\ncustom kinds are admin-editable regular expressions. Only card numbers are on by default."},{"name":"RetentionPolicy","description":"Data retention (P10): closed tickets last updated more than N months ago are deleted or\nanonymised by the daily RunRetentionPolicies job. Optionally limited to a brand and/or group."},{"name":"Role","description":"Agent role: built-in (\"Agent\", \"Light agent\") or custom. Admins don't need one."},{"name":"SlaPolicy","description":"An SLA policy (Zendesk): ordered, the first active policy whose conditions match the ticket\napplies. Targets are per metric and priority, in minutes, in business or calendar hours."},{"name":"SupportAddress","description":"Inbound/outbound support email address (\"received at\"), routed to a brand, default group and\ndefault form. `is_default` marks the brand's default sending address (Zendesk: one per brand).\nForwarding is verified by mailing a token to the address and receiving it back."},{"name":"SuspendedTicket","description":"Email that was held back (spam, auto-reply, unknown sender…) for an agent to recover or delete."},{"name":"Tag","description":"Tag catalogue (autocomplete + usage). Tickets store tags as a jsonb string list\n(GIN-indexed); this table is kept in sync by TagCatalog."},{"name":"Ticket","description":"Ticket aggregate. Mutate ONLY through App\\Ticket\\TicketService, which records the TicketAudit.\nSetters below are deliberately \"apply*\"-named and used by TicketChangeApplier."},{"name":"TicketAudit","description":"Immutable record of one ticket update (append-only; enforced by a DB trigger).\nHolds the events (field changes, comment, notifications…) that happened in that update."},{"name":"TicketComment","description":"Public reply or internal note. Immutable once written (Zendesk allows redaction only)."},{"name":"TicketField","description":"Custom ticket field definition."},{"name":"TicketForm","description":"Ticket form (Zendesk): which custom fields a kind of request uses, in order, plus conditional\nfields - e.g. \"Payout method = bank deposit\" shows \"Bank name\" and makes it required."},{"name":"TicketLayout","description":"Ticket layout (Zendesk Agent Workspace layout builder): which panes the ticket page shows, in\nwhich columns, how wide and whether they start collapsed, plus the properties-panel components.\nAssigned to ticket forms and/or contextual workspaces; one layout can be the default.\nApp\\Layout\\LayoutResolver picks: the ticket form's layout, then the workspace's, then the default.\nA form or workspace has at most one layout (assigning it elsewhere moves it)."},{"name":"Trigger","description":"Event-driven rule: runs inside every ticket create/update, in position order."},{"name":"TriggerCategory","description":"Zendesk trigger category: triggers run in category order, then in their position within the\ncategory. Uncategorised triggers run first (Zendesk puts them in an initial category)."},{"name":"User","description":"Resource 'User' operations."},{"name":"UserField","description":"Custom user field definition (Zendesk \"user fields\": WhatsApp number, Valtari ID, CSAT opt-out…)."},{"name":"View","description":"View: shared (owner null; managing needs view.manage_shared, or view.manage_group when it is\nrestricted to the agent's groups) or personal to its owner (view.manage_personal).\nCollections are scoped by PersonalRuleScopeExtension."},{"name":"Webhook","description":"Webhooks: signed HTTP callbacks for ticket events and trigger/automation actions. Every request carries `X-Desk-Timestamp` and `X-Desk-Signature` = base64(HMAC-SHA256(secret, timestamp + \".\" + body))."},{"name":"WebhookDelivery","description":"Webhook delivery log (request/response excerpts with PII removed). Replay with POST /api/webhook_deliveries/{id}/replay."}],"webhooks":{}}