Rapport Power BI
pour Ticketing As A Service
Optimisez l'analyse de vos tickets avec notre rapport Power BI personnalisable !
With Ticketing API, you gain full control and flexibility to interact with Ticketing as a Service, extending its capabilities beyond its core functionality. Whether you want to automate ticket creation, extract ticket data for reporting purposes, or integrate ticketing features into your existing tools, Ticketing API empowers you to achieve your goals.
PRODUCTION BASE URL FOR CRM
Ticketing API follows REST industry-standard practices, using widely supported HTTP methods such as GET, POST, PUT, and DELETE.
END POINTS
Leads
GET /pipeline/leads
POST /pipeline/leads
GET /pipeline/leads/{id}
PATCH /pipeline/leads/{id}
DELETE /pipeline/leads/{id}
PATCH /pipeline/leads/{id}/archive
PATCH /pipeline/leads/{id}/unarchive
POST /pipeline/leads/{id}/convert
GET /pipeline/tags/leads
POST /pipeline/tags/leads
PATCH /pipeline/tags/leads/{id}
DELETE /pipeline/tags/leads/{id}
Opportunities
GET /pipeline/opportunities
POST /pipeline/opportunities
GET /pipeline/opportunities/{id}
PATCH /pipeline/opportunities/{id}
DELETE /pipeline/opportunities/{id}
PATCH /pipeline/opportunities/{id}/updateStatus
PATCH /pipeline/opportunities/{id}/updateStage
GET /pipeline/pipelines/opportunities
GET /pipeline/pipelines/opportunities/{id}
GET /pipeline/forms/opportunities
PUT /pipeline/forms/opportunities
GET /pipeline/tags/opportunities
POST /pipeline/tags/opportunities
PATCH /pipeline/tags/opportunities/{id}
DELETE /pipeline/tags/opportunities/{id}
Contacts
GET /directory/contacts
POST /directory/contacts
GET /directory/contacts/{id}
PATCH /directory/contacts/{id}
DELETE /directory/contacts/{id}
POST /directory contacts/{id}/merge
GET /directory/forms/contacts
PUT /directory/forms/contacts
GET /directory/tags/contacts
POST /directory/tags/contacts
PATCH /directory/tags/contacts/{id}
DELETE /directory/tags/contacts/{id}
Organizations
GET /directory/organizations
POST /directory/organizations
GET /directory/organizations/{id}
PATCH /directory/organizations/{id}
DELETE /directory/organizations/{id}
POST /directory/organizations/{id}/merge
GET /directory/forms/organizations
PUT /directory/forms/organizations
GET /directory/tags/organizations
POST /directory/tags/organizations
PATCH /directory/tags/organizations/{id}
DELETE /directory/tags/organizations/{id}
Cases
GET /cases/cases
POST /cases/cases
GET /cases/cases/{id}
PATCH /cases/cases/{id}
DELETE /cases/cases/{id}
GET /cases/types/cases
POST /cases/types/cases
DELETE /cases/types/cases/{id}
GET /cases/types/cases/{id}
PATCH /cases/types/cases/{id}
GET /cases/tags/cases
POST /cases/tags/cases
PATCH /cases/tags/cases/{id}
DELETE /cases/tags/cases/{id}
AUTHENTICATION
To ensure secure authentication with our Ticketing as a Service REST API, we utilize an API key as an authentication query parameter. You have the option to use either the primary or secondary key for authentication purposes.
To access your API key, please follow these steps:
-
Navigate to the Ticketing App settings area.
-
Look for the API key section within the settings.
-
Genereate new keys. You will find both the primary (read/write) and secondary (ready only) keys listed.
Please note that the API key provided for authentication purposes in the setting area is valid only for a single ticketing instance.
When making API requests, include the API key as a query parameter in your requests. This will authenticate your requests and grant you access to the desired functionalities of Ticketing API.
Remember to handle your API keys with care and keep them secure. They provide access to your Ticketing as a Service account, and misuse or unauthorized access to the API keys can compromise the security of your system.
If you have any further questions or need assistance regarding API key authentication or any other aspect of our Ticketing as a Service API, please don't hesitate to reach out to our support team. We are here to help you integrate and leverage the power of our API seamlessly.
Please note that the API key provided for authentication in the settings area is valid only for a single CRM instance.
When making API requests, include the API key as a request header:
Ocp-Apim-Subscription-Key: YOUR_API_KEY
This will authenticate your requests and grant you access to the desired functionalities of CRM API.
Remember to handle your API keys with care and keep them secure. They provide access to your CRM as a Service account, and misuse or unauthorized access to the API keys can compromise the security of your system.
If you have any further questions or need assistance regarding API key authentication or any other aspect of our CRM as a Service API, please don't hesitate to reach out to our support team. We are here to help you integrate and leverage the power of our API seamlessly.
SANDBOX ENVIRONMENT
We recommend setting up your own sandbox or test environment. Having a dedicated test environment allows you to safely and securely test your integrations, functionality, and API calls without affecting your live or production environment.
ERRORS
CRM API uses conventional HTTP response codes to indicate the success or failure of an API request. In general: Codes in the 2xx range indicate success. Codes in the 4xx range indicate an error that failed given the information provided (e.g., a required parameter was omitted, etc.). Codes in the 5xx range indicate an error with CRM's servers. Some 4xx errors that could be handled programmatically (e.g., a card is declined) include an error code that briefly explains the error reported.
PAGINATION
For some top-level API resources, CRM API provides pagination functionality to allow you to retrieve large datasets in a controlled and manageable manner. To implement pagination, we follow the conventional approach of using "page" and "size" parameters.
size: indicates the number of records to return to each page using the query parameter.
page: sets the page number. The default is 1, which shows the first page.
USER
See User in the Schema
A user is represented by an ID, name, and email. For users from your Microsoft 365 organization, it's important to ensure that this information remains consistent. Please note that the Ticketing API does not verify the consistency between the user's ID, name, and email.
If you require the ID, name, and email of a user, you can refer to the corresponding Object ID, Display Name, and Email attributes in Azure.
CUSTOM FIEDS
In the CRM, there are default pre-made forms available for Leads, Opportunities, Contacts, and Organizations. You can customize existing ones as needed.
-
For Leads and Opportunities, use the following endpoint: /pipeline/forms/opportunities
-
For Contacts, use: /directory/forms/contacts
-
For Organizations, use: /directory/forms/organizations
To retrieve the details of a form, make a GET request to the respective endpoint. The response will contain information such as field ID, field label, and tenant ID.
To update a form, use a PUT request to the appropriate endpoint.
BULK UPDATE AND RATE LIMITING
The CRM API supports bulk actions for performing bulk operations on leads, opportunities, contacts, and organizations. However, at this stage, only bulk deletion is available.
Endpoint: GET /tickets
Description: Retrieves a list of leads, with options for filtering, sorting, and pagination. It provides a comprehensive view for several leads, enabling you to access leads details, statuses, and other relevant information.
Parameters:
page: number, // The page number for pagination. (Example: 1)
size: number, // The number of leads per page. (Example: 10)
sort: string, // The sorting order. Allowed values: 'asc', 'desc', 'ASC', 'DESC'. (Example: 'asc')
orderBy: string, // The field to sort by. (Example: 'name')
title: string, // Filter leads by title. (Example: 'Cloud Migration Service')
contactId: string, // Filter by associated contact ID(s). Comma-separated list. (Example: '123,234,345')
organizationId: string, // Filter by associated organization ID(s). Comma-separated list. (Example: '123,234,345')
tags: string, // Filter by tags. Comma-separated list. (Example: 'lead-tags,another-tag')
isArchived: boolean, // Filter by archived status. (Example: true)
isConverted: boolean, // Filter by converted status. (Example: true)
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required for authentication.
Request Body
N/A
Response Body
items: Lead[], // See Lead in the Schema.
Example
GET [baseUrl]/pipeline/leads?page=1&size=5&sort=asc&orderBy=createdOn&title=Cloud
Endpoint: POST /tickets
Description: Creates a new lead using the CRM API, you can make a POST request to the leads endpoint along with the necessary parameters and payload.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required for authentication.
Request Body
Response Body
N/A
Example
Example 1: POST [baseUrl]/pipeline/leads Request Body: { "title": "Cloud Migration Project - Acme Corp", "value": { "amount": 25000, "code": "USD" }, "origin": "referral", "leadRating": "2_warm", "note": "Referred by John Smith. Initial meeting scheduled.", "organizationId": "456", "owner": { "id": "789", "name": "Sarah Lee", "email": "sarah.lee@example.com" }, "creator": { "id": "user-012", "name": "Alex Kim", "email": "alex.kim@example.com" }, "tenantId": "fdsa-4321", "customFields": { } } Example 2: Create Lead with Form { "title": "Leads with Custom Fields from API", "value": { "code": "USD", "amount": 10000 }, "origin": "website", "leadRating": "2_warm", "note": "Note", "owner": { "id": "5c68efa2-6024-4dc9-8b65-b2bc2e26ba17", "name": "MOD Administrator", "email": "admin@M365x97476737.onmicrosoft.com" }, "organizationId": "1", "contactId": "1", "followers": [ { "id": "0b3f5c3e-1b3f-4b3f-8b3f-3b3f5b3f1b3f", "name": "John Doe", "email": "johndoe@me.com" } ], "participants": [ { "id": "123", "name": "John Doe" } ], "customFields": { "3bf89603-37c2-4324-b3bf-665b7e35be23": "2025-02-20", //Date "e1e0b23d-163e-46ca-a072-95d50c4c7bb4": { //Date Range "start": "2025-02-20", "end": "2025-02-21" }, "08a38c43-c43a-4aa8-9086-ca5015592526": "2025-02-20T09:27",//Date and Time "21709e77-1af3-4964-8bf2-9494e0811eef": { //Date and Time Range "start": "2025-02-20T09:27", "end": "2025-02-21T09:27" }, "569b2afa-91b0-42bf-a7a2-d84b0b216073": [ //Dropdown "5ddd0486-1700-49d3-a7ba-1c95ccaf3a4a" ], "d8ae48c0-2820-45dc-8934-081a418aef29": "johndoe@email.com", //Email "b7c579cd-b139-43a8-b4a3-f382e687b10b": { //Monetary "code": "USD", "amount": 123 }, "f9c1f41f-dbd8-4941-a8b1-7b8032852447": "1", //Number "24d66f90-3b91-4868-b358-1700a7b87e18": [ { "id": "5c68efa2-6024-4dc9-8b65-b2bc2e26ba17", //People Picker "name": "MOD Administrator", "email": "admin@M365x97476737.onmicrosoft.com" } ], "70c70538-d21b-4da3-9389-9dd4080e9726": "81234567890", //Phone "47c7cc14-2259-4dd3-90fa-921121b07be0": "Text", //Text "4189f7ce-6ff8-48f8-b05b-fc1244eb0e86": "Text Area", //Text Area "ddc0617c-9534-40d9-b0ef-a26bdef9d11a": "09:28", //Time "2c0e1501-3d88-4d03-bbee-ffe85e4960ad": { "start": "09:28", //Time Range "end": "10:28" }, "2258b428-d13c-4a7e-8139-d554cdc94c6f": "johndoe.com", //Url "4c405ec6-8eb8-4060-b873-ce1d09e5267e": [ { "id": "7ed65a4e-a458-48ee-b57b-801b46e7f5d6", //Tag Pickeer "label": "Tag3", "color": "#FF7A00" } ] } }
Endpoint: GET /tickets/{ticketId}
Description: Retrieve a lead detail from its ID.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required for authentication.
Request Body
N/A
Response Body
item: Lead, // See Lead in the Schema.
Example
GET [baseUrl]/pipeline/leads/{lead id}
Endpoint: PUT /tickets/{ticketId}
Description: Update a lead. Support partial updates.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
item: Lead, // See Lead in the Schema.
Example
PATCH [baseUrl]/pipeline/leads/{lead id} Request Body: { "title": "Cloud Migration Service", "value": { "amount": 10000, "code": "USD" }, "origin": "website", "leadRating": "1_cold", "note": "This is an updated note.", "owner": { "id": "0b3f5c3e-1b3f-4b3f-8b3f-3b3f5b3f1b3f", "name": "John Doe", "tags": "lead-tags", "email": "johndoe@me.com" }, "organizationId": "5", "contactId": "5", "followers": [ { "id": "0b3f5c3e-1b3f-4b3f-8b3f-3b3f5b3f1b3f", "name": "John Doe", "email": "johndoe@me.com" } ], "participants": [ { "id": "1", "name": "John Doe" } ], "customFields": { "454f3b6e-4081-482c-8ac9-d25482667f7d": "some_custom_value" }, "lastUpdatedBy": { "id": "0b3f5c3e-1b3f-4b3f-8b3f-3b3f5b3f1b3f", "name": "John Doe", "email": "johndoe@me.com" }
Endpoint: PUT /tickets/{ticketId}
Description: Delete a lead.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required
Request Body
N/A
Response Body
N/A
Example
DELETE [baseUrl]/pipeline/leads/{lead id}
Endpoint: PUT /tickets/{ticketId}
Description: Archive a lead.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
item: Lead, // See Lead in the Schema.
Example
PATCH [baseUrl]/pipeline/lead/{leads id}/archive
Endpoint: PUT /tickets/{ticketId}
Description: Unarchive a lead.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required
Request Body
N/A
Response Body
item: Lead, // See Lead in the Schema.
Example
PATCH [baseUrl]/pipeline/leads/{lead id}/unarchive
Endpoint: PUT /tickets/{ticketId}
Description: Convert a lead into an opportunity
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
item: Opportunity, // See Opportunity in the Schema.
Example
POST [baseUrl]/pipeline/leads/{lead id}/convert
Endpoint: PUT /tickets/{ticketId}
Description: Retrieve the list of available tags for leads.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
items: object[], // See TagOption in the Schema.
Example
GET [baseUrl]/pipeline/tags/leads
Endpoint: PUT /tickets/{ticketId}
Description: Create a new tag for Leads.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
See insertTag in the Schema.
Response Body
items: object[], // See TagOption in the Schema.
Example
POST [baseUrl]/pipeline/tags/leads Request Body: { "label": "high-priority", "color": "#ff0000", "tenantId": "your-tenant-id" }
Endpoint: PUT /tickets/{ticketId}
Description: Update an existing tag for Leads.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
See insertTag in the Schema.
Response Body
items: object[], // See TagOption in the Schema.
Example
PATCH [baseUrl]/pipeline/tags/leads/{tag id} Request Body: { "label": "urgent", "color": "#8b0000" }
Endpoint: PUT /tickets/{ticketId}/status
Description: Change the status of a ticket.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
N/A
Example
DELETE [baseUrl]/pipeline/tags/leads/{tag id}
Endpoint: PUT /tickets/{ticketId}/status
Description: Change the status of a ticket.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
See bulkAction in the Schema.
Response Body
N/A
Example
POST [baseUrl]/pipeline/bulk-actions Request Body: { "entity": "lead", "action": "delete", "ids": ["1", "2", "3"] }
Endpoint: GET /tickets/{ticketId}/activities
Description: Retrieve a list of Opportunities. It provides a comprehensive view for several Opportunities enabling you to access the details and other relevant information.
Parameters:
page: number, // The page number for pagination. (Example: 1)
size: number, // The number of opportunities per page. (Example: 10)
sort: string, // The sorting order. Allowed values: 'asc', 'desc', 'ASC', 'DESC'. (Example: 'asc')
orderBy: string, // The field to sort by. (Example: 'title')
title: string, // Filter opportunities by title. (Example: 'Cloud Migration Service')
contactId: string, // Filter by associated contact ID(s). Comma-separated list. (Example: '123,234,345')
organizationId: string, // Filter by associated organization ID(s). Comma-separated list. (Example: '123,234,345')
tags: string, // Filter by tags. Comma-separated list. (Example: 'opportunity-tags,another-tag')
ownerId: string, // Filter by the owner's ID. (Example: '0b3f5c3e-1b3f-4b3f-8b3f-3b3f5b3f1b3f')
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required for authentication.
Request Body
N/A
Response Body
items: Opportunity[], // See Opportunity in the Schema.
Example
GET [baseUrl]/pipeline/opportunities?page=1&size=10&sort=asc&orderBy=title&contactId=1,2
Endpoint: POST /tickets/{ticketId}/comments
Description: Create a new opportunity using the CRM API, you can make a POST request to the Opportunities endpoint along with the necessary parameters and payload.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
See insertOpportunity in the Schema.
Response Body
item: Opportunity, // See Opportunity in the Schema.
Example
POST [baseUrl]/pipeline/opportunities Request Body: { "title": "New Opportunity - Example Corp", "value": { "amount": 50000, "code": "USD" }, "stage": "stage-xyz", //stage key "pipelineId": "c4d5e6f7-8901-2345-6789-abcdef012345", "origin": "inbound", "leadRating": "3_hot", "note": "Initial contact promising. Schedule demo.", "organization": { "id": "7", "name": "Example Corp" }, "owner":{ "id": "99999-dfds-4324-sdfsdf", "name": "Alex Kim", "email": "alex.kim@example.com" }, "creator":{ "id": "88888-dfds-4324-sdfsdf", "name": "Alex Kim", "email": "alex.kim@example.com" }, "tenantId": "tenant-id-example" }
Endpoint: GET /instance
Description: Retrieve an opportunity detail from its ID.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
item: Opportunity, // See Opportunity in the Schema.
Example
GET [baseUrl]/pipeline/opportunities/{opportunity id}
Endpoint: GET /tags
Description: Update an opportunity. Supports partial updates.
Parameters:
item: Opportunity, // See Opportunity in the Schema.
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
See updateOpportunity in the Schema.
Response Body
item: Opportunity, // See Opportunity in the Schema.
Example
PATCH [baseUrl]/pipeline/opportunities/{opportunity id} { "title": "Edited", "value": { "amount": 100, "code": "USD" }, "stage": "", "origin": "website", "leadRating": "1_cold", "note": "This is a note", "tags": "opportunity-tags", "owner": { "id": "0b3f5c3e-1b3f-4b3f-8b3f-3b3f5b3f1b3f", "name": "John Doe", "email": "johndoe@me.com" }, "organizationId": "1", "contactId": "1", "followers": [ { "id": "0b3f5c3e-1b3f-4b3f-8b3f-3b3f5b3f1b3f", "name": "John Doe", "email": "johndoe@me.com" } ], "participants": [ { "id": "123", "name": "John Doe" } ], "pipelineId": "727a1a94-dda3-4e68-92cb-343e3e3d4fbc", "customFields": { } }
Endpoint: GET /tags
Description: Delete an opportunity.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
N/A
Example
DELETE [baseUrl]/pipeline/opportunities/{opportunity id}
Endpoint: GET /tags
Description: Update the status of an opportunity.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
See updateOpportunityStatus in the Schema.
Response Body
item: Opportunity, // See Opportunity in the Schema.
Example
PATCH [baseUrl]/pipeline/opportunities/{opportunity id}/updateStatus Request Body: Example 1: { "status": "won", } Example 2: { "status": "lost", "lostReason": { "reasonId": "too_expensive", "comment": "Customer chose a cheaper competitor." }, "lastUpdatedBy": { "id": "user-123", "name": "Alex Kim", "email": "alex.kim@example.com" } }
Endpoint: GET /tags
Description: Update the stage of an opportunity.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
See updateOpportunityStage in the Schema.
Response Body
item: Opportunity, // See Opportunity in the Schema.
Example
PATCH [baseUrl]/pipeline/opportunities/{opportunity id}/updateStage Request body: { "stage": "395f9a11-c7d5-4d91-b4bb-8c964cf8d329" // Stage Key } // You can get stage key by doing GET /pipeline/pipelines/opportunities
Endpoint: GET /tags
Description: Retrieve the list of opportunity pipelines.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
items: object[]
Example
GET [baseUrl]/pipeline/pipelines/opportunities
Endpoint: GET /tags
Description: Retrieve an opportunity pipeline.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
items: object, // See Stage in the Schema.
Example
GET [baseUrl]/pipeline/pipelines/opportunities/{pipeline id}
Endpoint: GET /tags
Description: Retrieve the list of forms for Leads and Opportunities.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
items: object[] // See Field in the Schema.
Example
GET [baseUrl]/pipeline/forms/opportunities
Endpoint: GET /tags
Description: Update a form for Leads and Opportunities.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
See insertOpportunityForm in the Schema.
Response Body
item: object, // See Field in the Schema.
Example
PUT [baseUrl]/pipeline/forms/opportunities Request Body: { "creator": { "id": "user-admin", "name": "Admin User", "email": "admin@example.com" }, "tenantId": "your-tenant-id", "fields": [ { "id": "title", "label": "Title", "category": "default", "type": "text", "required": true }, { "id": "value", "label": "Estimated Value", "category": "default", "type": "monetary", "required": true }, { "id": "organizationId", "label": "Organization", "category": "default", "type": "combobox", "required": false }, { "id": "contactId", "label": "Contact", "category": "default", "type": "combobox", "required": false }, { "id": "origin", "label": "Opportunity Origin", "category": "default", "type": "dropdown", "required": true, "options": ["website", "referral", "partner", "inbound", "other"] }, { "id": "custom_field_1", "label": "New Custom Field", "category": "custom", "type": "text", "required": false } ] }
Endpoint: GET /tags
Description: Retrieve the list of available tags for Opportunities.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
items: object[], // See TagOption in the Schema.
Example
GET [baseUrl]/pipeline/tags/opportunities
Endpoint: GET /tags
Description: Create a new tag for Opportunities.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
See insertTag in the Schema.
Response Body
item: object
Example
POST [baseUrl]/pipeline/tags/opportunities Request Body: { "label": "strategic-account", "color": "#800080", "tenantId": "d745fd3e-c864-46bf-b945-024d4cad2890" }
Endpoint: GET /tags
Description: Update an existing tag for Opportunities.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
See updateTag in the Schema.
Response Body
item: object
Example
PATCH [baseUrl]/pipeline/tags/opportunities/{tag id} Request Body: { "label": "partner-referred-updated", "color": "#006400" }
Endpoint: GET /tags
Description: Delete a tag for Opportunities.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
N/A
Example
DELETE [baseUrl]/pipeline/tags/opportunities/{tag id}
Endpoint: GET /tags
Description: Perform a bulk action (currently only "delete") for Opportunities.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
See bulkAction in the Schema.
Response Body
N/A
Example
POST [baseUrl]/pipeline/bulk-actions Request Body: { "entity": "opportunity", "action": "delete", "ids": ["1", "2", "3"] }
Endpoint: GET /tags
Description: Retrieve a list of Contacts. It provides a comprehensive view for several Contacts enabling you to access the details and other relevant information.
Parameters:
page: number, // The page number. (Example: 1)
size: number, // Number of contacts per page. (Example: 10)
sort: string, // Sort order ('asc', 'desc', 'ASC', 'DESC'). (Example: 'asc')
orderBy: string, // Field to sort by. (Example: 'name')
ids: string, // Comma-separated list of contact IDs. (Example: '123,234,345')
name: string, // Filter by contact name. (Example: 'John Doe')
email: string, // Filter by email address. (Example: 'johndoe@me.com')
phone: string, // Filter by phone number. (Example: '1234567890')
tags: string, // Comma-separated list of tags. (Example: 'contact-tags,another-tag')
organizationId: string, // Filter by organization ID. (Example: '123')
searchValue: string, // Search across name, email, and organization name. (Example: 'John')
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
items: Contact[], // See Contact in the Schema.
Example
GET [baseUrl]/directory/contacts?page=1&size=20&sort=asc&orderBy=name&name=John
Endpoint: GET /tags
Description: Create a new contact using the CRM API, you can make a POST request to the Contacts endpoint along with the necessary parameters and payload.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
See insertContact in the Schema.
Response Body
item: Contact, // See Contact in the Schema.
Example
POST [baseUrl]/directory/contacts Request Body: { "name": "Jane Doe", "email": [ { "label": "Work", "value": "jane.doe@work.com", "primary": true }, { "label": "Personal", "value": "jane.doe@home.com", "primary": false } ], "phone": [ { "label": "Mobile", "value": "+15551234567", "primary": true } ], "owner": { "id": "user-123", "name": "John Smith", "email": "john.smith@example.com" }, "creator": { "id": "user-123", "name": "John Smith", "email": "john.smith@example.com" }, "organizationId": "42", "linkedin": "https://www.linkedin.com/in/janedoe", "jobTitle": "Software Engineer", "seniorityLevel": "2_junior", "department": "engineering", "note": "New contact from conference.", "tenantId": "your-tenant-id", "customFields": { "custom_field_1": "Some Value" } }
Endpoint: GET /tags
Description: Retrieve a contact detail from its ID.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
item: Contact, // See Contact in the Schema.
Example
GET [baseUrl]/directory/contacts/{contact id}
Endpoint: GET /tags
Description: Update a contact. Supports partial updates.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
See updateContact in the Schema.
Response Body
item: Contact, // See Contact in the Schema.
Example
PATCH [baseUrl]/directory/contacts/{contact id} Request Body: { "name": "Jane A. Doe", "email": [ { "label": "Work", "value": "jane.doe.updated@work.com", "primary": true } ], "owner": { "id": "user-123", "name": "John Smith", "email": "john.smith@example.com" }, "jobTitle": "Senior Software Engineer", "note": "Updated contact details after meeting.", "customFields": { "custom_field_2": "New Value" }, "lastUpdatedBy":{ "id": "user-123", "name": "John Smith", "email": "john.smith@example.com" } }
Endpoint: GET /tags
Description: Delete a contact.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
N/A
Example
DELETE [baseUrl]/directory/contacts/{contact id}
Endpoint: GET /tags
Description: Merge multiple source contacts into a single target contact.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
See mergeContact in the Schema.
Response Body
item: Contact, // See Contact in the Schema.
Example
POST [baseUrl]/directory/contacts/{contact id}/merge Request Body: { "sourceId": ["2", "3", "4"], "lastUpdatedBy":{ "id": "user-123", "name": "Alex Kim", "email": "alex.kim@example.com" } }
Endpoint: GET /tags
Description: Retrieve the list of forms for Contacts.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
items: object[] // See Field in the Schema.
Example
GET [baseUrl]/directory/forms/contacts
Endpoint: GET /tags
Description: Update a form for Contacts.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
Based on insertContactsForm in the Schema.
Response Body
item: object
Example
PUT [baseUrl]/directory/forms/contacts Request Body: { "creator": { "id": "user-admin", "name": "Admin User", "email": "admin@example.com" }, "tenantId": "your-tenant-id", "fields": [ { "id": "name", "label": "Name", "category": "default", "type": "text", "required": true }, { "id": "email", "label": "Email", "category": "default", "type": "email_labeled", "labelOptions": ["Work", "Personal", "Other"], "required": true }, { "id": "phone", "label": "Phone", "category": "default", "type": "tel_labeled", "labelOptions": ["Work", "Mobile", "Home", "Other"], "required": true }, { "id": "organizationId", "label": "Organization", "category": "default", "type": "combobox", "required": false }, { "id": "linkedin", "label": "LinkedIn", "category": "default", "type": "url", "required": false }, { "id": "custom_field_1", "label": "New Custom Field", "category": "custom", "type": "text", "required": false } ] }
Endpoint: GET /tags
Description: Retrieve the list of available tags for Contacts.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
items: object[], // See TagOption in the Schema.
Example
GET [baseUrl]/directory/tags/contacts
Endpoint: GET /tags
Description: Create a new tag for Contacts.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
See insertTag in the Schema.
Response Body
item: object
Example
POST [baseUrl]/directory/tags/contacts Request Body: { "label": "newsletter-subscriber", "color": "#ffa500", "tenantId": "your-tenant-id" }
Endpoint: GET /tags
Description: Update an existing tag for Contacts.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
See updateTag in the Schema.
Response Body
item: object
Example
PATCH [baseUrl]/directory/tags/contacts/{tag id} Request Body: { "label": "newsletter-updated", "color": "#00008b" }
Endpoint: GET /tags
Description: Delete a tag for Contacts.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
N/A
Example
DELETE [baseUrl]/directory/tags/contacts/{tag id}
Endpoint: GET /tags
Description: Perform a bulk action (currently only "delete") for Contacts.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
See bulkAction in the Schema.
Response Body
N/A
Example
POST [baseUrl]/directory/bulk-actions Request Body: { "entity": "contact", "action": "delete", "ids": ["1", "2", "3"] }
Endpoint: GET /tags
Description: Retrieve a list of Organizations. It provides a comprehensive view for several Organizations enabling you to access the details and other relevant information.
Parameters:
page: number, // The page number for pagination. (Example: 1)
size: number, // The number of organizations per page. (Example: 10)
sort: string, // The sorting order ('asc', 'desc', 'ASC', 'DESC'). (Example: 'asc')
orderBy: string, // The field to sort by. (Example: 'name')
name: string, // Filter by organization name. (Example: 'Acme Corp')
address: string, // Filter by address. (Example: '123 Main St')
tags: string, // Filter by tags (comma-separated). (Example: 'org-tag,another-tag')
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
items: Organization[], // See Organization in the Schema.
Example
GET [baseUrl]/directory/organizations?page=1&size=10&sort=desc&orderBy=name
Endpoint: GET /tags
Description: Create a new organization using the CRM API, you can make a POST request to the Organizations endpoint along with the necessary parameters and payload.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
See insertOrganization in the Schema.
Response Body
items: Organization, // See Organization in the Schema.
Example
POST [baseUrl]/directory/organizations Request Body: { "name": "Acme Corporation", "address": "123 Main Street, Anytown, USA", "email": [ { "label": "Main", "value": "info@acme.com", "primary": true } ], "phone": [ { "label": "Office", "value": "+1-555-123-4567", "primary": true } ], "industry": "Technology", "size": "3_medium", "annualRevenue": "4_tenToHundredMillion", "website": "https://www.acme.com", "note": "Leading provider of widgets.", "owner": { "id": "user-789", "name": "Sarah Lee", "email": "sarah.lee@example.com" }, "creator": { "id": "user-789", "name": "Sarah Lee", "email": "sarah.lee@example.com" }, "tenantId": "your-tenant-id", "customFields": { } }
Endpoint: GET /tags
Description: Retrieve an organization from its ID.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
items: Organization, // See Organization in the Schema.
Example
GET [baseUrl]/directory/organizations/{organization id}
Endpoint: GET /tags
Description: Update an organization. Supports partial updates.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
See updateOrganization in the Schema.
Response Body
items: Organization, // See Organization in the Schema.
Example
PATCH [baseUrl]/directory/organizations/{organization id} Request Body: { "name": "John Doe Org Edit", "address": "123 Main Street", "email": [ { "label": "Work", "value": "johndoe@me.com", "primary": true } ], "phone": [ { "label": "Work", "value": "johndoe@me.com", "primary": true } ], "industry": "Technology", "size": "Small", "note": "This is a note", "owner": { "id": "0xxxxxxx-1xxx-4xxx-8xxx-3xxxxxxx", "name": "John Doe", "email": "johndoe@me.com" }, "customFields": { } }
Endpoint: GET /tags
Description: Delete an organization.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
N/A
Example
DELETE [baseUrl]/directory/organizations/{organization id}
Endpoint: GET /tags
Description: Merge multiple source organizations into a single target organization.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
See mergeOrganization in the Schema.
Response Body
items: Organization, // See Organization in the Schema.
Example
POST [baseUrl]/directory/organizations/{organization id}/merge Request Body: { "sourceId": ["2", "3"], "lastUpdatedBy": { "id": "user-123", "name": "Alex Kim", "email": "alex.kim@example.com" }
Endpoint: GET /tags
Description: Retrieve the list of forms for organizations.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
items: object[] // See Field in the Schema.
Example
GET [baseUrl]/directory/forms/organizations
Endpoint: GET /tags
Description: Update a form for Organizations.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
See insertOrganizationForm in the Schema.
Response Body
items: object[] // See Field in the Schema.
Example
PUT [baseUrl]/directory/forms/organizations Request Body: { "creator": { "id": "user-admin", "name": "Admin User", "email": "admin@example.com" }, "tenantId": "your-tenant-id", "fields": [ { "id": "name", "label": "Name", "category": "default", "type": "text", "required": true }, { "id": "address", "label": "Address", "category": "default", "type": "text", "required": false }, { "id": "email", "label": "Email", "category": "default", "type": "email_labeled", "labelOptions": ["Work", "Personal", "Other"], "required": true }, { "id": "phone", "label": "Phone", "category": "default", "type": "tel_labeled", "labelOptions": ["Work", "Mobile", "Home", "Other"], "required": true }, { "id": "website", "label": "Website", "category": "default", "type": "url", "required": false }, { "id": "custom_field_1", "label": "New Custom Field", "category": "custom", "type": "text", "required": false } ] }
Endpoint: GET /tags
Description: Retrieve the list of available tags for Organizations.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
items: object[], // See TagOption in Schema.
Example
GET [baseUrl]/directory/tags/organizations
Endpoint: GET /tags
Description: Create a new tag for Organizations.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
See insertTag in the Schema.
Response Body
item: object
Example
POST [baseUrl]/directory/tags/organizations Request Body: { "label": "non-profit", "color": "#228b22", "tenantId": "your-tenant-id" }
Endpoint: GET /tags
Description: Update an existing tag for Organizations.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
See updateTag in the Schema.
Response Body
item: object
Example
PATCH [baseUrl]/directory/tags/organizations/{tag id} Request Body: { "label": "small-medium-business", "color": "#2e8b57" }
Endpoint: GET /tags
Description: Delete an existing tag for Organizations.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
N/A
Example
DELETE [baseUrl]/directory/tags/organizations/{tag id}
Endpoint: GET /tags
Description: Perform a bulk action (currently only "delete") for Organizations.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
See bulkAction in the Schema.
Response Body
N/A
Example
POST [baseUrl]/directory/bulk-actions Request Body: { "entity": "organization", "action": "delete", "ids": ["1", "2", "3"] }
Endpoint: GET /tags
Description: Retrieve a list of cases. It provides a comprehensive view for several cases enabling you to access the details and other relevant information.
Parameters:
page: number, // The page number for pagination. (Example: 1)
size: number, // The number of cases per page. (Example: 10)
offset: number, // The offset for pagination, number of data. (Example: 0)
orderBy: string, // The field to sort by. (Example: 'createdAt')
sort: string, // The sorting order ('asc', 'desc', 'ASC', 'DESC'). (Example: 'asc')
title: string, // Filter by case title. (Example: 'Case Title Example')
status: string, // Filter by case status. (Example: 'open')
caseType: string, // Filter by case type ID. (Example: '<case-type-id>')
ownerId: string, // Filter by owner ID. (Example: '<owner-id>')
contactId: string, // Filter by associated contact ID(s), comma-separated. (Example: '123,234,345')
organizationId: string, // Filter by associated organization ID(s), comma-separated. (Example: '123,234,345')
tags: string, // Filter by tags, comma-separated. (Example: '123,234,345')
createdAfterDate: string, // Filter by creation date (ISO 8601 format). (Example: '2023-01-01T00:00:00Z')
createdBeforeDate: string, // Filter by creation date (ISO 8601 format). (Example: '2023-12-31T23:59:59Z')
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
items: Case[], // See Case in the Schema.
Example
GET [baseUrl]/cases/cases?page=1&size=10&sort=asc&orderBy=createdOn&status=open
Endpoint: GET /tags
Description: Create a new case using the CRM API, you can make a POST request to the Cases endpoint along with the necessary parameters and payload.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
See insertCaseType in the Schema.
Response Body
item: Case, // See Case in the Schema.
Example
POST [baseUrl]/cases/cases Request Body: { "title": "Support Request - System Outage", "description": "Users reporting inability to access the system.", "status": "open", "organizationId": "4", "contactId": "7", "caseTypeId": "1", "assignee": { "id": "user-abc", "name": "Support Agent", "email": "support@example.com" }, "priority": "1_high", "expectedDate": "2024-03-01", "owner": { "id": "user-def", "name": "Case Owner", "email": "owner@example.com" }, "creator": { "id": "user-def", "name": "Case Owner", "email": "owner@example.com" }, "tenantId": "tenant-id-example", "customFields": { } }
Endpoint: GET /tags
Description: Retrieve a case detail from its ID.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
item: Case, // See Case in the Schema.
Example
GET [baseUrl]/cases/cases/{case id}
Endpoint: GET /tags
Description: Update a case. Supports partial updates.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
See updateCase in the Schema.
Response Body
item: Case, // See Case in the Schema.
Example
PATCH [baseUrl]/cases/cases/{case id} Request Body: { "title": "Updated Case Title - System Outage Resolved", "status": "In Progress", "tags": "cases-tags", "description": "System outage resolved. Root cause identified.", "assignee": { "id": "user-xyz", "name": "New Support Agent", "email": "new.support@example.com" }, "customFields": { }, "lastUpdatedBy": { "id": "user-123", "name": "Alex Kim", "email": "alex.kim@example.com" } }
Endpoint: GET /tags
Description: Delete a case.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
N/A
Example
DELETE [baseUrl]/cases/cases/{case id}
Endpoint: GET /tags
Description: Retrieves the list of available case types.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
items: object[]
Example
GET [baseUrl]/cases/types/cases
Endpoint: GET /tags
Description: Create a new case type.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
See insertCaseType in the Schema.
Response Body
item: object, // See inserCaseType in the Schema.
Example
POST [baseUrl]/cases/types/cases Request Body: { "label": "Feature Request", "form": [ { "id": "title", "label": "Title", "category": "default", "type": "text", "required": true }, { "id": "contactId", "label": "Contact", "category": "default", "type": "combobox", "required": true }, { "id": "organizationId", "label": "Organization", "category": "default", "type": "combobox", "required": true }, { "id": "assignee", "label": "Assignee", "category": "default", "type": "combobox", "required": false }, { "id": "description", "label": "Description", "category": "default", "type": "text-area", "required": false } ], "workflow": { "status": [ { "id": "open", "type": "node", "position": { "x": 100, "y": 100 }, "data": { "label": "Open", "recordResolutionSLA": false, "color": "#ff0000" } }, { "id": "in-progress", "type": "node", "position": { "x": 300, "y": 100 }, "data": { "label": "In Progress", "recordResolutionSLA": true, "color": "#00ff00" } }, { "id": "closed", "type": "node", "position": { "x": 300, "y": 100 }, "data": { "label": "Closed", "recordResolutionSLA": true, "color": "#0000ff" } } ], "transition": [ { "id": "03143c6f-c8bd-425e-9eff-31be3011dff9", "type": "labeledEdge", "label": "Close", "source": "Open", "sourceHandle": null, "target": "Closed", "targetHandle": null, "data": { "isEditing": false, "recordComment": false } }, { "id": "03143c6f-c8bd-425e-9eff-31be3011dff9", "type": "labeledEdge", "label": "Start", "source": "Open", "sourceHandle": null, "target": "In Progress", "targetHandle": null, "data": { "isEditing": false, "recordComment": false, "authorizedUsers": [ "owner", "assignee" ] } }, { "id": "bebee65c-974c-4afc-893e-b03672c168b4", "type": "labeledEdge", "label": "Cancel", "source": "Open", "sourceHandle": null, "target": "Closed", "targetHandle": null, "data": { "isEditing": false, "recordComment": true, "authorizedUsers": [ "owner", "assignee", "requestor" ] } }, { "id": "3660eb66-9e3e-43c4-8699-391de37fd50e", "type": "labeledEdge", "label": "Resolve", "source": "Open", "sourceHandle": null, "target": "Resolved", "targetHandle": null, "data": { "isEditing": false, "recordComment": true } }, { "id": "ae401e38-dd49-496b-900e-805659580e5e", "type": "labeledEdge", "label": "Resolve", "source": "In Progress", "sourceHandle": null, "target": "Resolved", "targetHandle": null, "data": { "isEditing": false, "recordComment": true, "authorizedUsers": [ "owner", "assignee" ] } }, { "id": "5a549dbb-fdbd-4874-88a7-b036d2653f8a", "type": "labeledEdge", "label": "Close", "source": "In Progress", "sourceHandle": null, "target": "Closed", "targetHandle": null, "data": { "isEditing": false, "recordComment": true, "authorizedUsers": [ "owner", "assignee", "requestor" ] } }, { "id": "8ad646ca-7cbf-41f9-94fe-745bf007037c", "type": "labeledEdge", "label": "Close", "source": "Resolved", "sourceHandle": null, "target": "Closed", "targetHandle": null, "data": { "isEditing": false, "recordComment": true, "authorizedUsers": [ "owner", "assignee", "requestor" ] } }, { "id": "4336ef9c-10b7-4c3f-9ac3-c1d9071786cd", "type": "labeledEdge", "label": "Reopen", "source": "Closed", "sourceHandle": null, "target": "Reopened", "targetHandle": null, "data": { "isEditing": false, "recordComment": true, "authorizedUsers": [ "owner", "assignee", "requestor" ] } }, { "id": "4e4d94ef-3fa0-4ec5-93c7-ba2e35c01727", "type": "labeledEdge", "label": "Close", "source": "Reopened", "sourceHandle": null, "target": "Closed", "targetHandle": null, "data": { "isEditing": false, "recordComment": true, "authorizedUsers": [ "owner", "assignee", "requestor" ] } }, { "id": "4f13b239-df78-49a8-96cd-819c2ec7b122", "type": "labeledEdge", "label": "Resolve", "source": "Reopened", "sourceHandle": null, "target": "Resolved", "targetHandle": null, "data": { "isEditing": false, "recordComment": true, "authorizedUsers": [ "owner", "assignee" ] } }, { "id": "f09478fd-aa5b-47ec-ab1d-6b903ca6513a", "type": "labeledEdge", "label": "Reopen", "source": "Resolved", "sourceHandle": null, "target": "Reopened", "targetHandle": null, "data": { "isEditing": false, "recordComment": true, "authorizedUsers": [ "owner", "assignee", "requestor" ] } } ] }, "owner": { "id": "user-admin", "name": "Admin User", "email": "admin@example.com" }, "creator": { "id": "user-admin", "name": "Admin User", "email": "admin@example.com" }, "tenantId": "d745fd3e-c864-46bf-b945-024d4cad2890" }
Endpoint: GET /tags
Description: Delete a case type.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
N/A
Example
DELETE [baseUrl]/cases/types/cases/{case type id}
Endpoint: GET /tags
Description: Retrieve a case type from its ID.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
item: object
Example
GET [baseUrl]/cases/types/cases/{case type id}
Endpoint: GET /tags
Description: Update a case type. Support partial updates.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
See updateCaseType in the Schema.
Response Body
item: object
Example
PATCH [baseUrl]/cases/types/cases/{case type id} Request Body: { "label": "Technical Support Request", "form": [ { "id": "title", "label": "Title", "category": "default", "type": "text", "required": true }, { "id": "contactId", "label": "Contact", "category": "default", "type": "combobox", "required": true }, { "id": "organizationId", "label": "Organization", "category": "default", "type": "combobox", "required": true }, { "id": "assignee", "label": "Assignee", "category": "default", "type": "combobox", "required": false }, { "id": "description", "label": "Description", "category": "default", "type": "text-area", "required": true }, { "id": "new_field", "label": "New Custom Field", "category": "custom", "type": "text", "required": false } ], "lastUpdatedBy":{ "id": "user-admin", "name": "Admin User", "email": "admin@example.com" } }
Endpoint: GET /tags
Description: Retrieve the list of available tags for Cases.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Request Body
N/A
Response Body
tems: object[], // See TagOption in the Schema.
Example
GET [baseUrl]/cases/tags/cases
Endpoint: GET /tags
Description: Create a new tag for Cases.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
See insertTag in the Schema.
Response Body
item: object, // See TagOption in the Schema.
Example
POST [baseUrl]/cases/tags/cases Request Body: { "label": "billing-issue", "color": "#4b0082", "tenantId": "your-tenant-id" }
Endpoint: GET /tags
Description: Update an existing tag for Cases.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
See updateTag in the Schema.
Response Body
item: object, // See TagOption in Schema.
Example
PATCH [baseUrl]/cases/tags/cases/{tag id} Request Body: { "label": "escalated-urgent", "color": "#b8860b" }
Endpoint: GET /tags
Description: Delete a tag for Cases.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
N/A
Response Body
N/A
Example
DELETE [baseUr]/cases/tags/cases/{tag id}
Endpoint: GET /tags
Description: Perform a bulk action (currently only "delete") for Cases.
Parameters:
N/A
Request Headers:
Ocp-Apim-Subscription-Key: string, // Your API key. Required.
Content-Type: application/json
Request Body
See bulkAction in the Schema.
Response Body
N/A
Example
POST [baseUrl]/cases/bulk-actions Request Body: { "entity": "case", "action": "delete", "ids": ["1", "2", "3"] }