SharingAgreements
Create, update, delete, and query SharingAgreements in Zendesk.
Table Specific Information
Select
The following queries are processed server side while other filters are processed client side within the driver.SELECT * FROM SharingAgreements WHERE Id = '123'
You can turn off the client-side execution of the query by setting SupportEnhancedSQL to false in which case any other search criteria will be ignored and an unfiltered response will be returned.
Insert
The RemoteSubdomain field is required to insert. Allowed for agents.
INSERT INTO SharingAgreements (RemoteSubdomain) VALUES ('Foo')
Update
You must specify the Id of the SharingAgreement to update. Only Status is allowed to be updated. Allowed for agents.
UPDATE SharingAgreements SET Status = 'accepted' WHERE Id = '123'
Delete
You must specify the Id of the SharingAgreement to delete it. Allowed for agents.
DELETE FROM SharingAgreements WHERE Id = '123'
Columns
Name | Type | ReadOnly | References | Description |
Id [KEY] | Long | True |
Automatically assigned upon creation. | |
Name | String | False |
Name of this sharing agreement. | |
Type | String | False |
Can be one of the following: 'inbound', 'outbound'. | |
Status | String | False |
Can be one of the following: 'accepted', 'declined', 'pending', 'inactive'. | |
PartnerName | String | False |
Can be one of the following: 'jira', null. | |
RemoteSubdomain | String | False |
Subdomain of the remote account or null if not associated with an account. | |
CreatedAt | Datetime | True |
The time the record was created. |