Create External Reference to Project

POST /public/v1/projects/{projectId}/external-references
Api key

Headers

  • X-COMPANY-ID string Required

    The company's unique ID

Path parameters

  • projectId integer(int64) Required
application/json

Body Required

  • provider string
  • externalId string
  • externalCompanyId string
  • externalBaseUrl string

Responses

  • 500 */*

    Internal Server Error
  • 200 */*

    OK

    Hide response attributes Show response attributes object
    • id integer(int64) Required

      Unique identifier of the external reference.

    • provider string Required

      Name of the external provider.

    • externalId string Required

      Identifier of the external reference in the provider's system.

    • externalCompanyId string Required

      Identifier of the external company associated with the reference.

    • externalBaseUrl string Required

      Base URL of the external reference.
POST /public/v1/projects/{projectId}/external-references 
curl \
 --request POST 'https://live.smartpmtech.com/public/v1/projects/{projectId}/external-references' \
 --header "X-API-KEY: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "X-COMPANY-ID: string" \
 --data '{"provider":"string","externalId":"string","externalCompanyId":"string","externalBaseUrl":"string"}'
Request examples 
# Headers
X-COMPANY-ID: string

# Payload
{
  "provider": "string",
  "externalId": "string",
  "externalCompanyId": "string",
  "externalBaseUrl": "string"
}
Response examples (500) 
{}
Response examples (200) 
[
  {
    "id": 123,
    "provider": "PROCORE",
    "externalId": "repo-456",
    "externalCompanyId": "comp-789",
    "externalBaseUrl": "string"
  }
]