JobNimbus

App · 20 actions

Manage activities and products; read conversations and send messages with JobNimbus Engage.

Actions

ActionWhat it does
Create activityCreate activity.
Create productCreate product.
Delete activityDelete activity.
Delete productDelete product.
Find or create conversationFind or create conversation.
Get activityGet activity.
Get conversationGet conversation.
Get conversation countsGet conversation counts.
Get messageGet message.
Get productGet product.
List activitiesList activities.
List activity typesList activity types.
List conversationsList conversations.
List messagesList messages.
List productsList products.
List sending phone numbersList sending phone numbers.
Send messageSend message.
Set conversation read stateSet conversation read state.
Update activityUpdate activity.
Update conversationUpdate conversation.

Create activity

Create activity.

Inputs

ContentcontenttextRequired
Content.
Activity typeactivity_type_idnumberRequired
Activity type ID.
Activity actionactivity_actiontextRequired
Activity action.
Primary recordprimary_recordobjectRequired
Primary record.
Related recordsrelated_recordslistRequired
Related records.
Is privateis_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

NamenametextRequired
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
Descriptiondescriptiontext
Product description. Omitted or null stores an empty description.
Item typeitem_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.
Supplierssupplierslist
Links to products in supplier catalogs. Display data, such as the supplier product's name, comes from the Suppliers API by `id`.
Tax exempttax_exempttrue/false
Whether the product is tax exempt. Omitted on create stores false; omitted on update keeps the stored value.
Location IDlocation_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.
Enabledenabledtrue/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 measureunit_nametext
Defaults to EA.Default: EA.
Material price in centsmaterial_price_centsnumber
Amount in USD cents. Defaults to zero.At least 0. Default: 0.
Material cost in centsmaterial_cost_centsnumber
Amount in USD cents. Defaults to zero.At least 0. Default: 0.
Labor price in centslabor_price_centsnumber
Amount in USD cents. Defaults to zero.At least 0. Default: 0.
Labor cost in centslabor_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

IdidtextRequired
Id.

Outputs

dataobject
Returned value.
Example output
{
  "data": {}
}

Delete product

Delete product.

Inputs

IdidtextRequired
Id.

Outputs

dataobject
Returned value.
Example output
{
  "data": {}
}

Find or create conversation

Find or create conversation.

Inputs

Contact phone numbercontact_phone_numbertextRequired
Contact phone number.
Agent phone numberagent_phone_numbertextRequired
Agent phone number.
Primary recordprimary_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

IdidtextRequired
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 IDconversation_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 IDconversation_idtextRequired
Conversation ID.
Message IDmessage_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

IdidtextRequired
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 sizepage_sizenumber
Page size.From 1 to 100. Default: 100.
Cursorcursortext
Cursor.
Sortsorttext
Sort.
Primary record IDprimary_record_idtext
Primary record ID.
Primary record typeprimary_record_typetext
Primary record type.
Created by IDcreated_by_idtext
Created by ID.
Activity type IDactivity_type_idnumber
Activity type ID.
Activity type IDsactivity_type_idslist
Activity type IDs.
Relationship depthrelationship_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

Sortsorttext
Sort.
Page sizepage_sizenumber
Page size.From 1 to 100. Default: 100.
Cursorcursortext
Cursor.
Filterfiltertext
Filter.
Assigned user IDassigned_user_idtext
Assigned user ID.
Archivedarchivedtrue/false
Archived.
Contact IDcontact_idtext
Contact ID.
Job IDjob_idtext
Job ID.
Contact phone numbercontact_phone_numbertext
Contact phone number.
Agent phone numberagent_phone_numbertext
Agent phone number.
Phone numbersphone_numberslist
Phone numbers.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "pagination": {
      "nextCursor": "example",
      "pageSize": 1
    }
  }
}

List messages

List messages.

Inputs

Conversation IDconversation_idtextRequired
Conversation ID.
Sortsorttext
Sort.
Page sizepage_sizenumber
Page size.From 1 to 100. Default: 100.
Cursorcursortext
Cursor.
Include system eventsinclude_system_eventstrue/false
Include system events.

Outputs

dataobject
Response.
Example output
{
  "data": {
    "data": [],
    "pagination": {
      "nextCursor": "example",
      "pageSize": 1
    }
  }
}

List products

List products.

Inputs

Pagepagenumber
Page.From 1 to 2147483647. Default: 1.
Page sizepage_sizenumber
Page size.From 1 to 100. Default: 100.
Statusstatustext
Status.
Searchsearchtext
Search.
Item typeitem_typetext
Item type.One of: material, labor, laborAndMaterial.
Suppliersuppliertext
Supplier.
Location IDlocation_idnumber
Location ID.From 0 to 2147483647.
Sort bysort_bytext
Sort by.One of: name. Default: name.
Sort dirsort_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 IDconversation_idtextRequired
Conversation ID.
Idempotency keyidempotency_keytext
Idempotency key.
Bodybodytext
Body.
Media IDsmedia_idslist
Media IDs.
Scheduled forscheduled_fordate and time
Scheduled for.
Originorigintext
Origin.
Origin detailorigin_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 IDconversation_idtextRequired
Conversation ID.
Readreadtrue/false
Read.
Last read message IDlast_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

IdidtextRequired
Id.
Contentcontenttext
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 IDconversation_idtextRequired
Conversation ID.
Assigneduseridassigned_user_idtext
assignedUserId.
Archivedarchivedtrue/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
    }
  }
}

On this page