Update Broadcast Field

PATCH

orgs

{org_id}

broadcasts

{broadcast_id}

fields

{field_id}

Update Broadcast Field

curl --request PATCH \
  --url https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/fields/{field_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "<string>",
  "default_value": "<string>"
}
'

{
  "id": "<string>",
  "broadcast_id": "<string>",
  "key": "<string>",
  "default_value": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Bearer token authentication using your API key

Path Parameters

org_id

string

required

Org ID

broadcast_id

string

required

Broadcast ID

field_id

string

required

Field ID

Body

Schema for updating a broadcast field

key

string

Required string length: 1 - 64

Pattern: ^[a-z][a-z0-9_]*$

default_value

string

Maximum string length: 2048

Response

200 - application/json

A broadcast field

string

required

broadcast_id

string

required

key

string

required

default_value

string | null

required

created_at

string<date-time>

required

Schedule a Marketing BroadcastQueue a marketing broadcast for delivery. Fires immediately when the broadcast has no scheduled_at, otherwise waits for the scheduled time. Can only be called on broadcasts in DRAFT, CANCELLED or FAILED status.

Update Broadcast Field

curl --request PATCH \
  --url https://api.useinvent.com/orgs/{org_id}/broadcasts/{broadcast_id}/fields/{field_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "<string>",
  "default_value": "<string>"
}
'

{
  "id": "<string>",
  "broadcast_id": "<string>",
  "key": "<string>",
  "default_value": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}