PHPFUI/InstaDoc
 
Copied!
CloneableInstantiable
Methods
public __construct(PHPFUI\ConstantContact\Client $client)
public delete(string $tag_id) : bool
 

DELETE a Tag

Use this method to create an activity used to un-assign a tag from all assigned contacts and delete the tag. This is an asynchronous activity. To view activity details for the delete request, use the href link returned in the response. Learn more.

  • param string $tag_id The ID that uniquely identifies a tag in UUID format.
public get(string $tag_id, ?bool $include_count = NULL) : array
 

GET Tag Details

Use this method to get tag details for a specified tag_id. Use the include_count query parameter to include or exclude the total number of contacts to which this tag is assigned. To learn more, see Get a Tag's Details.

  • param string $tag_id The ID that uniquely identifies a tag (UUID format).
  • param bool $include_count Use to include (true) or exclude (false) the total number of tagged contacts (contacts_count) from the results.
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 put(string $tag_id, PHPFUI\ConstantContact\Definition\TagPut $body) : array
 

PUT (Update) a Tag

Use this method to rename an existing tag to a new unique tag name (name). The maximum length is 255 characters. The tag_source value cannot be updated using this method. You can set the tag_source value using the POST contact_tags method. Learn more

  • param string $tag_id The system generated ID used to uniquely identify the tag that you want to rename (UUID format).
  • param \PHPFUI\ConstantContact\Definition\TagPut $body The JSON payload used to update the tag name (name).
public PHPFUI\ConstantContact\Base::success() : bool
Properties
protected PHPFUI\ConstantContact\Client PHPFUI\ConstantContact\Base::$client
protected string PHPFUI\ConstantContact\Base::$urlPath
Methods
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
Configuration