Register export endpoint for a team

Register a new Export Via API endpoint for a team.

PUT /v2/teams/{teamId}/endpoint/{endpointName}

Register export endpoint for a team

cURL

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
}
'

200

{
  "metadata": {
    "endpoint": {
      "name": "<string>",
      "description": "<string>",
      "url": "<string>",
      "headers": {},
      "version": 2
    }
  }
}

Authorizations

apiKeyAuthbearerAuthsessionIdQuery

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 range: x >= 0

endpointName · string · required

Maximum string length: 255

Body

application/json

url · string

Required string length: 4 - 1024

description · string | null

Maximum string length: 1024

headers · object

Show child attributes

version · integer

Compatible version Export Via API mechanism.

Required range: x >= 1

Response

200

application/json

Successful registration of endpoint.

metadata · object · required

Show child attributes