Sender Profiles

Rename a sender profile

Changed on

Renames one sender (From) profile in place. Only the display name changes - the address, its sending domain, and the account-wide default From selection are left untouched, so a display name can be standardized across the several identities one mailbox may carry. To change which profile is the account default instead, use PATCH /v1/companies/{companyId} with senderProfileId. Requires companies:manage.

patch/sender-profiles/{id}

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/sender-profiles/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

Sender profile ID, from GET /v1/sender-profiles.

Request body

namestring required

New display name. Trimmed before saving.

Example request

{
  "name": "SnapCount"
}

Response

Sender profile renamed

successboolean
renamedboolean

False when the profile already carried that name, so nothing changed.

Example response

{
  "success": true
}

Changes

  • db3873ca3d4dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • ba3a29c6eb33Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status