AdGroups

Create a new Ad Group

Creates a new Ad Group and returns the created Ad Group object.

post/v2/adgroups

Request

Base URL
https://api.workiz.com/crm/api
Auth
none declared. Required headers: Authorization
TypeScript
https://skmtc.dev/workiz/apis/developer-api/docs/v2/adgroups/post.ts
A function with typed inputs. Its response is checked against the schema.

Authorizationstring required

Example:Bearer <token>

Bearer Token

namestring required

The name of the ad group.

displayOrdernumber required

The position of the ad group in the display list.

descriptionstring

The description of the ad group.

disabledboolean

Indicates whether the ad group is disabled or not.

{
  "name": "Group 1",
  "displayOrder": 1,
  "description": "This is an ad group."
}

The created Ad Group.

idstring

The ID of the ad group (prefix AG-).

namestring

The name of the ad group.

displayOrdernumber

The display order of the ad group.

descriptionstring

The description of the ad group.

disabledboolean

Indicates whether the ad group is disabled or not.

{
  "id": "AG-71b8d7310acbf8cc",
  "name": "Group A",
  "displayOrder": 1,
  "description": "This is a sample ad group."
}