JobNimbus
App · 20 actions
Manage activities and products; read conversations and send messages with JobNimbus Engage.
Actions
| Action | What it does |
|---|---|
| Create activity | Create activity. |
| Create product | Create product. |
| Delete activity | Delete activity. |
| Delete product | Delete product. |
| Find or create conversation | Find or create conversation. |
| Get activity | Get activity. |
| Get conversation | Get conversation. |
| Get conversation counts | Get conversation counts. |
| Get message | Get message. |
| Get product | Get product. |
| List activities | List activities. |
| List activity types | List activity types. |
| List conversations | List conversations. |
| List messages | List messages. |
| List products | List products. |
| List sending phone numbers | List sending phone numbers. |
| Send message | Send message. |
| Set conversation read state | Set conversation read state. |
| Update activity | Update activity. |
| Update conversation | Update conversation. |
Create activity
Create activity.
Inputs
- Content
contenttextRequired - Content.
- Activity type
activity_type_idnumberRequired - Activity type ID.
- Activity action
activity_actiontextRequired - Activity action.
- Primary record
primary_recordobjectRequired - Primary record.
- Related records
related_recordslistRequired - Related records.
- Is private
is_privatetrue/false - Is private.Default:
false.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"activityAction": "example",
"activityTypeId": 1,
"content": "example",
"createdAt": "example",
"createdBy": {
"id": "example",
"name": "example"
},
"hasFiles": false,
"id": "example",
"isEditable": false,
"isPrivate": false,
"primaryRecord": {
"id": "example",
"name": "example",
"type": "example"
},
"relatedRecords": [],
"updatedAt": "example"
},
"pagination": {
"nextCursor": "example",
"pageSize": 1
}
}
}Create product
Create product.
Inputs
- Name
nametextRequired - Product name. Must be unique within the company's location bucket, compared trimmed and case-insensitively; a disabled product still holds its name. On update only a changed name or location is checked, so an unchanged product that already shares its name can still be saved. The 200-character limit applies after trimming; on update, an unchanged stored name that is already longer is accepted (exact, case-sensitive match after trimming). `refund` (trimmed, any case) is reserved for the system-man
- Description
descriptiontext - Product description. Omitted or null stores an empty description.
- Item type
item_typetext - How the product is billed. One of `material`, `labor` or `laborAndMaterial`; omitted or null stores `material`. The legacy `material+labor` is accepted as `laborAndMaterial`. On update, a change into or out of `laborAndMaterial` needs `POST /v1/products/{id}/replace`.One of:
material,labor,laborAndMaterial. - Suppliers
supplierslist - Links to products in supplier catalogs. Display data, such as the supplier product's name, comes from the Suppliers API by `id`.
- Tax exempt
tax_exempttrue/false - Whether the product is tax exempt. Omitted on create stores false; omitted on update keeps the stored value.
- Location ID
location_idnumber - Location the product belongs to. Locations 0 and 1 are the same all-locations bucket: omitted and 0 are stored as 1, and an existing product keeps its stored location when this is omitted on update. A value above 1 scopes the product to that location and must be one of the company's active locations.From 0 to 10000.
- Enabled
enabledtrue/false - Whether the product is visible. Omitted on create stores true; omitted on update keeps the stored value. Changing it on update requires the `settings` scope.
- Unit of measure
unit_nametext - Defaults to EA.Default:
EA. - Material price in cents
material_price_centsnumber - Amount in USD cents. Defaults to zero.At least 0. Default:
0. - Material cost in cents
material_cost_centsnumber - Amount in USD cents. Defaults to zero.At least 0. Default:
0. - Labor price in cents
labor_price_centsnumber - Amount in USD cents. Defaults to zero.At least 0. Default:
0. - Labor cost in cents
labor_cost_centsnumber - Amount in USD cents. Defaults to zero.At least 0. Default:
0.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"createdAt": "example",
"createdBy": "example",
"description": "example",
"enabled": false,
"id": "example",
"isEditable": false,
"itemType": "example",
"locationId": 1,
"name": "example",
"suppliers": [],
"taxExempt": false,
"uoms": [],
"updatedAt": "example",
"updatedBy": "example"
}
}
}Delete activity
Delete activity.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- Returned value.
Example output
{
"data": {}
}Delete product
Delete product.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- Returned value.
Example output
{
"data": {}
}Find or create conversation
Find or create conversation.
Inputs
- Contact phone number
contact_phone_numbertextRequired - Contact phone number.
- Agent phone number
agent_phone_numbertextRequired - Agent phone number.
- Primary record
primary_recordobject - Primary record.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"agentPhoneNumber": "example",
"archivedAt": "example",
"assignedUserId": "example",
"companyId": "example",
"contactDisplayName": "example",
"contactId": "example",
"contactPhoneNumber": "example",
"createdAt": "example",
"id": "example",
"lastMessageAt": "example",
"lastReadAt": "example",
"messageCount": 1,
"preview": {
"mediaCount": 1,
"text": "example"
},
"primaryRecord": {
"id": "example",
"type": "example"
},
"tabs": [],
"unreadCount": 1,
"updatedAt": "example"
},
"pagination": {
"nextCursor": "example",
"pageSize": 1
}
}
}Get activity
Get activity.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"activityAction": "example",
"activityTypeId": 1,
"content": "example",
"createdAt": "example",
"createdBy": {
"id": "example",
"name": "example"
},
"hasFiles": false,
"id": "example",
"isEditable": false,
"isPrivate": false,
"primaryRecord": {
"id": "example",
"name": "example",
"type": "example"
},
"relatedRecords": [],
"updatedAt": "example"
},
"pagination": {
"nextCursor": "example",
"pageSize": 1
}
}
}Get conversation
Get conversation.
Inputs
- Conversation ID
conversation_idtextRequired - Conversation ID.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"agentPhoneNumber": "example",
"archivedAt": "example",
"assignedUserId": "example",
"companyId": "example",
"contactDisplayName": "example",
"contactId": "example",
"contactPhoneNumber": "example",
"createdAt": "example",
"id": "example",
"lastMessageAt": "example",
"lastReadAt": "example",
"messageCount": 1,
"preview": {
"mediaCount": 1,
"text": "example"
},
"primaryRecord": {
"id": "example",
"type": "example"
},
"tabs": [],
"unreadCount": 1,
"updatedAt": "example"
},
"pagination": {
"nextCursor": "example",
"pageSize": 1
}
}
}Get conversation counts
Get conversation counts.
Inputs
None.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"tabs": {
"active": {
"unreadCount": 1
},
"archived": {
"unreadCount": 1
},
"mine": {
"unreadCount": 1
},
"others": {
"unreadCount": 1
},
"unassigned": {
"unreadCount": 1
}
}
},
"pagination": {
"nextCursor": "example",
"pageSize": 1
}
}
}Get message
Get message.
Inputs
- Conversation ID
conversation_idtextRequired - Conversation ID.
- Message ID
message_idtextRequired - Message ID.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"authorDisplayName": "example",
"authorUserId": "example",
"body": "example",
"carrierStatus": "example",
"conversationId": "example",
"createdAt": "example",
"deliveryState": "scheduled",
"direction": "inbound",
"id": "example",
"kind": "message",
"media": [],
"origin": "manual",
"scheduledFor": "example",
"sentAt": "example",
"systemEventType": "example",
"updatedAt": "example"
},
"pagination": {
"nextCursor": "example",
"pageSize": 1
}
}
}Get product
Get product.
Inputs
- Id
idtextRequired - Id.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"createdAt": "example",
"createdBy": "example",
"description": "example",
"enabled": false,
"id": "example",
"isEditable": false,
"itemType": "example",
"locationId": 1,
"name": "example",
"suppliers": [],
"taxExempt": false,
"uoms": [],
"updatedAt": "example",
"updatedBy": "example"
}
}
}List activities
List activities.
Inputs
- Page size
page_sizenumber - Page size.From 1 to 100. Default:
100. - Cursor
cursortext - Cursor.
- Sort
sorttext - Sort.
- Primary record ID
primary_record_idtext - Primary record ID.
- Primary record type
primary_record_typetext - Primary record type.
- Created by ID
created_by_idtext - Created by ID.
- Activity type ID
activity_type_idnumber - Activity type ID.
- Activity type IDs
activity_type_idslist - Activity type IDs.
- Relationship depth
relationship_depthtext - Relationship depth.One of:
self,connected.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": [],
"pagination": {
"nextCursor": "example",
"pageSize": 1
}
}
}List activity types
List activity types.
Inputs
None.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": [],
"pagination": {
"nextCursor": "example",
"pageSize": 1
}
}
}List conversations
List conversations.
Inputs
- Sort
sorttext - Sort.
- Page size
page_sizenumber - Page size.From 1 to 100. Default:
100. - Cursor
cursortext - Cursor.
- Filter
filtertext - Filter.
- Assigned user ID
assigned_user_idtext - Assigned user ID.
- Archived
archivedtrue/false - Archived.
- Contact ID
contact_idtext - Contact ID.
- Job ID
job_idtext - Job ID.
- Contact phone number
contact_phone_numbertext - Contact phone number.
- Agent phone number
agent_phone_numbertext - Agent phone number.
- Phone numbers
phone_numberslist - Phone numbers.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": [],
"pagination": {
"nextCursor": "example",
"pageSize": 1
}
}
}List messages
List messages.
Inputs
- Conversation ID
conversation_idtextRequired - Conversation ID.
- Sort
sorttext - Sort.
- Page size
page_sizenumber - Page size.From 1 to 100. Default:
100. - Cursor
cursortext - Cursor.
- Include system events
include_system_eventstrue/false - Include system events.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": [],
"pagination": {
"nextCursor": "example",
"pageSize": 1
}
}
}List products
List products.
Inputs
- Page
pagenumber - Page.From 1 to 2147483647. Default:
1. - Page size
page_sizenumber - Page size.From 1 to 100. Default:
100. - Status
statustext - Status.
- Search
searchtext - Search.
- Item type
item_typetext - Item type.One of:
material,labor,laborAndMaterial. - Supplier
suppliertext - Supplier.
- Location ID
location_idnumber - Location ID.From 0 to 2147483647.
- Sort by
sort_bytext - Sort by.One of:
name. Default:name. - Sort dir
sort_dirtext - Sort dir.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": [],
"pagination": {
"page": 1,
"pageSize": 1,
"totalItems": 1,
"totalPages": 1
}
}
}List sending phone numbers
List sending phone numbers.
Inputs
None.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"defaultPhoneNumber": "example",
"phoneNumbers": []
},
"pagination": {
"nextCursor": "example",
"pageSize": 1
}
}
}Send message
Send message.
Inputs
- Conversation ID
conversation_idtextRequired - Conversation ID.
- Idempotency key
idempotency_keytext - Idempotency key.
- Body
bodytext - Body.
- Media IDs
media_idslist - Media IDs.
- Scheduled for
scheduled_fordate and time - Scheduled for.
- Origin
origintext - Origin.
- Origin detail
origin_detailtext - Origin detail.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"authorDisplayName": "example",
"authorUserId": "example",
"body": "example",
"carrierStatus": "example",
"conversationId": "example",
"createdAt": "example",
"deliveryState": "scheduled",
"direction": "inbound",
"id": "example",
"kind": "message",
"media": [],
"origin": "manual",
"scheduledFor": "example",
"sentAt": "example",
"systemEventType": "example",
"updatedAt": "example"
},
"pagination": {
"nextCursor": "example",
"pageSize": 1
}
}
}Set conversation read state
Set conversation read state.
Inputs
- Conversation ID
conversation_idtextRequired - Conversation ID.
- Read
readtrue/false - Read.
- Last read message ID
last_read_message_idtext - Last read message ID.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"lastReadAt": "example",
"unreadCount": 1
},
"pagination": {
"nextCursor": "example",
"pageSize": 1
}
}
}Update activity
Update activity.
Inputs
- Id
idtextRequired - Id.
- Content
contenttext - content.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"activityAction": "example",
"activityTypeId": 1,
"content": "example",
"createdAt": "example",
"createdBy": {
"id": "example",
"name": "example"
},
"hasFiles": false,
"id": "example",
"isEditable": false,
"isPrivate": false,
"primaryRecord": {
"id": "example",
"name": "example",
"type": "example"
},
"relatedRecords": [],
"updatedAt": "example"
},
"pagination": {
"nextCursor": "example",
"pageSize": 1
}
}
}Update conversation
Update conversation.
Inputs
- Conversation ID
conversation_idtextRequired - Conversation ID.
- Assigneduserid
assigned_user_idtext - assignedUserId.
- Archived
archivedtrue/false - archived.
Outputs
dataobject- Response.
Example output
{
"data": {
"data": {
"agentPhoneNumber": "example",
"archivedAt": "example",
"assignedUserId": "example",
"companyId": "example",
"contactDisplayName": "example",
"contactId": "example",
"contactPhoneNumber": "example",
"createdAt": "example",
"id": "example",
"lastMessageAt": "example",
"lastReadAt": "example",
"messageCount": 1,
"preview": {
"mediaCount": 1,
"text": "example"
},
"primaryRecord": {
"id": "example",
"type": "example"
},
"tabs": [],
"unreadCount": 1,
"updatedAt": "example"
},
"pagination": {
"nextCursor": "example",
"pageSize": 1
}
}
}