Sign in

v1

latestOpenAPI 3.0.22026-07-14141623.7 KB

Update a single sender

put/settings/organizations/{organizationName}/senders/{senderName}

Path parameters

organizationNamestring required

Fetch senders with this organization name

senderNamestring required

The name of a sender to the data hub

Request body

descriptionstring required

Display ready description of the sender

format'CSV' required

the payload format

namestring required

Unique name for the senders, includes the orgninzation name

organizationNamestring

Name of the organization that this sender belongs to

schemastring required

the schema name for this sender

topicstring required

Topic of for this sender. Must match the supported topics.

Example request

{
  "meta": {
    "createdBy": "jj@phd.gov",
    "version": 11
  },
  "name": "simple_report.default",
  "organizationName": "az-phd",
  "schema": "az-phd-covid-19",
  "topic": "covid-19"
}

Response

OK

descriptionstring required

Display ready description of the sender

format'CSV' required

the payload format

namestring required

Unique name for the senders, includes the orgninzation name

organizationNamestring

Name of the organization that this sender belongs to

schemastring required

the schema name for this sender

topicstring required

Topic of for this sender. Must match the supported topics.

Example response

[
  {
    "meta": {
      "createdBy": "jj@phd.gov",
      "version": 11
    },
    "name": "simple_report.default",
    "organizationName": "az-phd",
    "schema": "az-phd-covid-19",
    "topic": "covid-19"
  }
]