V2 APIAnnouncements
Update announcement
PATCH
/api/v2/announcements/{announcement}Authorization
bearerAuth AuthorizationBearer <token>
In: header
Path Parameters
announcement*string
Format
uuidQuery Parameters
account_id?string
Optional account to run this request against. Defaults to the account the API token is scoped to, so callers with a single account can omit it. Must be an account the authenticated user belongs to; staff may target any account. For write requests the value may be sent in the JSON body instead of the query string. The resolved account is returned on the X-Resi-Account-Id response header.
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/api/v2/announcements/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "property_ids": [ "03729b6d-baa6-45e3-8afa-c6e3d7ae6182" ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "internal_title": "string", "is_enabled": true, "is_global": true, "title": "string", "meta": "string", "text": "string", "disclaimer": "string", "link_primary_url": "string", "link_primary_text": "string", "link_secondary_url": "string", "link_secondary_text": "string", "starts_at": "2019-08-24T14:15:22Z", "ends_at": "2019-08-24T14:15:22Z", "sort_order": 0, "elements_key": "string", "status": "string", "images": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "url": "string", "thumb_url": "string", "full_url": "string", "caption": "string", "alt_text": "string", "tags": [ "string" ], "reference_url": "string", "reference_id": "string", "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5", "folder_id": "7695bac3-9397-4ec2-9335-45a2a16f1901" } ] }}