Inbox

Convert message to job

Changed on

Converts an inbox message into a new job, optionally using a job template

post/inboxmessage/{uuid}/convert-to-job.json

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/inboxmessage/{uuid}/convert-to-job.json
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.servicem8.com/oauth/authorize
      Token URL: https://api.servicem8.com/oauth/access_token scopes: publish_inbox

Path parameters

uuidstring uuid required

UUID of the inbox message

Request body

template_uuidstring uuid nullable
notestring nullable

Response

Job created successfully

successboolean
messagestring

Changes

  • 3999cf7e5b40Revision changes
    • info

      the security scope publish_inbox was added to the endpoint's security scheme oauth2

    • info

      the security scope manage_inbox was removed from the endpoint's security scheme oauth2

  • 5793f2e4c841Revision changes
    • breaking

      request body became required