🌻

Zendeskの組織(Organization)名に関する制約

1 min read

Zendeskで組織を新規に作成する時、以下の制約がある。

組織名は一意

これはヘルプに記載されている。

https://support.zendesk.com/hc/ja/articles/203661976

組織名は一意である必要があります。

$ curl https://{subdomain}.zendesk.com/api/v2/organizations/{id}.json \
  -u {email_address}:{password}
| jq '.organization.name'

"norii-test1-corp."

という組織がある状態で、同じ名前で組織を作ろうとすると

$ curl https://{subdomain}.zendesk.com/api/v2/organizations.json \
  -H "Content-Type: application/json" -d '{"organization": {"name": "norii-test1-corp."}}' \
  -u {email_address}:{password}

{
  "error": "RecordInvalid",
  "description": "Record validation errors",
  "details": {
    "name": [
      {
        "description": "名前: norii-test1-corp.は既に使用されています",
        "error": "DuplicateValue"
      }
    ]
  }
}

と、エラーになる。

組織名に「|」(バーティカルライン、パイプ、0x7C)は使えない

これはドキュメントやネット記事漁ったがでてこなかった。
組織名に「|」を含んだ文字を入れるとエラーになる。

$ curl https://{subdomain}.zendesk.com/api/v2/organizations.json \
  -H "Content-Type: application/json" -d '{"organization": {"name": "norii-pipe|corp."}}' \
  -u {email_address}:{password}
  
{
  "error": "RecordInvalid",
  "description": "Record validation errors",
  "details": {
    "name": [
      {
        "description": "名前: 「|」の文字を含まないようにしてください。",
        "error": "InvalidValue"
      }
    ]
  }
}

Discussion

ログインするとコメントできます