チケットとは、顧客からのサポートリクエストのことです。チケットエンドポイントを使用することにより、チケットデータを管理したり、HubSpotと他のシステムとの間で同期したりできます。
POST
リクエストを/crm/v3/objects/tickets
に送信します。
リクエスト内のプロパティーオブジェクトにチケットデータを含めます。また、 関連付けオブジェクトを追加して、新しいチケットを既存のレコード(コンタクト、会社など)やアクティビティー(ミーティング、メモなど)に関連付けることもできます。
subject
(チケット名)およびhs_pipeline_stage
(チケットのステータス)の各プロパティーをリクエストに含める必要があります。また、複数のパイプラインがある場合はhs_pipeline
も含めます。パイプラインが指定されていない場合は、既定のパイプラインが使用されます。
利用可能な全てのプロパティーを確認するには、GET
リクエストを/crm/v3/properties/tickets
に送信して、アカウントのチケットプロパティーのリストを取得します。詳しくはプロパティーAPIをご参照ください。
パラメーター | 説明 |
---|---|
to | チケットを関連付けるレコードまたはアクティビティー。一意のid 値で指定します。 |
types | チケットとレコード/アクティビティーの間の関連付けのタイプ。associationCategory およびassociationTypeId を含めます。既定の関連付けタイプIDはこちらのページに記載されています。または、関連付けAPIを使用して、カスタム関連付けタイプ(ラベル)の値を取得することもできます。 |
GET
リクエストを/crm/v3/objects/tickets/{ticketId}
に送信します。GET
リクエストを/crm/v3/objects/tickets
に送信します。パラメーター | 説明 |
---|---|
properties | レスポンスで返されるプロパティーのカンマ区切りのリスト。リクエスト対象のチケットレコードで、指定したプロパティーに値が設定されていない場合、そのプロパティーはレスポンスに含まれません。 |
propertiesWithHistory | レスポンスで返される現在および過去のプロパティーのカンマ区切りのリスト。リクエスト対象のチケットレコードで、指定したプロパティーに値が設定されていない場合、そのプロパティーはレスポンスに含まれません。 |
associations | 関連付けられているIDが取得されるオブジェクトのカンマ区切りのリスト。存在しない関連付けを指定した場合、その関連付けはレスポンスで返されません。詳しくは関連付けAPIをご参照ください。 |
POST
リクエストをcrm/v3/objects/tickets/batch/read
に送信します。このバッチエンドポイントは関連付けを取得できません。詳しくは、関連付けAPIを使用して関連付けを一括読み取りする方法をご参照ください。idProperty
パラメーターを使用し、カスタムの固有IDプロパティーを指定して、チケットを取得することもできます。既定で、リクエストのid
値はレコードID(hs_object_id
)を参照するため、レコードIDを使](/guides/api/crm/properties#固有idプロパティーを作成する)用して取得する場合はidProperty
パラメーターは不要です。固有のカスタム値プロパティーを使用してチケットを取得する場合は、idProperty
パラメーターを含める必要があります。
例えば、チケットを一括で取得する場合のリクエストは、次のいずれかのようになります。
プロパティーの現在の値と過去の値を含むチケットを取得する場合のリクエストは、次のようになります。
PATCH
リクエストを/crm/v3/objects/tickets/{ticketId}
に送信します。POST
リクエストを/crm/v3/objects/tickets/batch/update
に送信します。リクエストの本文に、チケットの識別子と更新するプロパティーを含む配列を含めます。PUT
リクエストを/crm/v3/objects/tickets/{ticketId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
に送信します。
associationTypeId
値を取得するには、この既定値リストを参照するか、GET
リクエストを/crm/v4/associations/{fromObjectType}/{toObjectType}/labels
に送信します。DELETE
リクエストを/crm/v3/objects/tickets/{ticketId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}
のURLに送信します。
hs_pinned_engagement_id
フィールドを含めると、APIを介してチケットレコードでアクティビティーをピン留めできます。フィールドに、ピン留めするアクティビティーのid
を含めます。これは、エンゲージメントAPIを介して取得できます。レコードごとに1つのアクティビティーをピン留めすることができます。ただし、そのアクティビティーはピン留めを行う前にチケットに関連付けられている必要があります。
チケット内のピン留めされたアクティビティーを設定または更新するリクエストは、次のようになります。
DELETE
リクエストを/crm/v3/objects/tickets/{ticketId}
に送信します。
チケットの削除の詳細については、 リファレンスドキュメントをご確認ください。