SmsUpdateAgent

PUT sms/agent

Updates a manager-to-sender link. Only the fields present in the request are changed.

Disabling a link takes the manager out of that profile immediately: their next message through it is rejected instead of going out under someone else's sender name.

Access Control

Allowed role: admin, within the brand of the caller.

Request

RESTTCPSDK

PUT https://{broker_domain}/sms/agent

{
  "id": 12,
  "externalIdentifier": "ScaleTradeJ"
}

{
  "command": "SmsUpdateAgent",
  "extID": "1",
  "data": {
    "id": 12,
    "externalIdentifier": "ScaleTradeJ"
  }
}

const res = await platform.SmsUpdateAgent({
  id: 12,
  externalIdentifier: "ScaleTradeJ"
});

Request Data

Field	Type	Required	Description
id	int	Yes	Link id
managerId	int	No	CRM manager id
profileId	int	No	Provider profile, must be INDIVIDUAL
status	enum	No	ENABLED or DISABLED
externalIdentifier	string	No	Sender identity at the provider

Response Data

{
  "id": 12,
  "managerId": 10,
  "profileId": 5,
  "externalIdentifier": "ScaleTradeJ",
  "status": "ENABLED",
  "updatedAt": "2026-08-24 14:22:41"
}

Errors

Code	Error	Description
400	PROFILE_MODE_MISMATCH	The new profile does not use per-manager sender identities
404	NOT_FOUND	Link not found, or the target profile does not exist in the brand
409	AGENT_EXISTS	The manager is already linked to the target profile