Update Sender Identity
Update the display name of a sender identity.
Endpoint
PATCH https://api.campaignlark.com/v1/sender-identities/:id
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | integer | required | The sender identity ID. |
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
display_name | string | required | The new display name. |
Sample Request
PATCH https://api.campaignlark.com/v1/sender-identities/1
Content-Type: application/json
{
"display_name": "Support Team"
}
Response
Success — 200 OK
{
"error": null,
"data": "The sender identity has been updated successfully."
}
Errors
| Status | Message | Cause |
|---|---|---|
400 | Please provide a valid sender identity ID. | id path param is missing or not a number. |
400 | Invalid request body. | Request body could not be parsed. |
400 | Various validation errors | Identity not found, display name invalid, etc. |