チケット

HubSpotでは、チケットは顧客からのサポート依頼を表します。チケットは、パイプラインステータスでサポートプロセスを通して、クローズされるまで追跡されます。チケットエンドポイントを使用することにより、チケットレコードを作成および管理したり、HubSpotと他のシステムの間でチケットデータを同期したりできます。 

オブジェクト、レコード、プロパティー、および関連付けAPIの詳細については、「CRMについて」のガイドをご確認ください。HubSpotのオブジェクトとレコードに関する一般的な情報については、CRMデータベースを管理する方法をご確認ください。

新しいチケットを作成するには、POSTリクエストを/crm/v3/objects/ticketsに送信します。

リクエスト内のpropertiesオブジェクトにチケットデータを含めます。また、associationsオブジェクトを追加して、新しいチケットを既存のレコード（コンタクト、会社など）やアクティビティー（ミーティング、メモなど）に関連付けることもできます。

チケットの詳細は、チケットプロパティーに保存されます。HubSpotの既定のチケットプロパティーがありますが、カスタムプロパティーを作成することもできます。

新しいチケットを作成する際は、subject（チケット名）およびhs_pipeline_stage（チケットのステータス）を含める必要があります。また、複数のパイプラインがある場合はhs_pipelineも含めます。パイプラインが指定されていない場合は、既定のパイプラインが使用されます。

利用可能な全てのプロパティーを確認するには、GETリクエストを/crm/v3/properties/ticketsに送信して、アカウントのチケットプロパティーのリストを取得します。詳しくはプロパティーAPIをご参照ください。

例えば、新しいチケットを作成する場合、リクエストの内容は次のようになります。

新しいチケットを作成する際に、そのチケットを既存のレコードやアクティビティーに関連付けることもできます。associationsオブジェクトに、次のフィールドを含めます。

labelフィールドを含めて、関連付けを説明する定義済み関連付けラベルを割り当てることもできます。レコードを関連付ける方法については関連付けAPIをご確認ください。

例えば、新しいチケットを既存のコンタクトと会社に関連付ける場合、リクエストの内容は次のようになります。

チケットを個別に、または一括で取得できます。個々のチケットを取得するには、GETリクエストを/crm/v3/objects/tickets/{ticketId}に送信します。

全てのチケットのリストを取得するには、GETリクエストを/crm/v3/objects/ticketsに送信します。

どちらのエンドポイントに対しても、リクエストのURLに次のクエリーパラメーターを含めることができます。 

チケットレコードを取得する方法については、この記事の上部にある［エンドポイント］タブをクリックしてください。

チケットレコードを個別に、または一括で更新できます。既存チケットの場合、APIを介してチケットレコードを更新するために使用可能な一意の値は、チケットIDです。

チケットIDを基準の個々のチケットレコードを更新するには、PATCHリクエストを/crm/v3/objects/tickets/{ticketId}に送信します。リクエストには、更新するデータを含めます。

チケットを他のCRMレコードまたはアクティビティーに関連付けるには、PUTリクエストを/crm/v3/objects/tickets/{ticketId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}に送信します。

詳しくは関連付けAPIをご確認ください。

チケットレコードと他のレコードまたはアクティビティーの関連付けを削除するには、DELETEリクエストを/crm/v3/objects/tickets/{ticketId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}に送信します。