Update Smart Link API (Beta)

📘
This API is currently available only for clients hosted in the AWS-USA data centre.

This API is used to update the details of one or multiple smart links by reference id or linkid.

📘
Based on the domain that is assigned, the endpoint domain for your API varies. For more information, refer to the Know Your API Endpoints section.

Headers

The following table describes the request headers:

Request Header	Description
content-Type	application/json
Authorization	Access token in Bearer format Example: Bearer $(key)

Body Parameters

Parameter	Type	Mandatory	Description
criteria	Object	Yes	Specifies the object with parameters based on which the URL will be updated. _ referenceId: Specifies the referenceId. _ linkid specifies the link id.
body	Object	Yes	_ urlContext: Specifies the object with personalization parameters. For example, {"msisdn": "123456789"} _ longUrl: Specifies the updated long URL

Request Example



{
  "criteria": {
"referenceId": "6391b6da5481373783e33952"
    "linkid": "Pgr2hEQs"
  },
  "body": {
    "urlContext": {
      "msisdn": "123456789"
    },
    "longUrl": "https://touchstone1.webexcampaign.io/newlink"
  }
}

Response Example

{
    "code": "1007",
    "message": "SmartLinks Details Updated Successfully."
}

Response Parameters

This API will return the following response parameters:

Parameters	Description
code	Returns the success response code.
message	Returns the confirmation message.

Failure Response Codes

The API will return a code within the response as per the following table in case of failure scenarios.

HTTP Status Code	Code within API Response	Description
400	NA	Bad request
401	NA	Invalid token or Access token expired
404	NA	No Entity exists with the given Id.
405	NA	Method not supported
500	NA	Internal server error.