GEgetconvoy
Projects

Create a project

Changed on

This endpoint creates a project. Authenticate with a personal API key or JWT and pass the organisation id as the orgID query parameter. The response includes the project and a one-time project API key.

post/v1/projects

Request

  • Base URL
    https://us.getconvoy.cloud/api
  • Auth
    HTTP bearer

Query parameters

orgIDstring required

Organisation ID

Request body

logo_urlstring
namestring

Project Name

typestring

Project Type, supported values are outgoing, incoming

Response

Created

messagestring
statusboolean

Changes

  • v39d68b6f4aeadRevision changes
    • warning

      removed the request property /////

    • warning

      removed the optional property //////////// from the response with the status

    • info

      added the new optional request property /////

    • info

      added the new optional request property /////

    • info

      added the optional property //////////// to the response with the status

    • info

      added the optional property //////////// to the response with the status

  • v3f2fca8f19473Revision changes
    • info

      added the new optional request property /////

    • info

      added the optional property //////////// to the response with the status