admin
engagement-internal

Create Short Link

post/admin/engagement-internal/short-links

Request

  • Base URL
    https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Headers

organization-idstring nullable
timezonestring
x-user-idstring nullable
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Request body

destination_urlstring required

The long URL to be shortened

short_codestring nullable

Optional custom short code

organization_idstring nullable

Optional organization ID

engagement_idstring nullable

Optional engagement ID

metadata_jsonobject nullable

Optional metadata

Response

Successful Response

idstring required
created_atstring date-time nullable
updated_atstring date-time nullable
deleted_atstring date-time nullable
short_codestring required
engagement_idstring nullable
metadata_jsonobject nullable
organization_idstring nullable
destination_urlstring required
short_urlstring required

Changes

No recorded changes to this operation across all 1 revision of this API.