v1

latestOpenAPI 3.0.12026-07-245752052.0 MB

brands

partially update one existing brand

Partially update one existing brand

patch/api/serviceorganizations/brands/{identifier}

Path parameters

identifierstring uuid required

brand unique identifier

Request body

uuidstring uuid

createdAtstring date-time

createdBystring uuid

lastUpdatedAtstring date-time

lastUpdatedBystring uuid

lastUpdatedByAudiencestring

lastUpdatedByAudienceUuidstring uuid

lastUpdatedByImpersonatedBystring uuid

lastUpdatedByCompanyUuidstring uuid

lastUpdatedByEnterpriseUuidstring uuid

namestring required

companyUuidstring uuid

logoUrlstring uri

websiteUrlstring uri

emailTemplateUuidstring uuid nullable

hireBrandIdstring uuid

originSystemstring

The system that last updated this brand (hire or wx)

originUpdatedAtstring date-time

When the brand was last updated in the origin system

Example request

{
  "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
  "createdAt": "2021-05-05T01:02:03.924Z",
  "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
  "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
  "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
  "lastUpdatedByAudience": "employer",
  "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
  "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
  "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
  "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
  "name": "Bojangles",
  "logoUrl": "file.png",
  "websiteUrl": "https://www.bojangles.com/",
  "colors": {
    "primary": "#1260fd",
    "secondary": "#1260fd"
  },
  "welcomeContent": {
    "message": "Welcome to the Bojangles team! Please take a moment to watch the video below."
  },
  "helpContent": {
    "message": "You can get in contact with a manager at manager@fountain.com"
  },
  "onboardingContent": {
    "message": "You have a few tasks remaining. Please complete them as soon as possible!"
  },
  "originSystem": "hire"
}

Response

updated brand. Wrapped in a JsonAPI root response.

Example response

{
  "data": {
    "uuid": "f4428d27-c089-40c4-aa83-ce02e1ee1426",
    "createdAt": "2021-05-05T01:02:03.924Z",
    "createdBy": "1e4e9128-fbb2-4b0a-97fc-f65bb1efee55",
    "lastUpdatedAt": "2021-05-05T04:05:06.924Z",
    "lastUpdatedBy": "7097bb82-61bd-4724-82ac-eab598190e47",
    "lastUpdatedByAudience": "employer",
    "lastUpdatedByAudienceUuid": "68df4316-590a-4081-9f24-9d9311977c9d",
    "lastUpdatedByImpersonatedBy": "3462e1d4-0e27-4798-b4a2-76412ab21892",
    "lastUpdatedByCompanyUuid": "d310aada-b1ad-4e9a-b822-b90c3cdb65bb",
    "lastUpdatedByEnterpriseUuid": "a6420cdc-285a-4f75-8ccc-8edff6d60c0a",
    "name": "Bojangles",
    "logoUrl": "file.png",
    "websiteUrl": "https://www.bojangles.com/",
    "colors": {
      "primary": "#1260fd",
      "secondary": "#1260fd"
    },
    "welcomeContent": {
      "message": "Welcome to the Bojangles team! Please take a moment to watch the video below."
    },
    "helpContent": {
      "message": "You can get in contact with a manager at manager@fountain.com"
    },
    "onboardingContent": {
      "message": "You have a few tasks remaining. Please complete them as soon as possible!"
    },
    "originSystem": "hire"
  },
  "meta": {
    "timestamp": "2021-05-05T09:47:58.924Z",
    "verb": "GET",
    "path": "/api/structure/resources/5949cf7c-fec6-4b31-947c-3aceabff58c5",
    "jti": "%cQN3RIGp",
    "rid": "$2d2zkHZ5",
    "count": 1,
    "status": "200",
    "duration": 17,
    "size": 1234
  }
}