Skip to main content
PUT
/
v2
/
teams
/
{teamId}
/
endpoint
/
{endpointName}
Register export endpoint for a team
curl --request PUT \
  --url https://rest.forestreet.com/v2/teams/{teamId}/endpoint/{endpointName} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "url": "<string>",
  "description": "<string>",
  "headers": {},
  "version": 2
}'
{
  "metadata": {
    "endpoint": {
      "name": "<string>",
      "description": "<string>",
      "url": "<string>",
      "headers": {},
      "version": 2
    }
  }
}

Authorizations

​
x-api-key
string
header
required

Pass a static API key for every request, provided by your customer support.

Path Parameters

​
teamId
number | null
required
Required range: x >= 0
​
endpointName
string
required
Maximum length: 255

Body

application/json
​
url
string
Required string length: 4 - 1024
​
description
string | null
Maximum length: 1024
​
headers
object | null
​
version
integer

Compatible version Export Via API mechanism.

Required range: x >= 1

Response

Successful registration of endpoint.

​
metadata
object
required