provider Sender Identities API PATCH /senders/{sender_id}
@utdk/sendgrid /senders/{sender_id}
Update a Sender Identity
**This endpoint allows you to update a sender identity.** Updates to `from.email` require re-verification. Partial updates are allowed, but fields that are marked as "required" in the POST (create) endpoint must not be nil if that field is included in the PATCH request.
sender_id path required
The ID of the sender identity that you want to retrieve.
integer
on-behalf-of header
string

Try it

Authentication
Configure credentials for Email Activity (beta)
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

patchV3SendersSenderId
PATCH/senders/{sender_id}
**This endpoint allows you to update a sender identity.** Updates to `from.email` require re-verification. Partial updates are allowed, but fields that are marked as "required" in the POST (create) endpoint must not be nil if that field is included in the PATCH request.

Parameters

required

The ID of the sender identity that you want to retrieve.

Input

The physical address of the sender identity.

Additional sender identity address information.

The city of the sender identity.

The country of the sender identity.

A nickname for the sender identity. Not used for sending.

The state of the sender identity.

The zipcode of the sender identity.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import sendgrid from '@utdk/sendgrid';

await sendgrid.patchV3SendersSenderId({
  "on-behalf-of": "The subuser's username. This header generates the API call as if the subuser account was making the call."
})