Workspace_color

>>>

GET /api/v4/workspaces/colors
List of workspaces colors

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

[
  {
    "id": 1,
    "color": "#ffffff"
  },
  ...
]
>>>

POST /api/v4/workspaces/colors
Create workspace color

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  "color": {
    "color": "#ffffff",
    "location": workspaceSettingsPage
  }
}

Success response body ↑

{
  "id": 1,
  "color": "#ffffff"
}

Params

Param name Description
color
required

Validations:

  • Must be a Hash
color[color]
required

Hex code of color

Validations:

  • Must be a String
color[location]
optional

Validations:

  • Must be one of: workspaceSettingsPage, signUpForm, guidedWalkthrough, progressMeter, templateBranding.
>>>

PUT /api/v4/workspaces/colors/:id
Update workspace color

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  "color": {
    "color": "#fffffa"
  }
}

Success response body ↑

{
  "id": 1,
  "color": "#fffffa"
}

Params

Param name Description
id
required

ID of color

Validations:

  • Must be a Integer
color
required

Validations:

  • Must be a Hash
color[color]
required

Hex code of color

Validations:

  • Must be a String
>>>

DELETE /api/v4/workspaces/colors/:id
Delete user color

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Success response body ↑

{
  success: true
}

Params

Param name Description
id
required

ID of color

Validations:

  • Must be a Integer
>>>

POST /api/v4/workspaces/colors/bulk_create

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

{
  "colors": [
    "#ffffff",
    ...
  ],
  "location": workspaceSettingsPage
}

Success response body ↑

{
  success: true
}

Params

Param name Description
colors
required

Validations:

  • Must be an array of String
location
optional

Validations:

  • Must be one of: workspaceSettingsPage, signUpForm, guidedWalkthrough, progressMeter, templateBranding.