Sign in
latestOpenAPI 3.0.02026-08-2217901.1 MB

ef9153fcac7c

Work Request Portals

Create new work request portal

post/workrequestportals

Query parameters

skipWebhookboolean

Set skipWebhook=true, skipWebhook=1 or skipWebhook=yes to skip all webhooks upon successful operation on the endpoint. Learn more about webhooks

Headers

x-organization-idinteger

Required if using a multi organizations token

Request body

titlestring required

Title of the portal

welcomeTextstring nullable

Description text describing the portal

descriptionPlaceholderstring nullable

Placeholder text for the description field

contactInformationstring nullable

Contact of the person creating the portal (email or phone number)

locationIdinteger nullable

ID of the location where the portal is located

assetIdinteger nullable

ID of the asset related to the portal

emailOnlyboolean nullable

Allow request creation with email only to contact the requester

sendEmailNotificationboolean nullable

Send email notifications to the portal requesters with status updates on their requests

Example request

{
  "title": "Shipping Portal",
  "welcomeText": "Use this portal for all request related to our shipping activities",
  "descriptionPlaceholder": "Describe your request",
  "contactInformation": "Jimmy@example.com",
  "locationId": 852,
  "assetId": 852,
  "emailOnly": true,
  "sendEmailNotification": true
}

Response

Successfully created portal

idinteger required

Global ID of the portal

Example response

{
  "id": 963
}