{"openapi":"3.1.0","info":{"title":"PATCH /api/v1/counterparty-aliases/{alias_id}","version":"1.0.0","description":"Update a counterparty alias"},"servers":[{"url":"https://api.ondayzero.com","description":"Production"}],"paths":{"/api/v1/counterparty-aliases/{alias_id}":{"patch":{"tags":["counterparty-aliases"],"summary":"Update a counterparty alias","description":"Change the display name on an existing counterparty alias.","operationId":"update_counterparty_alias_api_v1_counterparty_aliases__alias_id__patch","parameters":[{"name":"alias_id","in":"path","required":true,"schema":{"type":"string","title":"Alias Id"}},{"name":"authorization","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization"}},{"name":"x-business-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Business-Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CounterpartyAliasUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SuccessEnvelope_CounterpartyAliasResponse_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"CounterpartyAliasResponse":{"properties":{"id":{"type":"string","title":"Id"},"business_id":{"type":"string","title":"Business Id"},"registry_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry Id"},"counterparty_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty Name"},"display_name":{"type":"string","title":"Display Name"},"canonical_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Canonical Name","description":"Canonical registry name the alias overrides, when linked. Display-only hydration; not stored on the alias row."},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","business_id","registry_id","counterparty_name","display_name","created_at","updated_at"],"title":"CounterpartyAliasResponse","description":"Public shape of a counterparty alias."},"CounterpartyAliasUpdate":{"properties":{"display_name":{"type":"string","maxLength":500,"minLength":1,"title":"Display Name","description":"New display name for this counterparty."}},"type":"object","required":["display_name"],"title":"CounterpartyAliasUpdate","description":"Patch payload — only the display name is mutable."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"SuccessEnvelope_CounterpartyAliasResponse_":{"properties":{"success":{"type":"boolean","title":"Success","default":true},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code"},"data":{"anyOf":[{"$ref":"#/components/schemas/CounterpartyAliasResponse"},{"type":"null"}]}},"additionalProperties":true,"type":"object","title":"SuccessEnvelope[CounterpartyAliasResponse]"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"API Token","description":"API token authentication. Format: `Bearer dz_...`"}}},"security":[{"BearerAuth":[]}]}