External Links For Tenant

Returns a list of External Links for the tenant

get

Path parameters

tenantVarCodestringRequired

Tenant Var Code

Responses

200

OK

LinkIdstring · nullableOptional

Unique string that identifies the external link

Namestring · min: 1Required

Name for link

Linkstring · min: 1Required

URL for link

Orderinteger · int32Required

Item order

get/V2/{tenantVarCode}/tenantexternallinks

GET /V2/{tenantVarCode}/tenantexternallinks HTTP/1.1
Accept: */*

200

OK

[
  {
    "LinkId": "text",
    "Name": "text",
    "Link": "text",
    "Order": 1
  }
]

Creates a new Tenant External Link

post

Path parameters

tenantVarCodestringRequired

Tenant Var Code

Body

LinkIdstring · nullableOptional

Unique string that identifies the external link

Namestring · min: 1Required

Name for link

Linkstring · min: 1Required

URL for link

Orderinteger · int32Required

Item order

Responses

200

OK

No content

post/V2/{tenantVarCode}/tenantexternallinks

POST /V2/{tenantVarCode}/tenantexternallinks HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 55

{
  "LinkId": "text",
  "Name": "text",
  "Link": "text",
  "Order": 1
}

200

OK

No content

Returns a specific Tenant External Link

get

Path parameters

tenantVarCodestringRequired

Tenant Var Code

externalLinkIdstringRequired

External Link Id

Responses

200

OK

LinkIdstring · nullableOptional

Unique string that identifies the external link

Namestring · min: 1Required

Name for link

Linkstring · min: 1Required

URL for link

Orderinteger · int32Required

Item order

get/V2/{tenantVarCode}/tenantexternallinks/{externalLinkId}

GET /V2/{tenantVarCode}/tenantexternallinks/{externalLinkId} HTTP/1.1
Accept: */*

200

OK

{
  "LinkId": "text",
  "Name": "text",
  "Link": "text",
  "Order": 1
}

Deletes a specific Tenant External Link

delete

Path parameters

tenantVarCodestringRequired

Tenant Var Code

externalLinkIdstringRequired

External Link Id

Responses

200

OK

No content

delete/V2/{tenantVarCode}/tenantexternallinks/{externalLinkId}

DELETE /V2/{tenantVarCode}/tenantexternallinks/{externalLinkId} HTTP/1.1
Accept: */*

200

OK

No content