public __construct(PHPFUI\ConstantContact\Client $client)
public get(?int $limit = NULL, ?bool $include_count = NULL) : array

GET Details for All Tags

Use this endpoint to get details for all tags in your account. Use the include_count query parameter to include the total number of contacts assigned each tag. Use the limit query parameter to limit the number of tag results returned per page. To get the next page of results, copy the cursor={the cursor ID} from the resulting href link and add it (&) to the URL. For example:

To learn more, see Get Tags.

  • param int $limit Use to specify the number of tag results (up to 500) to display per page of output. The default is 50.
  • param bool $include_count Returns the total number of contacts (contacts_count) to which a tag applies.
public PHPFUI\ConstantContact\Base::getLastError() : string
public PHPFUI\ConstantContact\Base::getResponseText() : string
public PHPFUI\ConstantContact\Base::getStatusCode() : int
public PHPFUI\ConstantContact\Base::next() : array

If the endpoint is paginated, you can call next() to retrieve the next set of data. If no next is provided, an empty array is returned.

  • return array filled with next part of the response from the endpoint, or empty if no next.
public post(PHPFUI\ConstantContact\Definition\TagPost $body) : array

POST (Create) a Tag

Use this method to create a new tag. The tag name is required and must be unique and can include most common keyboard symbols. Optionally, when creating a new tag you can specify the source (tag_source) used to identify the contacts to tag in the request body. Learn more.

  • param \PHPFUI\ConstantContact\Definition\TagPost $body The JSON payload to use to create a new tag.
public PHPFUI\ConstantContact\Base::success() : bool
protected PHPFUI\ConstantContact\Client PHPFUI\ConstantContact\Base::$client
protected string PHPFUI\ConstantContact\Base::$urlPath
protected PHPFUI\ConstantContact\Base::doDelete(array $parameters) : bool
protected PHPFUI\ConstantContact\Base::doGet(array $parameters) : array
protected PHPFUI\ConstantContact\Base::doPatch(array $parameters) : array
protected PHPFUI\ConstantContact\Base::doPost(array $parameters) : array
protected PHPFUI\ConstantContact\Base::doPut(array $parameters) : array
© 2024 Bruce Wells
Search Namespaces \ Classes