Campaigns API
Elements that can be shared among more than one endpoint definition.
Update a Scheduled Campaign
PATCH /v3/campaigns/{campaign_id}/schedules
Base url: https://api.sendgrid.com
This endpoint allows to you change the scheduled time and date for a campaign to be sent.
Authentication
- API Key
Headers
Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required
on-behalf-of
string
default: The subuser's username. This header generates the API call as if the subuser account was making the call.
Request Body
object
send_at
integer
format: int64
required
{
"send_at": 1489451436
}Path Parameters
campaign_id
integer
default: None
required
Responses
object
id
integer
The campaign ID
required
send_at
integer
The unix timestamp to send the campaign.
required
status
string
The status of the schedule.
required
object
errors
array[object]
message
string
the error message
field
string or null
the field that generated the error
help
object
helper text or docs for troubleshooting
id
string
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}object
errors
array[object]
message
string
the error message
field
string or null
the field that generated the error
help
object
helper text or docs for troubleshooting
id
string
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}object
errors
array[object]
message
string
the error message
field
string or null
the field that generated the error
help
object
helper text or docs for troubleshooting
id
string
{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.